Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/SpinnerBindingListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/SpinnerBindingListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/SpinnerBindingListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/SpinnerBindingListener.java Mon Mar 14 20:52:43 2016 @@ -61,24 +61,24 @@ public interface SpinnerBindingListener /** * Called when a spinner's spinner data key has changed. * - * @param spinner - * @param previousSpinnerDataKey + * @param spinner The spinner whose data is changing. + * @param previousSpinnerDataKey The previous key for the spinner's data. */ public void spinnerDataKeyChanged(Spinner spinner, String previousSpinnerDataKey); /** * Called when a spinner's spinner data bind type has changed. * - * @param spinner - * @param previousSpinnerDataBindType + * @param spinner The spinner whose data is changing. + * @param previousSpinnerDataBindType What the data bind type used to be. */ public void spinnerDataBindTypeChanged(Spinner spinner, BindType previousSpinnerDataBindType); /** * Called when a spinner's spinner data bind mapping has changed. * - * @param spinner - * @param previousSpinnerDataBindMapping + * @param spinner The spinner whose data is changing. + * @param previousSpinnerDataBindMapping What the data bind mapping used to be. */ public void spinnerDataBindMappingChanged(Spinner spinner, Spinner.SpinnerDataBindMapping previousSpinnerDataBindMapping); @@ -86,24 +86,24 @@ public interface SpinnerBindingListener /** * Called when a spinner's selected item key has changed. * - * @param spinner - * @param previousSelectedItemKey + * @param spinner The spinner that is the source of this event. + * @param previousSelectedItemKey What the selected item key used to be. */ public void selectedItemKeyChanged(Spinner spinner, String previousSelectedItemKey); /** * Called when a spinner's selected item bind type has changed. * - * @param spinner - * @param previousSelectedItemBindType + * @param spinner The spinner whose selected binding has changed. + * @param previousSelectedItemBindType The previous selected item bind type. */ public void selectedItemBindTypeChanged(Spinner spinner, BindType previousSelectedItemBindType); /** * Called when a spinner's selected item bind mapping has changed. * - * @param spinner - * @param previousSelectedItemBindMapping + * @param spinner The spinner whose bind mapping has changed. + * @param previousSelectedItemBindMapping What the selected item bind mapping used to be. */ public void selectedItemBindMappingChanged(Spinner spinner, Spinner.ItemBindMapping previousSelectedItemBindMapping);
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/SpinnerItemListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/SpinnerItemListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/SpinnerItemListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/SpinnerItemListener.java Mon Mar 14 20:52:43 2016 @@ -53,39 +53,39 @@ public interface SpinnerItemListener { /** * Called when an item is inserted into a spinner's data. * - * @param spinner - * @param index + * @param spinner The source of the event. + * @param index Where the item was inserted. */ public void itemInserted(Spinner spinner, int index); /** * Called when items are removed from a spinner's data. * - * @param spinner - * @param index - * @param count + * @param spinner The source of this event. + * @param index The start of the items that were removed. + * @param count The number of items removed from there. */ public void itemsRemoved(Spinner spinner, int index, int count); /** * Called when an item is updated within a spinner's data. * - * @param spinner - * @param index + * @param spinner The source of this event. + * @param index The location of the item that was updated. */ public void itemUpdated(Spinner spinner, int index); /** * Called when a spinner's data has been cleared. * - * @param spinner + * @param spinner The source of this event. */ public void itemsCleared(Spinner spinner); /** * Called when a spinner's data is sorted. * - * @param spinner + * @param spinner The source of this event. */ public void itemsSorted(Spinner spinner); } Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/SpinnerListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/SpinnerListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/SpinnerListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/SpinnerListener.java Mon Mar 14 20:52:43 2016 @@ -45,23 +45,23 @@ public interface SpinnerListener { /** * Called when a spinner's data has changed. * - * @param spinner - * @param previousSpinnerData + * @param spinner The source of this event. + * @param previousSpinnerData What the spinner data used to be. */ public void spinnerDataChanged(Spinner spinner, List<?> previousSpinnerData); /** * Called when a spinner's item renderer has changed. * - * @param spinner - * @param previousItemRenderer + * @param spinner The source of this event. + * @param previousItemRenderer What the item renderer used to be. */ public void itemRendererChanged(Spinner spinner, Spinner.ItemRenderer previousItemRenderer); /** * Called when a spinner's circular property has changed. * - * @param spinner + * @param spinner The source of this event. */ public void circularChanged(Spinner spinner); } Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/SuggestionPopup.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/SuggestionPopup.java?rev=1734997&r1=1734996&r2=1734997&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/SuggestionPopup.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/SuggestionPopup.java Mon Mar 14 20:52:43 2016 @@ -254,14 +254,14 @@ public class SuggestionPopup extends Win } /** - * Returns the text input for which suggestions will be provided. + * @return The text input for which suggestions will be provided. */ public TextInput getTextInput() { return textInput; } /** - * Returns the list of suggestions presented by the popup. + * @return The list of suggestions presented by the popup. */ public List<?> getSuggestionData() { return suggestionData; @@ -270,7 +270,7 @@ public class SuggestionPopup extends Win /** * Sets the list of suggestions presented by the popup. * - * @param suggestionData + * @param suggestionData The new list of suggestions to present. */ @SuppressWarnings("unchecked") public void setSuggestionData(List<?> suggestionData) { @@ -305,7 +305,7 @@ public class SuggestionPopup extends Win } /** - * Returns the list view item renderer used to present suggestions. + * @return The list view item renderer used to present suggestions. */ public ListView.ItemRenderer getSuggestionRenderer() { return suggestionRenderer; @@ -314,7 +314,7 @@ public class SuggestionPopup extends Win /** * Sets the list view item renderer used to present suggestions. * - * @param suggestionRenderer + * @param suggestionRenderer The new item renderer. */ public void setSuggestionRenderer(ListView.ItemRenderer suggestionRenderer) { ListView.ItemRenderer previousSuggestionRenderer = this.suggestionRenderer; @@ -365,6 +365,12 @@ public class SuggestionPopup extends Win return item; } + /** + * Set the selected suggestion. + * + * @param suggestion The new item to select (can be {@code null} to + * make nothing selected). + */ @SuppressWarnings("unchecked") public void setSelectedSuggestion(Object suggestion) { setSelectedIndex((suggestion == null) ? -1 @@ -372,7 +378,7 @@ public class SuggestionPopup extends Win } /** - * Returns the list size. + * @return The list size. */ public int getListSize() { return listSize; @@ -382,7 +388,7 @@ public class SuggestionPopup extends Win * Sets the list size. If the number of items in the list exceeds this * value, the list will scroll. * - * @param listSize + * @param listSize The new number of items that are visible. */ public void setListSize(int listSize) { if (listSize < -1) { Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/SuggestionPopupCloseListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/SuggestionPopupCloseListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/SuggestionPopupCloseListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/SuggestionPopupCloseListener.java Mon Mar 14 20:52:43 2016 @@ -23,7 +23,7 @@ public interface SuggestionPopupCloseLis /** * Called when a suggestion popup has closed. * - * @param suggestionPopup + * @param suggestionPopup The suggestion popup that has closed. */ public void suggestionPopupClosed(SuggestionPopup suggestionPopup); } Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/SuggestionPopupItemListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/SuggestionPopupItemListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/SuggestionPopupItemListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/SuggestionPopupItemListener.java Mon Mar 14 20:52:43 2016 @@ -51,41 +51,41 @@ public interface SuggestionPopupItemList } /** - * Called when an item is inserted into a list button's list data. + * Called when an item is inserted into the suggestion popup's data list. * - * @param suggestionPopup - * @param index + * @param suggestionPopup The source of this event. + * @param index The location where the item was inserted. */ public void itemInserted(SuggestionPopup suggestionPopup, int index); /** - * Called when items are removed from a list button's list data. + * Called when items are removed from the suggestion popup's data list. * - * @param suggestionPopup - * @param index - * @param count + * @param suggestionPopup The source of this event. + * @param index The starting index where items were removed. + * @param count The number of items that were removed. */ public void itemsRemoved(SuggestionPopup suggestionPopup, int index, int count); /** - * Called when an item is updated within a list button's list data. + * Called when an item is updated within a suggestion popup's data list. * - * @param suggestionPopup - * @param index + * @param suggestionPopup The source of this event. + * @param index Which item was updated. */ public void itemUpdated(SuggestionPopup suggestionPopup, int index); /** * Called when a list button's list data has been cleared. * - * @param suggestionPopup + * @param suggestionPopup The source of this event. */ public void itemsCleared(SuggestionPopup suggestionPopup); /** * Called when a list button's list data is sorted. * - * @param suggestionPopup + * @param suggestionPopup The source of this event. */ public void itemsSorted(SuggestionPopup suggestionPopup); } Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/SuggestionPopupListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/SuggestionPopupListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/SuggestionPopupListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/SuggestionPopupListener.java Mon Mar 14 20:52:43 2016 @@ -47,8 +47,8 @@ public interface SuggestionPopupListener /** * Called when a suggestion popup's suggestions have changed. * - * @param suggestionPopup - * @param previousSuggestionData + * @param suggestionPopup The source of this event. + * @param previousSuggestionData The previous data that was being shown. */ public void suggestionDataChanged(SuggestionPopup suggestionPopup, List<?> previousSuggestionData); @@ -56,8 +56,8 @@ public interface SuggestionPopupListener /** * Called when a suggestion popup's item renderer has changed. * - * @param suggestionPopup - * @param previousSuggestionRenderer + * @param suggestionPopup The source of this event. + * @param previousSuggestionRenderer The previous item renderer. */ public void suggestionRendererChanged(SuggestionPopup suggestionPopup, ListView.ItemRenderer previousSuggestionRenderer); @@ -65,8 +65,8 @@ public interface SuggestionPopupListener /** * Called when a suggestion popup's list size has changed. * - * @param suggestionPopup - * @param previousListSize + * @param suggestionPopup The source of this event. + * @param previousListSize The previous value of the visible window. */ public void listSizeChanged(SuggestionPopup suggestionPopup, int previousListSize); } Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/SuggestionPopupSelectionListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/SuggestionPopupSelectionListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/SuggestionPopupSelectionListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/SuggestionPopupSelectionListener.java Mon Mar 14 20:52:43 2016 @@ -39,8 +39,8 @@ public interface SuggestionPopupSelectio /** * Called when a suggestion popup's selected index has changed. * - * @param suggestionPopup - * @param previousSelectedIndex + * @param suggestionPopup The source of this event. + * @param previousSelectedIndex What the selected index used to be. */ public void selectedIndexChanged(SuggestionPopup suggestionPopup, int previousSelectedIndex); Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/SuggestionPopupStateListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/SuggestionPopupStateListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/SuggestionPopupStateListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/SuggestionPopupStateListener.java Mon Mar 14 20:52:43 2016 @@ -45,16 +45,17 @@ public interface SuggestionPopupStateLis /** * Called to preview a suggestion popup close event. * - * @param suggestionPopup - * @param result + * @param suggestionPopup The source of this event. + * @param result What the result would be. + * @return What this listener thinks about closing the popup with this result. */ public Vote previewSuggestionPopupClose(SuggestionPopup suggestionPopup, boolean result); /** * Called when a suggestion popup close event has been vetoed. * - * @param suggestionPopup - * @param reason + * @param suggestionPopup The source of this event. + * @param reason The accumulated vote that forced the veto. */ public void suggestionPopupCloseVetoed(SuggestionPopup suggestionPopup, Vote reason); } Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TabPaneAttributeListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TabPaneAttributeListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/TabPaneAttributeListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TabPaneAttributeListener.java Mon Mar 14 20:52:43 2016 @@ -39,9 +39,9 @@ public interface TabPaneAttributeListene /** * Called when a tab's tab data attribute has changed. * - * @param tabPane - * @param component - * @param previousTabData + * @param tabPane The source of this event. + * @param component The component whose tab pane data has changed. + * @param previousTabData What the tab data attribute used to be. */ public void tabDataChanged(TabPane tabPane, Component component, Object previousTabData); Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TablePane.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TablePane.java?rev=1734997&r1=1734996&r2=1734997&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/TablePane.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TablePane.java Mon Mar 14 20:52:43 2016 @@ -816,7 +816,7 @@ public class TablePane extends Container } /** - * Returns the bounds of a given row. + * @return The bounds of a given row. * * @param row The row index. */ @@ -826,8 +826,6 @@ public class TablePane extends Container } /** - * Returns the table pane column sequence. - * * @return The table pane column sequence */ public ColumnSequence getColumns() { @@ -847,7 +845,7 @@ public class TablePane extends Container } /** - * Returns the bounds of a given column. + * @return The bounds of a given column. * * @param column The column index. */ @@ -901,14 +899,14 @@ public class TablePane extends Container } /** - * Returns the table pane listener list. + * @return The table pane listener list. */ public ListenerList<TablePaneListener> getTablePaneListeners() { return tablePaneListeners; } /** - * Returns the table pane attribute listener list. + * @return The table pane attribute listener list. */ public ListenerList<TablePaneAttributeListener> getTablePaneAttributeListeners() { return tablePaneAttributeListeners; Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TablePaneAttributeListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TablePaneAttributeListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/TablePaneAttributeListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TablePaneAttributeListener.java Mon Mar 14 20:52:43 2016 @@ -39,18 +39,18 @@ public interface TablePaneAttributeListe /** * Called when a component's row span attribute has changed. * - * @param tablePane - * @param component - * @param previousRowSpan + * @param tablePane The source of this event. + * @param component The component that changed. + * @param previousRowSpan What the row span value used to be. */ public void rowSpanChanged(TablePane tablePane, Component component, int previousRowSpan); /** * Called when a component's column span attribute has changed. * - * @param tablePane - * @param component - * @param previousColumnSpan + * @param tablePane The source of this event. + * @param component THe component that changed. + * @param previousColumnSpan What the column span for this component used to be. */ public void columnSpanChanged(TablePane tablePane, Component component, int previousColumnSpan); } Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TablePaneListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TablePaneListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/TablePaneListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TablePaneListener.java Mon Mar 14 20:52:43 2016 @@ -87,59 +87,59 @@ public interface TablePaneListener { /** * Called when a row has been inserted into a table pane. * - * @param tablePane - * @param index + * @param tablePane The source of this event. + * @param index The index of the inserted row. */ public void rowInserted(TablePane tablePane, int index); /** * Called when rows have been removed from a table pane. * - * @param tablePane - * @param index - * @param rows + * @param tablePane The source of this event. + * @param index The starting index of the rows that were removed. + * @param rows The actual sequence of rows that were removed. */ public void rowsRemoved(TablePane tablePane, int index, Sequence<TablePane.Row> rows); /** * Called when a row's height has changed. * - * @param row - * @param previousHeight - * @param previousRelative + * @param row The particular row whose height has changed. + * @param previousHeight The previous numeric height value. + * @param previousRelative Whether the previous row height was relative or not. */ public void rowHeightChanged(TablePane.Row row, int previousHeight, boolean previousRelative); /** * Called when a row's highlighted state has changed. * - * @param row + * @param row The source of this event. */ public void rowHighlightedChanged(TablePane.Row row); /** * Called when a column has been inserted into a table pane. * - * @param tablePane - * @param index + * @param tablePane The table pane that changed. + * @param index The location where the column was inserted. */ public void columnInserted(TablePane tablePane, int index); /** - * Called when column's have been removed from a table pane. + * Called when columns have been removed from a table pane. * - * @param tablePane - * @param index - * @param columns + * @param tablePane The table pane that changed. + * @param index The starting index of the removed columns. + * @param columns The actual sequence of the columns that were removed. */ public void columnsRemoved(TablePane tablePane, int index, Sequence<TablePane.Column> columns); /** * Called when a column's width has changed. * - * @param column - * @param previousWidth - * @param previousRelative + * @param column The column that changed. + * @param previousWidth The previous numeric value of the width. + * @param previousRelative Whether the previous width was relative or not. */ public void columnWidthChanged(TablePane.Column column, int previousWidth, boolean previousRelative); @@ -147,33 +147,33 @@ public interface TablePaneListener { /** * Called when a column's highlighted state has changed. * - * @param column + * @param column The column that changed. */ public void columnHighlightedChanged(TablePane.Column column); /** * Called when a cell has been inserted into a table pane. * - * @param row - * @param column + * @param row The table pane row that has changed. + * @param column The index of the new column. */ public void cellInserted(TablePane.Row row, int column); /** - * Called when cell's have been removed from a table pane. + * Called when cells have been removed from a table pane. * - * @param row - * @param column - * @param removed + * @param row The table pane row that has changed. + * @param column The starting index of the column(s) that were removed. + * @param removed The actual sequence of removed columns. */ public void cellsRemoved(TablePane.Row row, int column, Sequence<Component> removed); /** * Called when a cell has been updated in a table pane. * - * @param row - * @param column - * @param previousComponent + * @param row The table pane row that was changed. + * @param column Index of the column that was updated. + * @param previousComponent The previous cell contents. */ public void cellUpdated(TablePane.Row row, int column, Component previousComponent); } Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TableView.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TableView.java?rev=1734997&r1=1734996&r2=1734997&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/TableView.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TableView.java Mon Mar 14 20:52:43 2016 @@ -212,7 +212,7 @@ public class TableView extends Component } /** - * Returns the column header data renderer. + * @return The column header data renderer. */ public HeaderDataRenderer getHeaderDataRenderer() { return headerDataRenderer; @@ -221,7 +221,7 @@ public class TableView extends Component /** * Sets the column header data renderer. * - * @param headerDataRenderer + * @param headerDataRenderer The new renderer for the header data. */ public void setHeaderDataRenderer(HeaderDataRenderer headerDataRenderer) { if (headerDataRenderer == null) { @@ -313,7 +313,7 @@ public class TableView extends Component } /** - * Gets the minimum and maximum widths to which the column can size. + * @return The minimum and maximum widths to which the column can size. */ public Limits getWidthLimits() { return new Limits(minimumWidth, maximumWidth); @@ -500,8 +500,8 @@ public class TableView extends Component /** * Converts table view cell data to a string representation. * - * @param row - * @param columnName + * @param row The row object. + * @param columnName The name of the column. * @return The cell data's string representation, or <tt>null</tt> if the * data does not have a string representation. <p> Note that this method * may be called often during keyboard navigation, so implementations @@ -532,7 +532,7 @@ public class TableView extends Component /** * Converts table view header data to a string representation. * - * @param item + * @param item The header data item. * @return The data's string representation, or <tt>null</tt> if the data * does not have a string representation. <p> Note that this method may * be called often during keyboard navigation, so implementations should @@ -548,9 +548,9 @@ public class TableView extends Component /** * Called to begin editing a table row. * - * @param tableView - * @param rowIndex - * @param columnIndex + * @param tableView The table view being edited. + * @param rowIndex Index of the row to edit. + * @param columnIndex Index of the column to edit. */ public void beginEdit(TableView tableView, int rowIndex, int columnIndex); @@ -563,7 +563,7 @@ public class TableView extends Component public void endEdit(boolean result); /** - * Tests whether an edit is currently in progress. + * @return Whether an edit is currently in progress. */ public boolean isEditing(); } @@ -590,14 +590,17 @@ public class TableView extends Component /** * Converts a context value to table data. * - * @param value + * @param value The value retrieved from the user object. + * @return The object converted to list data for the table. */ public List<?> toTableData(Object value); /** * Converts table data to a context value. * - * @param tableData + * @param tableData The current table list data. + * @return The list converted to a form suitable for storage + * in the user object. */ public Object valueOf(List<?> tableData); } @@ -621,6 +624,7 @@ public class TableView extends Component * * @param tableData The source table data. * @param index The index of the value to retrieve. + * @return The object value at that index. */ public Object get(List<?> tableData, int index); } @@ -1190,7 +1194,7 @@ public class TableView extends Component /** * Creates a new table view populated with the given table data. * - * @param tableData + * @param tableData The initial data for this table view. */ public TableView(List<?> tableData) { setTableData(tableData); @@ -1376,8 +1380,8 @@ public class TableView extends Component /** * Sets the selection to a single range. * - * @param start - * @param end + * @param start The start of the selection range. + * @param end The end of the range. */ public void setSelectedRange(int start, int end) { ArrayList<Span> selectedRanges = new ArrayList<>(); @@ -1403,7 +1407,7 @@ public class TableView extends Component * connecting ranges will be consolidated, and the resulting selection will * be sorted in ascending order. * - * @param selectedRanges + * @param selectedRanges The new sequence of selected ranges. * @return The ranges that were actually set. */ public Sequence<Span> setSelectedRanges(Sequence<Span> selectedRanges) { @@ -1714,7 +1718,7 @@ public class TableView extends Component } /** - * Returns the current selection mode. + * @return The current selection mode. */ public SelectMode getSelectMode() { return selectMode; @@ -1745,7 +1749,7 @@ public class TableView extends Component } /** - * Returns the table view's sort dictionary. + * @return The table view's sort dictionary. */ public SortDictionary getSort() { return sortDictionary; @@ -1754,8 +1758,9 @@ public class TableView extends Component /** * Sets the table view's sort. * - * @param columnName - * @param sortDirection + * @param columnName The column name to sort on. + * @param sortDirection Whether ascending or descending sort on that column. + * @return The new sort criteria. */ @SuppressWarnings("unchecked") public Dictionary<String, SortDirection> setSort(String columnName, SortDirection sortDirection) { @@ -1772,6 +1777,8 @@ public class TableView extends Component * * @param sort A sequence of key/value pairs representing the sort. Keys * represent column names and values represent sort direction. + * @return The new sort criteria. + * @throws IllegalArgumentException if the sort parameter is {@code null}. */ public Dictionary<String, SortDirection> setSort( Sequence<Dictionary.Pair<String, SortDirection>> sort) { @@ -1800,7 +1807,10 @@ public class TableView extends Component * Sets the table view's sort. * * @param sort A JSON list containing JSON objects representing the sort. + * @return The new sort criteria. * @see #setSort(Sequence) + * @throws IllegalArgumentException if the sort parameter is {@code null} + * or can't be parsed from the JSON input. */ public final Dictionary<String, SortDirection> setSort(String sort) { if (sort == null) { Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TableViewBindingListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TableViewBindingListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/TableViewBindingListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TableViewBindingListener.java Mon Mar 14 20:52:43 2016 @@ -78,24 +78,24 @@ public interface TableViewBindingListene /** * Called when a table view's table data key has changed. * - * @param tableView - * @param previousTableDataKey + * @param tableView The source of this event. + * @param previousTableDataKey The previous key for the table data. */ public void tableDataKeyChanged(TableView tableView, String previousTableDataKey); /** * Called when a table view's table data bind type has changed. * - * @param tableView - * @param previousTableDataBindType + * @param tableView The source of this event. + * @param previousTableDataBindType The previous bind type for the table data. */ public void tableDataBindTypeChanged(TableView tableView, BindType previousTableDataBindType); /** * Called when a table view's table data bind mapping has changed. * - * @param tableView - * @param previousTableDataBindMapping + * @param tableView The source of this event. + * @param previousTableDataBindMapping The previous bind mapping for the table data. */ public void tableDataBindMappingChanged(TableView tableView, TableView.TableDataBindMapping previousTableDataBindMapping); @@ -103,24 +103,24 @@ public interface TableViewBindingListene /** * Called when a table view's selected row key has changed. * - * @param tableView - * @param previousSelectedRowKey + * @param tableView The source of this event. + * @param previousSelectedRowKey The previous key for the selected row. */ public void selectedRowKeyChanged(TableView tableView, String previousSelectedRowKey); /** * Called when a table view's selected row bind type has changed. * - * @param tableView - * @param previousSelectedRowBindType + * @param tableView The source of this event. + * @param previousSelectedRowBindType The previous bind type for the selected row. */ public void selectedRowBindTypeChanged(TableView tableView, BindType previousSelectedRowBindType); /** * Called when a table view's selected row bind mapping has changed. * - * @param tableView - * @param previousSelectedRowBindMapping + * @param tableView The source of the event. + * @param previousSelectedRowBindMapping The previous bind mapping for the selected row. */ public void selectedRowBindMappingChanged(TableView tableView, TableView.SelectedRowBindMapping previousSelectedRowBindMapping); @@ -128,16 +128,16 @@ public interface TableViewBindingListene /** * Called when a table view's selected rows key has changed. * - * @param tableView - * @param previousSelectedRowsKey + * @param tableView The source of this event. + * @param previousSelectedRowsKey The previous key for obtaining the selected rows value. */ public void selectedRowsKeyChanged(TableView tableView, String previousSelectedRowsKey); /** * Called when a table view's selected rows bind type has changed. * - * @param tableView - * @param previousSelectedRowsBindType + * @param tableView The source of this event. + * @param previousSelectedRowsBindType The previous bind type for the selected rows. */ public void selectedRowsBindTypeChanged(TableView tableView, BindType previousSelectedRowsBindType); @@ -145,8 +145,8 @@ public interface TableViewBindingListene /** * Called when a table view's selected rows bind mapping has changed. * - * @param tableView - * @param previousSelectedRowsBindMapping + * @param tableView The source of this event. + * @param previousSelectedRowsBindMapping The previous value of the bind mapping for the selected rows. */ public void selectedRowsBindMappingChanged(TableView tableView, TableView.SelectedRowBindMapping previousSelectedRowsBindMapping); Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TableViewColumnListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TableViewColumnListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/TableViewColumnListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TableViewColumnListener.java Mon Mar 14 20:52:43 2016 @@ -80,41 +80,41 @@ public interface TableViewColumnListener /** * Called when a column is inserted into a table view's column sequence. * - * @param tableView - * @param index + * @param tableView The table view that has changed. + * @param index Where the new column has been inserted. */ public void columnInserted(TableView tableView, int index); /** * Called when columns are removed from a table view's column sequence. * - * @param tableView - * @param index - * @param columns + * @param tableView The table view that has changed. + * @param index The starting location of the removed columns. + * @param columns The actual sequence of columns that were removed. */ public void columnsRemoved(TableView tableView, int index, Sequence<TableView.Column> columns); /** * Called when a column's name has changed. * - * @param column - * @param previousName + * @param column The column that changed names. + * @param previousName What the previous name was. */ public void columnNameChanged(TableView.Column column, String previousName); /** * Called when a column's header data has changed. * - * @param column - * @param previousHeaderData + * @param column The column that changed. + * @param previousHeaderData What the header data used to be. */ public void columnHeaderDataChanged(TableView.Column column, Object previousHeaderData); /** * Called when a column's header data renderer has changed. * - * @param column - * @param previousHeaderDataRenderer + * @param column The column whose header data renderer has changed. + * @param previousHeaderDataRenderer The previous renderer for header data. */ public void columnHeaderDataRendererChanged(TableView.Column column, TableView.HeaderDataRenderer previousHeaderDataRenderer); @@ -122,9 +122,9 @@ public interface TableViewColumnListener /** * Called when a column's width has changed. * - * @param column - * @param previousWidth - * @param previousRelative + * @param column The column that changed. + * @param previousWidth The previous numeric value of the column width. + * @param previousRelative Whether the previous width was relative or not. */ public void columnWidthChanged(TableView.Column column, int previousWidth, boolean previousRelative); @@ -132,9 +132,9 @@ public interface TableViewColumnListener /** * Called when a column's width limits have changed. * - * @param column - * @param previousMinimumWidth - * @param previousMaximumWidth + * @param column The source of this event. + * @param previousMinimumWidth The previous minimum column width. + * @param previousMaximumWidth The previous maximum column width. */ public void columnWidthLimitsChanged(TableView.Column column, int previousMinimumWidth, int previousMaximumWidth); @@ -142,16 +142,16 @@ public interface TableViewColumnListener /** * Called when a column's filter has changed. * - * @param column - * @param previousFilter + * @param column The source of this event. + * @param previousFilter The previous filter value for this column. */ public void columnFilterChanged(TableView.Column column, Object previousFilter); /** * Called when a column's cell renderer has changed. * - * @param column - * @param previousCellRenderer + * @param column The source of this event. + * @param previousCellRenderer The previous cell renderer for this column. */ public void columnCellRendererChanged(TableView.Column column, TableView.CellRenderer previousCellRenderer); Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TableViewHeaderListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TableViewHeaderListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/TableViewHeaderListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TableViewHeaderListener.java Mon Mar 14 20:52:43 2016 @@ -40,16 +40,16 @@ public interface TableViewHeaderListener /** * Called when a table view header's table view has changed. * - * @param tableViewHeader - * @param previousTableView + * @param tableViewHeader The source of this event. + * @param previousTableView The table view that used to be associated with this header. */ public void tableViewChanged(TableViewHeader tableViewHeader, TableView previousTableView); /** * Called when a table view header's sort mode has changed. * - * @param tableViewHeader - * @param previousSortMode + * @param tableViewHeader The source of this event. + * @param previousSortMode The previous sort mode for this header. */ public void sortModeChanged(TableViewHeader tableViewHeader, SortMode previousSortMode); } Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TableViewHeaderPressListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TableViewHeaderPressListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/TableViewHeaderPressListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TableViewHeaderPressListener.java Mon Mar 14 20:52:43 2016 @@ -23,8 +23,8 @@ public interface TableViewHeaderPressLis /** * Called when a table view header has been pressed. * - * @param tableViewHeader - * @param index + * @param tableViewHeader The source of this event. + * @param index The location in this header that was pressed. */ public void headerPressed(TableViewHeader tableViewHeader, int index); } Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TableViewListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TableViewListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/TableViewListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TableViewListener.java Mon Mar 14 20:52:43 2016 @@ -57,40 +57,40 @@ public interface TableViewListener { /** * Called when a table view's table data has changed. * - * @param tableView - * @param previousTableData + * @param tableView The source of this event. + * @param previousTableData The previous data list for this table view. */ public void tableDataChanged(TableView tableView, List<?> previousTableData); /** * Called when a table view's column source has changed. * - * @param tableView - * @param previousColumnSource + * @param tableView The source of this event. + * @param previousColumnSource The previous column source for this table. */ public void columnSourceChanged(TableView tableView, TableView previousColumnSource); /** * Called when a table view's row editor has changed. * - * @param tableView - * @param previousRowEditor + * @param tableView The source of this event. + * @param previousRowEditor The row editor that was previously used. */ public void rowEditorChanged(TableView tableView, TableView.RowEditor previousRowEditor); /** * Called when a table view's select mode has changed. * - * @param tableView - * @param previousSelectMode + * @param tableView The source of the event. + * @param previousSelectMode What the select mode used to be. */ public void selectModeChanged(TableView tableView, TableView.SelectMode previousSelectMode); /** * Called when a table view's disabled row filter has changed. * - * @param tableView - * @param previousDisabledRowFilter + * @param tableView The table view in question. + * @param previousDisabledRowFilter What the previous filter for disabled rows was. */ public void disabledRowFilterChanged(TableView tableView, Filter<?> previousDisabledRowFilter); } Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TableViewRowListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TableViewRowListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/TableViewRowListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TableViewRowListener.java Mon Mar 14 20:52:43 2016 @@ -79,7 +79,7 @@ public interface TableViewRowListener { /** * Called when the rows in a table view have been cleared. * - * @param tableView + * @param tableView The source of the event. */ public void rowsCleared(TableView tableView); Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TableViewSortListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TableViewSortListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/TableViewSortListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TableViewSortListener.java Mon Mar 14 20:52:43 2016 @@ -49,17 +49,17 @@ public interface TableViewSortListener { /** * Called when a sort has been added to a table view. * - * @param tableView - * @param columnName + * @param tableView The source of this event. + * @param columnName The new column name added to the sort criteria. */ public void sortAdded(TableView tableView, String columnName); /** * Called when a sort has been updated in a table view. * - * @param tableView - * @param columnName - * @param previousSortDirection + * @param tableView The source of this event. + * @param columnName The column that was updated. + * @param previousSortDirection The previous value of the sort direction for this column. */ public void sortUpdated(TableView tableView, String columnName, SortDirection previousSortDirection); @@ -67,16 +67,16 @@ public interface TableViewSortListener { /** * Called when a sort has been removed from a table view. * - * @param tableView - * @param columnName - * @param sortDirection + * @param tableView The source of this event. + * @param columnName The column name that was removed from the sort criteria. + * @param sortDirection What the sort direction was for this column. */ public void sortRemoved(TableView tableView, String columnName, SortDirection sortDirection); /** * Called when a table view's sort has changed. * - * @param tableView + * @param tableView The source of this event. */ public void sortChanged(TableView tableView); } Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/Viewport.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/Viewport.java?rev=1734997&r1=1734996&r2=1734997&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/Viewport.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/Viewport.java Mon Mar 14 20:52:43 2016 @@ -113,7 +113,7 @@ public abstract class Viewport extends C } /** - * Returns the (single) component (typically a {@link Container}) that we + * @return The (single) component (typically a {@link Container}) that we * are providing a windowed (or scrollable) view of. */ public Component getView() { @@ -123,6 +123,8 @@ public abstract class Viewport extends C /** * Set the single component (typically a {@link Container}) that we will * provide a windowed (or scrollable) view of. + * + * @param view The new component (container) we are viewing. */ public void setView(Component view) { Component previousView = this.view; @@ -173,7 +175,7 @@ public abstract class Viewport extends C } /** - * The bounds of the Viewport within the container, for example, in + * @return The bounds of the Viewport within the container, for example, in * ScrollPaneSkin, this excludes the scrollbars. */ public Bounds getViewportBounds() {
