You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pivot.apache.org by rw...@apache.org on 2016/03/14 21:52:44 UTC
svn commit: r1734997 [1/2] - /pivot/trunk/wtk/src/org/apache/pivot/wtk/
Author: rwhitcomb
Date: Mon Mar 14 20:52:43 2016
New Revision: 1734997
URL: http://svn.apache.org/viewvc?rev=1734997&view=rev
Log:
PIVOT-976: More Javadoc fixes for the warnings from Java 8.
Continuing on down the list, basically. Almost all of these are
@param descriptions, although some are @return and some are @throws.
Also continued a little bit using the Utils.checkNull method in some
places in the components that were updated. This is a bit off-track
for Javadoc, but there is no separate JIRA for these changes, so ....
Modified:
pivot/trunk/wtk/src/org/apache/pivot/wtk/ListView.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/ListViewBindingListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/ListViewItemListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/ListViewItemStateListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/ListViewListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/Menu.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuBar.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuBarListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuButtonListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuHandler.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuItemSelectionListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuPopupListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuPopupStateListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/MeterListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/Mouse.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/MovieViewListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/Platform.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/PromptListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/RadioButtonGroup.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/RangeSelection.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/RollupListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/RollupStateListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/ScrollBarListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/ScrollBarValueListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/ScrollPaneListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/SeparatorListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/SheetCloseListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/SheetStateListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/SliderListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/SliderValueListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/Span.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/Spinner.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/SpinnerBindingListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/SpinnerItemListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/SpinnerListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/SuggestionPopup.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/SuggestionPopupCloseListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/SuggestionPopupItemListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/SuggestionPopupListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/SuggestionPopupSelectionListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/SuggestionPopupStateListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/TabPaneAttributeListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/TablePane.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/TablePaneAttributeListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/TablePaneListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/TableView.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/TableViewBindingListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/TableViewColumnListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/TableViewHeaderListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/TableViewHeaderPressListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/TableViewListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/TableViewRowListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/TableViewSortListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/Viewport.java
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/ListView.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/ListView.java?rev=1734997&r1=1734996&r2=1734997&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/ListView.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/ListView.java Mon Mar 14 20:52:43 2016
@@ -88,7 +88,7 @@ public class ListView extends Component
/**
* Converts a list item to a string representation.
*
- * @param item
+ * @param item The particular list item.
* @return The item's string representation, or <tt>null</tt> if the item
* does not have a string representation. <p> Note that this method may
* be called often during keyboard navigation, so implementations should
@@ -104,8 +104,8 @@ public class ListView extends Component
/**
* Called to begin editing a list item.
*
- * @param listView
- * @param itemIndex
+ * @param listView The list view being edited.
+ * @param itemIndex The index if the particular item being edited.
*/
public void beginEdit(ListView listView, int itemIndex);
@@ -119,6 +119,8 @@ public class ListView extends Component
/**
* Tests whether an edit is currently in progress.
+ *
+ * @return Whether an edit is in progress.
*/
public boolean isEditing();
}
@@ -142,7 +144,8 @@ public class ListView extends Component
* Converts a context value to list data during a
* {@link Component#load(Object)} operation.
*
- * @param value
+ * @param value The value fetched from the bound object.
+ * @return The value converted to a list of data.
*/
public List<?> toListData(Object value);
@@ -150,7 +153,9 @@ public class ListView extends Component
* Converts list data to a context value during a
* {@link Component#store(Object)} operation.
*
- * @param listData
+ * @param listData The current list data from the list view.
+ * @return That list data converted to an object suitable for
+ * persistence in the bound object.
*/
public Object valueOf(List<?> listData);
}
@@ -177,6 +182,7 @@ public class ListView extends Component
*
* @param listData The source list data.
* @param index The index of the value to retrieve.
+ * @return The item at the given index.
*/
public Object get(List<?> listData, int index);
}
@@ -711,12 +717,11 @@ public class ListView extends Component
* Sets the list data.
*
* @param listData The data to be presented by the list view.
+ * @throws IllegalArgumentException if the list data is {@code null}.
*/
@SuppressWarnings("unchecked")
public void setListData(List<?> listData) {
- if (listData == null) {
- throw new IllegalArgumentException("listData is null.");
- }
+ Utils.checkNull(listData, "listData");
List<?> previousListData = this.listData;
@@ -755,11 +760,11 @@ public class ListView extends Component
*
* @param listData A JSON string (must begin with <tt>[</tt> and end with
* <tt>]</tt>) denoting the data to be presented by the list view.
+ * @throws IllegalArgumentException if the list data argument is {@code null}
+ * or cannot be parsed into a list of items.
*/
public final void setListData(String listData) {
- if (listData == null) {
- throw new IllegalArgumentException("listData is null.");
- }
+ Utils.checkNull(listData, "listData");
try {
setListData(JSONSerializer.parseList(listData));
@@ -773,11 +778,12 @@ public class ListView extends Component
*
* @param listData A URL referring to a JSON file containing the data to be
* presented by the list view.
+ * @throws IllegalArgumentException if the list data URL is {@code null}
+ * or if there is any kind of error trying to retrieve the list data from
+ * that location.
*/
public void setListData(URL listData) {
- if (listData == null) {
- throw new IllegalArgumentException("listData is null.");
- }
+ Utils.checkNull(listData, "listData");
JSONSerializer jsonSerializer = new JSONSerializer();
@@ -801,7 +807,7 @@ public class ListView extends Component
}
/**
- * Returns the item renderer used for items in this list.
+ * @return The item renderer used for items in this list.
*/
public ItemRenderer getItemRenderer() {
return itemRenderer;
@@ -811,11 +817,10 @@ public class ListView extends Component
* Sets the item renderer to be used for items in this list.
*
* @param itemRenderer The item renderer for the list.
+ * @throws IllegalArgumentException if the renderer given is {@code null}.
*/
public void setItemRenderer(ItemRenderer itemRenderer) {
- if (itemRenderer == null) {
- throw new IllegalArgumentException("itemRenderer is null.");
- }
+ Utils.checkNull(itemRenderer, "itemRenderer");
ItemRenderer previousItemRenderer = this.itemRenderer;
@@ -876,8 +881,8 @@ public class ListView extends Component
/**
* Sets the selection to a single range.
*
- * @param start
- * @param end
+ * @param start The beginning of the single selection.
+ * @param end The end of the selection.
*/
public void setSelectedRange(int start, int end) {
ArrayList<Span> selectedRanges = new ArrayList<>();
@@ -903,13 +908,13 @@ public class ListView extends Component
* connecting ranges will be consolidated, and the resulting selection will
* be sorted in ascending order.
*
- * @param selectedRanges
+ * @param selectedRanges The new set of selected ranges.
* @return The ranges that were actually set.
+ * @throws IllegalArgumentException if the ranges argument is {@code null}
+ * or if any of the individual range elements is {@code null}.
*/
public Sequence<Span> setSelectedRanges(Sequence<Span> selectedRanges) {
- if (selectedRanges == null) {
- throw new IllegalArgumentException("selectedRanges is null.");
- }
+ Utils.checkNull(selectedRanges, "selectedRanges");
// When we're in mode NONE, the only thing we can do is to clear the
// selection
@@ -925,9 +930,7 @@ public class ListView extends Component
for (int i = 0, n = selectedRanges.getLength(); i < n; i++) {
Span range = selectedRanges.get(i);
- if (range == null) {
- throw new IllegalArgumentException("range is null.");
- }
+ Utils.checkNull(range, "range");
if (range.start < 0 || range.end >= listData.getLength()) {
throw new IndexOutOfBoundsException();
@@ -955,11 +958,11 @@ public class ListView extends Component
* select.
* @return The ranges that were actually set.
* @see #setSelectedRanges(Sequence)
+ * @throws IllegalArgumentException if the input string is {@code null}
+ * or if the value cannot be parsed correctly to a range specification.
*/
public final Sequence<Span> setSelectedRanges(String selectedRanges) {
- if (selectedRanges == null) {
- throw new IllegalArgumentException("selectedRanges is null.");
- }
+ Utils.checkNull(selectedRanges, "selectedRanges");
try {
setSelectedRanges(parseSelectedRanges(selectedRanges));
@@ -1052,9 +1055,7 @@ public class ListView extends Component
* @return The ranges that were added to the selection.
*/
public Sequence<Span> addSelectedRange(Span range) {
- if (range == null) {
- throw new IllegalArgumentException("range is null.");
- }
+ Utils.checkNull(range, "range");
return addSelectedRange(range.start, range.end);
}
@@ -1077,6 +1078,7 @@ public class ListView extends Component
* @param start The start of the range to remove.
* @param end The end of the range to remove.
* @return The ranges that were removed from the selection.
+ * @throws IllegalStateException if we are not in multi-select mode.
*/
public Sequence<Span> removeSelectedRange(int start, int end) {
if (selectMode != SelectMode.MULTI) {
@@ -1110,9 +1112,7 @@ public class ListView extends Component
* @return The ranges that were removed from the selection.
*/
public Sequence<Span> removeSelectedRange(Span range) {
- if (range == null) {
- throw new IllegalArgumentException("range is null.");
- }
+ Utils.checkNull(range, "range");
return removeSelectedRange(range.start, range.end);
}
@@ -1178,17 +1178,13 @@ public class ListView extends Component
@SuppressWarnings("unchecked")
public void setSelectedItems(Sequence<Object> items) {
- if (items == null) {
- throw new IllegalArgumentException();
- }
+ Utils.checkNull(items, "items");
ArrayList<Span> selectedRanges = new ArrayList<>();
for (int i = 0, n = items.getLength(); i < n; i++) {
Object item = items.get(i);
- if (item == null) {
- throw new IllegalArgumentException("item is null");
- }
+ Utils.checkNull(item, "item");
int index = ((List<Object>) listData).indexOf(item);
if (index == -1) {
@@ -1202,7 +1198,7 @@ public class ListView extends Component
}
/**
- * Returns the current selection mode.
+ * @return The current selection mode.
*/
public SelectMode getSelectMode() {
return selectMode;
@@ -1215,9 +1211,7 @@ public class ListView extends Component
* @param selectMode The new selection mode.
*/
public void setSelectMode(SelectMode selectMode) {
- if (selectMode == null) {
- throw new IllegalArgumentException("selectMode is null.");
- }
+ Utils.checkNull(selectMode, "selectMode");
SelectMode previousSelectMode = this.selectMode;
@@ -1234,17 +1228,17 @@ public class ListView extends Component
}
/**
- * Returns the current check mode.
+ * @return Whether or not checkmarks on each item are enabled.
*/
public boolean getCheckmarksEnabled() {
return checkmarksEnabled;
}
/**
- * Enables or disabled checkmarks. Clears the check state if the check mode
+ * Enables or disables checkmarks. Clears the check state if the check mode
* has changed (but does not fire any check state change events).
*
- * @param checkmarksEnabled
+ * @param checkmarksEnabled Whether or not to enable checkmarks for each item.
*/
public void setCheckmarksEnabled(boolean checkmarksEnabled) {
if (this.checkmarksEnabled != checkmarksEnabled) {
@@ -1265,7 +1259,8 @@ public class ListView extends Component
* <p> For a tri-state checkmark, if the {@link #checkmarksMixedAsChecked} flag
* is set, this method returns <tt>true</tt> if the state is {@link Button.State#MIXED}.
*
- * @param index
+ * @param index The index of the item to test.
+ * @return Whether or not the given item is checked.
*/
public boolean isItemChecked(int index) {
if (allowTriStateCheckmarks && checkmarksMixedAsChecked) {
@@ -1279,8 +1274,9 @@ public class ListView extends Component
/**
* Sets an item's checked state.
*
- * @param index
- * @param checked
+ * @param index Index of the item to change.
+ * @param checked The new value of that item's checked state.
+ * @throws IllegalStateException if checkmarks are not enabled.
*/
public void setItemChecked(int index, boolean checked) {
if (!checkmarksEnabled) {
@@ -1308,6 +1304,7 @@ public class ListView extends Component
* Returns the indexes of currently checked items.
* <p> If the {@link #checkmarksMixedAsChecked} flag is set this method
* will return all the checked and <tt>MIXED</tt> state items.
+ * @return The complete list of currently checked items.
*/
public ImmutableList<Integer> getCheckedIndexes() {
if (checkmarksMixedAsChecked) {
@@ -1364,6 +1361,7 @@ public class ListView extends Component
/**
* Gets the state of all items' checkmarks (for the tri-state case).
+ * @return The complete list of all checkmark states.
*/
public ImmutableList<Button.State> getCheckmarkStates() {
List<Button.State> states = new ArrayList<>();
@@ -1390,6 +1388,8 @@ public class ListView extends Component
* Gets an item's checkmark state (for tri-state checkmarks).
* <p> Note: this method returns the real state regardless of the
* setting of the {@link #checkmarksMixedAsChecked} flag.
+ * @param index The index of the item in question.
+ * @return The checkmark state for that item.
*/
public Button.State getItemCheckmarkState(int index) {
// Find out where the item is stored currently (if at all)
@@ -1408,7 +1408,8 @@ public class ListView extends Component
/**
* Sets an item's checkmark state (for tri-state checkmarks).
*
- * @param state
+ * @param index The index of the item to change.
+ * @param state The new checkmark state for the item.
*/
public void setItemCheckmarkState(int index, Button.State state) {
if (!checkmarksEnabled) {
@@ -1514,6 +1515,7 @@ public class ListView extends Component
* this property enabled, then there are additional methods to set the mixed state, to get
* the true state of all the items, and to decide if mixed state should be treated as checked
* or not for all the other "checked" methods.
+ * @return Whether or not tri-state checkmarks are enabled.
*/
public boolean getAllowTriStateCheckmarks() {
return allowTriStateCheckmarks;
@@ -1528,7 +1530,7 @@ public class ListView extends Component
* <p> Clears the check state if the setting has changed (but does not fire any check
* state change events).
*
- * @param allow
+ * @param allow Whether or not to allow tri-state checkmarks.
*/
public void setAllowTriStateCheckmarks(boolean allow) {
if (allowTriStateCheckmarks != allow) {
@@ -1548,6 +1550,8 @@ public class ListView extends Component
* we get mouse clicks on the checkmark. Set to <tt>false</tt> <code>UNSELECTED</code>
* will go to <code>MIXED</code>; while set to <tt>true</tt> <code>UNSELECTED</code> will
* go to <code>SELECTED</code>.
+ *
+ * @return Whether or not to treat the mixed state as "checked".
*/
public boolean getCheckmarksMixedAsChecked() {
return checkmarksMixedAsChecked;
@@ -1557,7 +1561,7 @@ public class ListView extends Component
* Set the flag saying whether the mixed state of the tri-state checkmarks should be treated for
* all other purposes as "checked" or not.
*
- * @param mixedAsChecked
+ * @param mixedAsChecked Whether or not to treat the mixed state as "checked".
*/
public void setCheckmarksMixedAsChecked(boolean mixedAsChecked) {
if (checkmarksMixedAsChecked != mixedAsChecked) {
@@ -1638,9 +1642,7 @@ public class ListView extends Component
}
public void setListDataBindType(BindType listDataBindType) {
- if (listDataBindType == null) {
- throw new IllegalArgumentException();
- }
+ Utils.checkNull(listDataBindType, "listDataBindType");
BindType previousListDataBindType = this.listDataBindType;
@@ -1681,9 +1683,7 @@ public class ListView extends Component
}
public void setSelectedItemBindType(BindType selectedItemBindType) {
- if (selectedItemBindType == null) {
- throw new IllegalArgumentException();
- }
+ Utils.checkNull(selectedItemBindType, "selectedItemBindType");
BindType previousSelectedItemBindType = this.selectedItemBindType;
if (previousSelectedItemBindType != selectedItemBindType) {
@@ -1724,9 +1724,7 @@ public class ListView extends Component
}
public void setSelectedItemsBindType(BindType selectedItemsBindType) {
- if (selectedItemsBindType == null) {
- throw new IllegalArgumentException();
- }
+ Utils.checkNull(selectedItemsBindType, "selectedItemsBindType");
BindType previousSelectedItemsBindType = this.selectedItemsBindType;
if (previousSelectedItemsBindType != selectedItemsBindType) {
@@ -1768,9 +1766,7 @@ public class ListView extends Component
}
public void setCheckedItemsBindType(BindType checkedItemsBindType) {
- if (checkedItemsBindType == null) {
- throw new IllegalArgumentException();
- }
+ Utils.checkNull(checkedItemsBindType, "checkedItemsBindType");
BindType previousCheckedItemsBindType = this.checkedItemsBindType;
if (previousCheckedItemsBindType != checkedItemsBindType) {
@@ -1811,9 +1807,7 @@ public class ListView extends Component
}
public void setItemsStateBindType(BindType itemsStateBindType) {
- if (itemsStateBindType == null) {
- throw new IllegalArgumentException("Bind type must not be null");
- }
+ Utils.checkNull(itemsStateBindType, "itemsStateBindType");
BindType previousItemsStateBindType = this.itemsStateBindType;
if (previousItemsStateBindType != itemsStateBindType) {
@@ -1931,9 +1925,9 @@ public class ListView extends Component
if (index != -1) {
Button.State state = Button.State.UNSELECTED;
if (itemsStateBindMapping == null) {
- state = itemsStateBindMapping.getState(item);
- } else {
state = Button.State.SELECTED;
+ } else {
+ state = itemsStateBindMapping.getState(item);
}
setItemCheckmarkState(index, state);
}
@@ -2157,33 +2151,36 @@ public class ListView extends Component
}
/**
- * Returns the list view listener list.
+ * @return The list view listener list.
*/
public ListenerList<ListViewListener> getListViewListeners() {
return listViewListeners;
}
/**
- * Returns the list view item listener list.
+ * @return The list view item listener list.
*/
public ListenerList<ListViewItemListener> getListViewItemListeners() {
return listViewItemListeners;
}
/**
- * Returns the list view item state listener list.
+ * @return The list view item state listener list.
*/
public ListenerList<ListViewItemStateListener> getListViewItemStateListeners() {
return listViewItemStateListeners;
}
/**
- * Returns the list view selection detail listener list.
+ * @return The list view selection listener list.
*/
public ListenerList<ListViewSelectionListener> getListViewSelectionListeners() {
return listViewSelectionListeners;
}
+ /**
+ * @return The list view binding listener list.
+ */
public ListenerList<ListViewBindingListener> getListViewBindingListeners() {
return listViewBindingListeners;
}
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/ListViewBindingListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/ListViewBindingListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/ListViewBindingListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/ListViewBindingListener.java Mon Mar 14 20:52:43 2016
@@ -111,24 +111,24 @@ public interface ListViewBindingListener
/**
* Called when a list view's list data key has changed.
*
- * @param listView
- * @param previousListDataKey
+ * @param listView The list view whose binding has changed.
+ * @param previousListDataKey The previous binding key for the list data.
*/
public void listDataKeyChanged(ListView listView, String previousListDataKey);
/**
* Called when a list view's list data bind type has changed.
*
- * @param listView
- * @param previousListDataBindType
+ * @param listView The list view whose binding has changed.
+ * @param previousListDataBindType The previous bind type for the list data.
*/
public void listDataBindTypeChanged(ListView listView, BindType previousListDataBindType);
/**
* Called when a list view's list data bind mapping has changed.
*
- * @param listView
- * @param previousListDataBindMapping
+ * @param listView The list view whose binding has changed.
+ * @param previousListDataBindMapping The previous bind mapping for the list data.
*/
public void listDataBindMappingChanged(ListView listView,
ListView.ListDataBindMapping previousListDataBindMapping);
@@ -136,24 +136,24 @@ public interface ListViewBindingListener
/**
* Called when a list view's selected item key has changed.
*
- * @param listView
- * @param previousSelectedItemKey
+ * @param listView The list view whose binding has changed.
+ * @param previousSelectedItemKey The previous binding key for the selected item.
*/
public void selectedItemKeyChanged(ListView listView, String previousSelectedItemKey);
/**
* Called when a list view's selected item bind type has changed.
*
- * @param listView
- * @param previousSelectedItemBindType
+ * @param listView The list view whose binding has changed.
+ * @param previousSelectedItemBindType The previous bind type for the selected item.
*/
public void selectedItemBindTypeChanged(ListView listView, BindType previousSelectedItemBindType);
/**
* Called when a list view's selected item bind mapping has changed.
*
- * @param listView
- * @param previousSelectedItemBindMapping
+ * @param listView The list view whose binding has changed.
+ * @param previousSelectedItemBindMapping The previous bind mapping for the selected item.
*/
public void selectedItemBindMappingChanged(ListView listView,
ListView.ItemBindMapping previousSelectedItemBindMapping);
@@ -161,16 +161,16 @@ public interface ListViewBindingListener
/**
* Called when a list view's selected items key has changed.
*
- * @param listView
- * @param previousSelectedItemsKey
+ * @param listView The list view whose binding has changed.
+ * @param previousSelectedItemsKey The previous binding key for the selected items.
*/
public void selectedItemsKeyChanged(ListView listView, String previousSelectedItemsKey);
/**
* Called when a list view's selected items bind type has changed.
*
- * @param listView
- * @param previousSelectedItemsBindType
+ * @param listView The list view whose binding has changed.
+ * @param previousSelectedItemsBindType The previous bind type for the selected items.
*/
public void selectedItemsBindTypeChanged(ListView listView,
BindType previousSelectedItemsBindType);
@@ -178,8 +178,8 @@ public interface ListViewBindingListener
/**
* Called when a list view's selected items bind mapping has changed.
*
- * @param listView
- * @param previousSelectedItemsBindMapping
+ * @param listView The list view whose binding has changed.
+ * @param previousSelectedItemsBindMapping The previous bind mapping for the selected items.
*/
public void selectedItemsBindMappingChanged(ListView listView,
ListView.ItemBindMapping previousSelectedItemsBindMapping);
@@ -187,49 +187,49 @@ public interface ListViewBindingListener
/**
* Called when a list view's checked items key has changed.
*
- * @param listView
- * @param previousCheckedItemsKey
+ * @param listView The list view whose binding has changed.
+ * @param previousCheckedItemsKey The previous binding key for the checked items.
*/
public void checkedItemsKeyChanged(ListView listView, String previousCheckedItemsKey);
/**
* Called when a list view's checked items bind type has changed.
*
- * @param listView
- * @param previousCheckedItemsBindType
+ * @param listView The list view whose binding has changed.
+ * @param previousCheckedItemsBindType The previous bind type for the checked items.
*/
public void checkedItemsBindTypeChanged(ListView listView, BindType previousCheckedItemsBindType);
/**
* Called when a list view's checked items bind mapping has changed.
*
- * @param listView
- * @param previousCheckedItemsBindMapping
+ * @param listView The list view whose binding has changed.
+ * @param previousCheckedItemsBindMapping The previous bind mapping function for the checked items.
*/
public void checkedItemsBindMappingChanged(ListView listView,
ListView.ItemBindMapping previousCheckedItemsBindMapping);
/**
- * Called when a list view's items state key has changed.
+ * Called when a list view's items' state key has changed.
*
- * @param listView
- * @param previousItemsStateKey
+ * @param listView The list view whose binding has changed.
+ * @param previousItemsStateKey The previous bind key for the items' state.
*/
public void itemsStateKeyChanged(ListView listView, String previousItemsStateKey);
/**
- * Called when a list view's items state bind type has changed.
+ * Called when a list view's items' state bind type has changed.
*
- * @param listView
- * @param previousItemsStateBindType
+ * @param listView The list view whose binding has changed.
+ * @param previousItemsStateBindType The previous bind type for the items' state.
*/
public void itemsStateBindTypeChanged(ListView listView, BindType previousItemsStateBindType);
/**
* Called when a list view's items state bind mapping has changed.
*
- * @param listView
- * @param previousItemsStateBindMapping
+ * @param listView The list view whose binding has changed.
+ * @param previousItemsStateBindMapping The previous bind mapping function for the items' state.
*/
public void itemsStateBindMappingChanged(ListView listView,
ListView.ItemStateBindMapping previousItemsStateBindMapping);
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/ListViewItemListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/ListViewItemListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/ListViewItemListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/ListViewItemListener.java Mon Mar 14 20:52:43 2016
@@ -79,7 +79,7 @@ public interface ListViewItemListener {
/**
* Called when the items in a list view have been cleared.
*
- * @param listView
+ * @param listView The source of the event.
*/
public void itemsCleared(ListView listView);
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/ListViewItemStateListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/ListViewItemStateListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/ListViewItemStateListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/ListViewItemStateListener.java Mon Mar 14 20:52:43 2016
@@ -23,16 +23,16 @@ public interface ListViewItemStateListen
/**
* Called when an item's checked state has changed.
*
- * @param listView
- * @param index
+ * @param listView The list view whose state has changed.
+ * @param index The index of the item whose checked state has changed.
*/
public void itemCheckedChanged(ListView listView, int index);
/**
* Called when a tri-state item's state has changed.
*
- * @param listView
- * @param index
+ * @param listView The list view whose state has changed.
+ * @param index The index of the item whose tri-state has changed.
*/
public void itemCheckedStateChanged(ListView listView, int index);
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/ListViewListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/ListViewListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/ListViewListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/ListViewListener.java Mon Mar 14 20:52:43 2016
@@ -79,46 +79,46 @@ public interface ListViewListener {
/**
* Called when a list view's list data has changed.
*
- * @param listView
- * @param previousListData
+ * @param listView The source of the event.
+ * @param previousListData The previous list data that was displayed.
*/
public void listDataChanged(ListView listView, List<?> previousListData);
/**
* Called when a list view's item renderer has changed.
*
- * @param listView
- * @param previousItemRenderer
+ * @param listView The source of the event.
+ * @param previousItemRenderer The previous renderer used for each item.
*/
public void itemRendererChanged(ListView listView, ListView.ItemRenderer previousItemRenderer);
/**
* Called when a list view's item editor has changed.
*
- * @param listView
- * @param previousItemEditor
+ * @param listView The source of the event.
+ * @param previousItemEditor The previous editor used for updating items.
*/
public void itemEditorChanged(ListView listView, ListView.ItemEditor previousItemEditor);
/**
* Called when a list view's select mode has changed.
*
- * @param listView
- * @param previousSelectMode
+ * @param listView The source of the event.
+ * @param previousSelectMode The previous selection mode.
*/
public void selectModeChanged(ListView listView, ListView.SelectMode previousSelectMode);
/**
* Called when a list view's checkmarks enabled flag has changed.
*
- * @param listView
+ * @param listView The list view that has been changed.
*/
public void checkmarksEnabledChanged(ListView listView);
/**
* Called when a list view's tri-state checkmarks flag has been changed.
*
- * @param listView
+ * @param listView The list view that has been changed.
*/
public void checkmarksTriStateChanged(ListView listView);
@@ -126,23 +126,24 @@ public interface ListViewListener {
* Called when a list view's flag to decide if mixed checkbox state should
* be treated as checked has been changed.
*
- * @param listView
+ * @param listView The list view that has been changed.
*/
public void checkmarksMixedAsCheckedChanged(ListView listView);
/**
* Called when a list view's disabled item filter has changed.
*
- * @param listView
- * @param previousDisabledItemFilter
+ * @param listView The source of the event.
+ * @param previousDisabledItemFilter The previous filter function used to disable specific items.
*/
public void disabledItemFilterChanged(ListView listView, Filter<?> previousDisabledItemFilter);
/**
* Called when a list view's disabled checkmark filter has changed.
*
- * @param listView
- * @param previousDisabledCheckmarkFilter
+ * @param listView The source of the event.
+ * @param previousDisabledCheckmarkFilter The previous filter function used to disable checkmarks
+ * for certain items.
*/
public void disabledCheckmarkFilterChanged(ListView listView,
Filter<?> previousDisabledCheckmarkFilter);
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/Menu.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/Menu.java?rev=1734997&r1=1734996&r2=1734997&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/Menu.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/Menu.java Mon Mar 14 20:52:43 2016
@@ -202,15 +202,15 @@ public class Menu extends Container {
/**
* Called when an item's menu has changed.
*
- * @param item
- * @param previousMenu
+ * @param item The item that has been moved.
+ * @param previousMenu The menu where the item used to live.
*/
public void menuChanged(Item item, Menu previousMenu);
/**
* Called when an item's active state has changed.
*
- * @param item
+ * @param item The item that is changing.
*/
public void activeChanged(Item item);
}
@@ -357,25 +357,25 @@ public class Menu extends Container {
/**
* Called when a menu item has been inserted.
*
- * @param section
- * @param index
+ * @param section The section that is changing.
+ * @param index The index where the item was inserted.
*/
public void itemInserted(Section section, int index);
/**
* Called when menu items have been removed.
*
- * @param section
- * @param index
- * @param removed
+ * @param section The section that has changed.
+ * @param index The starting index of the removed items.
+ * @param removed The sequence of the items that were removed.
*/
public void itemsRemoved(Section section, int index, Sequence<Item> removed);
/**
* Called when a section's name has changed.
*
- * @param section
- * @param previousName
+ * @param section The section that changed.
+ * @param previousName The previous name for this section.
*/
public void nameChanged(Section section, String previousName);
}
@@ -518,7 +518,7 @@ public class Menu extends Container {
}
/**
- * Retrieves the parent item of this menu.
+ * @return The parent item of this menu.
*/
public Item getItem() {
return item;
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuBar.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuBar.java?rev=1734997&r1=1734996&r2=1734997&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuBar.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuBar.java Mon Mar 14 20:52:43 2016
@@ -168,15 +168,15 @@ public class MenuBar extends Container {
/**
* Called when an item's menu has changed.
*
- * @param item
- * @param previousMenu
+ * @param item The item that has been moved.
+ * @param previousMenu The menu where the item used to be located.
*/
public void menuChanged(Item item, Menu previousMenu);
/**
* Called when an item's active state has changed.
*
- * @param item
+ * @param item The item whose active state has changed.
*/
public void activeChanged(Item item);
}
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuBarListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuBarListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuBarListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuBarListener.java Mon Mar 14 20:52:43 2016
@@ -45,25 +45,25 @@ public interface MenuBarListener {
/**
* Called when a menu bar item has been inserted.
*
- * @param menuBar
- * @param index
+ * @param menuBar The menu bar that changed.
+ * @param index The index where a new item was inserted.
*/
public void itemInserted(MenuBar menuBar, int index);
/**
* Called when menu bar items have been removed.
*
- * @param menuBar
- * @param index
- * @param removed
+ * @param menuBar The source of the event.
+ * @param index The starting index where items were removed.
+ * @param removed The sequence of removed items.
*/
public void itemsRemoved(MenuBar menuBar, int index, Sequence<MenuBar.Item> removed);
/**
* Called when a menu bar's active item has changed.
*
- * @param menuBar
- * @param previousActiveItem
+ * @param menuBar The source of the event.
+ * @param previousActiveItem Which item was active previously.
*/
public void activeItemChanged(MenuBar menuBar, MenuBar.Item previousActiveItem);
}
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuButtonListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuButtonListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuButtonListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuButtonListener.java Mon Mar 14 20:52:43 2016
@@ -23,8 +23,8 @@ public interface MenuButtonListener {
/**
* Called when a menu button's menu has changed.
*
- * @param menuButton
- * @param previousMenu
+ * @param menuButton The menu button that has changed.
+ * @param previousMenu The previous menu attached to the button.
*/
public void menuChanged(MenuButton menuButton, Menu previousMenu);
}
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuHandler.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuHandler.java?rev=1734997&r1=1734996&r2=1734997&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuHandler.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuHandler.java Mon Mar 14 20:52:43 2016
@@ -44,8 +44,8 @@ public interface MenuHandler {
* Called when a component to which this handler is attached gains the
* focus.
*
- * @param component
- * @param menuBar
+ * @param component The component that is hosting the menu bar.
+ * @param menuBar The menu bar to configure.
*/
public void configureMenuBar(Component component, MenuBar menuBar);
@@ -53,8 +53,8 @@ public interface MenuHandler {
* Called when a component to which this handler is attached loses the
* focus.
*
- * @param component
- * @param menuBar
+ * @param component The component that is hosting the menu bar.
+ * @param menuBar The menu bar to clean up.
*/
public void cleanupMenuBar(Component component, MenuBar menuBar);
@@ -62,10 +62,10 @@ public interface MenuHandler {
* Called when the user right-clicks on a component to which this handler is
* attached.
*
- * @param component
- * @param menu
- * @param x
- * @param y
+ * @param component The component that is handling the menu.
+ * @param menu The menu to be configured.
+ * @param x The X location of the click.
+ * @param y The Y location of the click.
* @return <tt>true</tt> to stop propagation of context menu configuration;
* <tt>false</tt> to allow it to continue.
*/
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuItemSelectionListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuItemSelectionListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuItemSelectionListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuItemSelectionListener.java Mon Mar 14 20:52:43 2016
@@ -23,7 +23,7 @@ public interface MenuItemSelectionListen
/**
* Called when a descendant item of this menu has been selected.
*
- * @param menuItem
+ * @param menuItem The newly selected menu item.
*/
public void itemSelected(Menu.Item menuItem);
}
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuListener.java Mon Mar 14 20:52:43 2016
@@ -45,25 +45,25 @@ public interface MenuListener {
/**
* Called when a menu section has been inserted.
*
- * @param menu
- * @param index
+ * @param menu The source of the event.
+ * @param index Where the menu section was inserted.
*/
public void sectionInserted(Menu menu, int index);
/**
* Called when menu sections have been removed.
*
- * @param menu
- * @param index
- * @param removed
+ * @param menu The menu that changed.
+ * @param index The starting index of the removal.
+ * @param removed The actual menu sections that were removed from the menu.
*/
public void sectionsRemoved(Menu menu, int index, Sequence<Menu.Section> removed);
/**
* Called when a menu's active item has changed.
*
- * @param menu
- * @param previousActiveItem
+ * @param menu The menu that changed.
+ * @param previousActiveItem What the previously active menu item was.
*/
public void activeItemChanged(Menu menu, Menu.Item previousActiveItem);
}
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuPopupListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuPopupListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuPopupListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuPopupListener.java Mon Mar 14 20:52:43 2016
@@ -23,8 +23,8 @@ public interface MenuPopupListener {
/**
* Called when a menu popup's menu has changed.
*
- * @param menuPopup
- * @param previousMenu
+ * @param menuPopup The menu popup source of this event.
+ * @param previousMenu What the menu used to be for this popup.
*/
public void menuChanged(MenuPopup menuPopup, Menu previousMenu);
}
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuPopupStateListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuPopupStateListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuPopupStateListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/MenuPopupStateListener.java Mon Mar 14 20:52:43 2016
@@ -45,23 +45,24 @@ public interface MenuPopupStateListener
/**
* Called to preview a menu popup close event.
*
- * @param menuPopup
- * @param immediate
+ * @param menuPopup The source of the event.
+ * @param immediate Whether the close is meant to be immediate.
+ * @return The verdict as to whether to close from this listener.
*/
public Vote previewMenuPopupClose(MenuPopup menuPopup, boolean immediate);
/**
* Called when a menu popup close event has been vetoed.
*
- * @param menuPopup
- * @param reason
+ * @param menuPopup The source of the event.
+ * @param reason The accumulated vote that caused the veto.
*/
public void menuPopupCloseVetoed(MenuPopup menuPopup, Vote reason);
/**
* Called when a menu popup has closed.
*
- * @param menuPopup
+ * @param menuPopup The menu popup that closed.
*/
public void menuPopupClosed(MenuPopup menuPopup);
}
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/MeterListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/MeterListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/MeterListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/MeterListener.java Mon Mar 14 20:52:43 2016
@@ -43,16 +43,16 @@ public interface MeterListener {
/**
* Called when a meter's percentage value has changed.
*
- * @param meter
- * @param previousPercentage
+ * @param meter The meter that is changing.
+ * @param previousPercentage What the meter's percentage value used to be.
*/
public void percentageChanged(Meter meter, double previousPercentage);
/**
* Called when a meter's text has changed.
*
- * @param meter
- * @param previousText
+ * @param meter The meter that has changed.
+ * @param previousText The previous meter text.
*/
public void textChanged(Meter meter, String previousText);
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/Mouse.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/Mouse.java?rev=1734997&r1=1734996&r2=1734997&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/Mouse.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/Mouse.java Mon Mar 14 20:52:43 2016
@@ -44,7 +44,7 @@ public final class Mouse {
private static Component capturer = null;
/**
- * Returns a bitfield representing the mouse buttons that are currently
+ * @return A bitfield representing the mouse buttons that are currently
* pressed.
*/
public static int getButtons() {
@@ -58,7 +58,7 @@ public final class Mouse {
/**
* Tests the pressed state of a button.
*
- * @param button
+ * @param button The button to test.
* @return <tt>true</tt> if the button is pressed; <tt>false</tt>, otherwise.
*/
public static boolean isPressed(Button button) {
@@ -66,7 +66,7 @@ public final class Mouse {
}
/**
- * Returns the number of mouse buttons.
+ * @return The number of mouse buttons.
*/
public static int getButtonCount() {
return MouseInfo.getNumberOfButtons();
@@ -141,7 +141,7 @@ public final class Mouse {
}
/**
- * Returns the current cursor.
+ * @return The current cursor.
*
* @throws IllegalStateException If the mouse is not currently captured.
*/
@@ -238,7 +238,8 @@ public final class Mouse {
/**
* Sets the cursor to an explicit value.
*
- * @param cursor
+ * @param cursor The new mouse cursor value.
+ * @throws IllegalArgumentException if the cursor value is {@code null}.
* @throws IllegalStateException If the mouse is not currently captured.
*/
public static void setCursor(Cursor cursor) {
@@ -258,7 +259,9 @@ public final class Mouse {
/**
* Sets the cursor based on a given component.
*
- * @param component
+ * @param component The component used to set the cursor.
+ * @throws IllegalArgumentException if the component is {@code null}, or
+ * if the component is not currently visible.
*/
public static void setCursor(final Component component) {
if (component == null) {
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/MovieViewListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/MovieViewListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/MovieViewListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/MovieViewListener.java Mon Mar 14 20:52:43 2016
@@ -25,8 +25,8 @@ public interface MovieViewListener {
/**
* Called when an movie view's movie has changed.
*
- * @param movieView
- * @param previousMovie
+ * @param movieView The move view that has changed.
+ * @param previousMovie The previous movie content.
*/
public void movieChanged(MovieView movieView, Movie previousMovie);
}
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/Platform.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/Platform.java?rev=1734997&r1=1734996&r2=1734997&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/Platform.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/Platform.java Mon Mar 14 20:52:43 2016
@@ -96,7 +96,7 @@ public class Platform {
}
/**
- * Returns the system multi-click interval.
+ * @return The system multi-click interval.
*/
public static int getMultiClickInterval() {
Toolkit toolkit = Toolkit.getDefaultToolkit();
@@ -110,7 +110,7 @@ public class Platform {
}
/**
- * Returns the system cursor blink rate.
+ * @return The system cursor blink rate.
*/
public static int getCursorBlinkRate() {
Toolkit toolkit = Toolkit.getDefaultToolkit();
@@ -124,28 +124,28 @@ public class Platform {
}
/**
- * Returns the system drag threshold.
+ * @return The system drag threshold.
*/
public static int getDragThreshold() {
return java.awt.dnd.DragSource.getDragThreshold();
}
/**
- * Returns the system command modifier key.
+ * @return The system command modifier key.
*/
public static Modifier getCommandModifier() {
return COMMAND_MODIFIER;
}
/**
- * Returns the word navigation modifier key.
+ * @return The word navigation modifier key.
*/
public static Modifier getWordNavigationModifier() {
return WORD_NAVIGATION_MODIFIER;
}
/**
- * Returns the keystroke modifier separator text.
+ * @return The keystroke modifier separator text.
*/
public static String getKeyStrokeModifierSeparator() {
return KEYSTROKE_MODIFIER_SEPARATOR;
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/PromptListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/PromptListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/PromptListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/PromptListener.java Mon Mar 14 20:52:43 2016
@@ -60,49 +60,49 @@ public interface PromptListener {
/**
* Called when a prompt's message type has changed.
*
- * @param prompt
- * @param previousMessageType
+ * @param prompt The prompt object that has been changed.
+ * @param previousMessageType The message type before the change.
*/
public void messageTypeChanged(Prompt prompt, MessageType previousMessageType);
/**
* Called when a prompt's message has changed.
*
- * @param prompt
- * @param previousMessage
+ * @param prompt The prompt whose message has changed.
+ * @param previousMessage What the message used to be.
*/
public void messageChanged(Prompt prompt, String previousMessage);
/**
* Called when a prompt's body has changed.
*
- * @param prompt
- * @param previousBody
+ * @param prompt The prompt that has changed.
+ * @param previousBody What the body of this prompt used to be.
*/
public void bodyChanged(Prompt prompt, Component previousBody);
/**
* Called when an option has been inserted into a prompt's option sequence.
*
- * @param prompt
- * @param index
+ * @param prompt The prompt whose options have changed.
+ * @param index The location where the new option was inserted.
*/
public void optionInserted(Prompt prompt, int index);
/**
* Called when options have been removed from a prompt's option sequence.
*
- * @param prompt
- * @param index
- * @param removed
+ * @param prompt The prompt whose options have changed.
+ * @param index The starting location of the removed options.
+ * @param removed The actual sequence of options removed.
*/
public void optionsRemoved(Prompt prompt, int index, Sequence<?> removed);
/**
* Called when a prompt's selected option has changed.
*
- * @param prompt
- * @param previousSelectedOption
+ * @param prompt The prompt that changed.
+ * @param previousSelectedOption The option that used to be the selected one.
*/
public void selectedOptionChanged(Prompt prompt, int previousSelectedOption);
}
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/RadioButtonGroup.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/RadioButtonGroup.java?rev=1734997&r1=1734996&r2=1734997&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/RadioButtonGroup.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/RadioButtonGroup.java Mon Mar 14 20:52:43 2016
@@ -245,6 +245,8 @@ public class RadioButtonGroup extends Bu
* reached.<br> Instead, the search will 'wrap' and continue from the
* opposite bound until each button in the entire group has been tested for
* inclusion. <br><br> Defaults to <code>false</code>
+ *
+ * @return Whether the group is circular.
*/
public boolean isCircular() {
return circular;
@@ -258,6 +260,8 @@ public class RadioButtonGroup extends Bu
* reached.<br> Instead, the search will 'wrap' and continue from the
* opposite bound until each button in the entire group has been tested for
* inclusion.
+ *
+ * @param circular New setting for the group.
*/
public void setCircular(boolean circular) {
this.circular = circular;
@@ -266,6 +270,8 @@ public class RadioButtonGroup extends Bu
/**
* When true, TAB and SHIFT+TAB transfer focus out of the RadioButtonGroup.
* <br> Defaults to <code>false</code>
+ *
+ * @return Whether focus transfers out of the group on TAB.
*/
public boolean isIntraGroupFocusTransferEnabled() {
return intraGroupFocusTransferEnabled;
@@ -274,6 +280,8 @@ public class RadioButtonGroup extends Bu
/**
* Controls whether TAB and SHIFT+TAB will transfer focus out of the
* RadioButtonGroup, or simply maintain their default behaviour.
+ *
+ * @param intraGroupFocusTransferEnabled New setting for this group.
*/
public void setIntraGroupFocusTransferEnabled(boolean intraGroupFocusTransferEnabled) {
this.intraGroupFocusTransferEnabled = intraGroupFocusTransferEnabled;
@@ -282,8 +290,10 @@ public class RadioButtonGroup extends Bu
/**
* Add a button to the group.
*
+ * @param button The button to add.
* @see Group#add(Object)
* @see Sequence#add(Object)
+ * @throws IllegalArgumentException if the button parameter is {@code null}.
*/
@Override
public boolean add(Button button) {
@@ -298,8 +308,9 @@ public class RadioButtonGroup extends Bu
}
/**
- * Return the button at the specified index.
+ * @return The button at the specified index.
*
+ * @param index The location to retrieve the button from.
* @see Sequence#get(int)
*/
public Button get(int index) {
@@ -307,7 +318,7 @@ public class RadioButtonGroup extends Bu
}
/**
- * Return the number of buttons in the group.
+ * @return The number of buttons in the group.
*
* @see Sequence#getLength()
*/
@@ -318,8 +329,9 @@ public class RadioButtonGroup extends Bu
/**
* Return the index (order) of the button within the group.
*
- * @return The index or -1 if the button does not belong to this
- * RadioButtonGroup
+ * @param button The button to search for in this group.
+ * @return The index or {@link #NOT_FOUND_INDEX} if the button does not belong to this
+ * RadioButtonGroup.
* @see Sequence#indexOf(Object)
*/
public int indexOf(Button button) {
@@ -329,7 +341,10 @@ public class RadioButtonGroup extends Bu
/**
* Insert a button at the specified index.
*
+ * @param button The button to be inserted.
+ * @param index Where to insert the button.
* @see Sequence#insert(Object, int)
+ * @throws IllegalArgumentException if the button parameter is {@code null}.
*/
public void insert(Button button, int index) {
if (button == null) {
@@ -344,6 +359,8 @@ public class RadioButtonGroup extends Bu
/**
* Remove the button from the group.
*
+ * @param button The button to remove from this group.
+ * @return Success indicator.
* @see Group#remove(Object)
* @see Sequence#remove(Object)
*/
@@ -363,6 +380,10 @@ public class RadioButtonGroup extends Bu
* Remove <code>count</code> buttons from the group starting at
* <code>index</code>.
*
+ * @param index Starting point for the removal.
+ * @param count Number of buttons to remove.
+ * @return The sequence of buttons actually removed (will not be
+ * {@code null}, but could be an empty sequence).
* @see Sequence#remove(int, int)
*/
public Sequence<Button> remove(int index, int count) {
@@ -379,7 +400,7 @@ public class RadioButtonGroup extends Bu
}
/**
- * Return an iterator for the <strong>ordered</strong> list of buttons
+ * @return An iterator for the <strong>ordered</strong> list of buttons
*/
@Override
public Iterator<Button> iterator() {
@@ -402,6 +423,8 @@ public class RadioButtonGroup extends Bu
/**
* Select and <strong>focus</strong> the button at the specified index,
* unless the index is NOT_FOUND_INDEX.
+ *
+ * @param index The new selection index for the group.
*/
public void setSelection(int index) {
if (index != NOT_FOUND_INDEX) {
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/RangeSelection.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/RangeSelection.java?rev=1734997&r1=1734996&r2=1734997&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/RangeSelection.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/RangeSelection.java Mon Mar 14 20:52:43 2016
@@ -57,8 +57,8 @@ public class RangeSelection {
* Adds a range to the selection, merging and removing intersecting ranges
* as needed.
*
- * @param start
- * @param end
+ * @param start Where to start the new range.
+ * @param end The end of the new range.
* @return A sequence containing the ranges that were added.
*/
public Sequence<Span> addRange(int start, int end) {
@@ -155,8 +155,8 @@ public class RangeSelection {
* Removes a range from the selection, truncating and removing intersecting
* ranges as needed.
*
- * @param start
- * @param end
+ * @param start Start of the range to remove.
+ * @param end The end of the range to remove.
* @return A sequence containing the ranges that were removed.
*/
public Sequence<Span> removeRange(int start, int end) {
@@ -242,23 +242,23 @@ public class RangeSelection {
}
/**
- * Returns the range at a given index.
+ * @return The range at a given index.
*
- * @param index
+ * @param index The index in question.
*/
public Span get(int index) {
return selectedRanges.get(index);
}
/**
- * Returns the number of ranges in the selection.
+ * @return The number of ranges in the selection.
*/
public int getLength() {
return selectedRanges.getLength();
}
/**
- * Returns an immutable wrapper around the selected ranges.
+ * @return An immutable wrapper around the selected ranges.
*/
public ImmutableList<Span> getSelectedRanges() {
return new ImmutableList<>(selectedRanges);
@@ -267,7 +267,7 @@ public class RangeSelection {
/**
* Determines the index of a range in the selection.
*
- * @param range
+ * @param range The range to look for.
* @return The index of the range, if it exists in the selection;
* <tt>-1</tt>, otherwise.
*/
@@ -287,7 +287,7 @@ public class RangeSelection {
/**
* Tests for the presence of an index in the selection.
*
- * @param index
+ * @param index The index to look for in the selection.
* @return <tt>true</tt> if the index is selected; <tt>false</tt>, otherwise.
*/
public boolean containsIndex(int index) {
@@ -301,7 +301,7 @@ public class RangeSelection {
* Inserts an index into the span sequence (e.g. when items are inserted
* into the model data).
*
- * @param index
+ * @param index The location to insert into the sequence.
* @return The number of ranges that were updated.
*/
public int insertIndex(int index) {
@@ -345,8 +345,8 @@ public class RangeSelection {
* Removes a range of indexes from the span sequence (e.g. when items are
* removed from the model data).
*
- * @param index
- * @param count
+ * @param index Start index to remove.
+ * @param count Number of indexes to remove.
* @return The number of ranges that were updated.
*/
public int removeIndexes(int index, int count) {
@@ -377,8 +377,8 @@ public class RangeSelection {
/**
* Ensures that the start value is less than or equal to the end value.
*
- * @param start
- * @param end
+ * @param start The new proposed start value.
+ * @param end The new proposed end.
* @return A span containing the normalized range.
*/
public static Span normalize(int start, int end) {
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/RollupListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/RollupListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/RollupListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/RollupListener.java Mon Mar 14 20:52:43 2016
@@ -45,23 +45,23 @@ public interface RollupListener {
/**
* Called when a rollup's heading component changed.
*
- * @param rollup
- * @param previousHeading
+ * @param rollup The rollup whose heading changed.
+ * @param previousHeading What the heading used to be.
*/
public void headingChanged(Rollup rollup, Component previousHeading);
/**
* Called when a rollup's content component changed.
*
- * @param rollup
- * @param previousContent
+ * @param rollup The rollup that has new content.
+ * @param previousContent What the content used to be.
*/
public void contentChanged(Rollup rollup, Component previousContent);
/**
* Called when a rollup's collapsible flag has changed.
*
- * @param rollup
+ * @param rollup The rollup that changed.
*/
public void collapsibleChanged(Rollup rollup);
}
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/RollupStateListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/RollupStateListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/RollupStateListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/RollupStateListener.java Mon Mar 14 20:52:43 2016
@@ -47,22 +47,23 @@ public interface RollupStateListener {
/**
* Called to preview a rollup expansion event.
*
- * @param rollup
+ * @param rollup The rollup that might change.
+ * @return The result of this listener voting on the expansion.
*/
public Vote previewExpandedChange(Rollup rollup);
/**
* Called when a rollup expansion event has been vetoed.
*
- * @param rollup
- * @param reason
+ * @param rollup The rollup that didn't change.
+ * @param reason The reason the expansion was vetoed.
*/
public void expandedChangeVetoed(Rollup rollup, Vote reason);
/**
* Called when a rollup's expanded state changed.
*
- * @param rollup
+ * @param rollup The rollup that did change.
*/
public void expandedChanged(Rollup rollup);
}
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/ScrollBarListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/ScrollBarListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/ScrollBarListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/ScrollBarListener.java Mon Mar 14 20:52:43 2016
@@ -49,18 +49,18 @@ public interface ScrollBarListener {
/**
* Called when a scroll bar's orientation has changed.
*
- * @param scrollBar
- * @param previousOrientation
+ * @param scrollBar The scroll bar that changed orientation.
+ * @param previousOrientation The previous orientation.
*/
public void orientationChanged(ScrollBar scrollBar, Orientation previousOrientation);
/**
* Called when a scroll bar's scope has changed.
*
- * @param scrollBar
- * @param previousStart
- * @param previousEnd
- * @param previousExtent
+ * @param scrollBar The scroll bar that changed.
+ * @param previousStart The previous start value.
+ * @param previousEnd The previous end value.
+ * @param previousExtent The previous scroll bar extent value.
*/
public void scopeChanged(ScrollBar scrollBar, int previousStart, int previousEnd,
int previousExtent);
@@ -68,16 +68,16 @@ public interface ScrollBarListener {
/**
* Called when a scroll bar's unit increment has changed.
*
- * @param scrollBar
- * @param previousUnitIncrement
+ * @param scrollBar The scroll bar that changed.
+ * @param previousUnitIncrement The previous unit increment value.
*/
public void unitIncrementChanged(ScrollBar scrollBar, int previousUnitIncrement);
/**
* Called when a scroll bar's block increment has changed.
*
- * @param scrollBar
- * @param previousBlockIncrement
+ * @param scrollBar The scroll bar that changed.
+ * @param previousBlockIncrement The previous block increment value.
*/
public void blockIncrementChanged(ScrollBar scrollBar, int previousBlockIncrement);
}
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/ScrollBarValueListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/ScrollBarValueListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/ScrollBarValueListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/ScrollBarValueListener.java Mon Mar 14 20:52:43 2016
@@ -23,8 +23,8 @@ public interface ScrollBarValueListener
/**
* Called when a scroll bar's value has changed.
*
- * @param scrollBar
- * @param previousValue
+ * @param scrollBar The scroll bar that is changing.
+ * @param previousValue The previous value of this scroll bar.
*/
public void valueChanged(ScrollBar scrollBar, int previousValue);
}
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/ScrollPaneListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/ScrollPaneListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/ScrollPaneListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/ScrollPaneListener.java Mon Mar 14 20:52:43 2016
@@ -55,8 +55,8 @@ public interface ScrollPaneListener {
/**
* Called when the scroll pane's horizontal scroll bar policy changed.
*
- * @param scrollPane
- * @param previousPolicy
+ * @param scrollPane The source of the event.
+ * @param previousPolicy The previous horizontal scroll bar policy.
*/
public void horizontalScrollBarPolicyChanged(ScrollPane scrollPane,
ScrollPane.ScrollBarPolicy previousPolicy);
@@ -64,8 +64,8 @@ public interface ScrollPaneListener {
/**
* Called when the scroll pane's vertical scroll bar policy changed.
*
- * @param scrollPane
- * @param previousPolicy
+ * @param scrollPane The source of the event.
+ * @param previousPolicy The previous vertical scroll bar policy.
*/
public void verticalScrollBarPolicyChanged(ScrollPane scrollPane,
ScrollPane.ScrollBarPolicy previousPolicy);
@@ -73,24 +73,24 @@ public interface ScrollPaneListener {
/**
* Called when the scroll pane's row header changed.
*
- * @param scrollPane
- * @param previousRowHeader
+ * @param scrollPane The source of the event.
+ * @param previousRowHeader The previous row header for this scroll pane.
*/
public void rowHeaderChanged(ScrollPane scrollPane, Component previousRowHeader);
/**
* Called when the scroll pane's column header changed.
*
- * @param scrollPane
- * @param previousColumnHeader
+ * @param scrollPane The source of the event.
+ * @param previousColumnHeader The previous column header for this scroll pane.
*/
public void columnHeaderChanged(ScrollPane scrollPane, Component previousColumnHeader);
/**
* Called when the scroll pane's corner component changed.
*
- * @param scrollPane
- * @param previousCorner
+ * @param scrollPane The source of the event.
+ * @param previousCorner The previous corner component.
*/
public void cornerChanged(ScrollPane scrollPane, Component previousCorner);
}
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/SeparatorListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/SeparatorListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/SeparatorListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/SeparatorListener.java Mon Mar 14 20:52:43 2016
@@ -23,8 +23,8 @@ public interface SeparatorListener {
/**
* Called when a separator's heading has changed.
*
- * @param separator
- * @param previousHeading
+ * @param separator The separator that changed.
+ * @param previousHeading What the heading used to be.
*/
public void headingChanged(Separator separator, String previousHeading);
}
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/SheetCloseListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/SheetCloseListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/SheetCloseListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/SheetCloseListener.java Mon Mar 14 20:52:43 2016
@@ -23,7 +23,7 @@ public interface SheetCloseListener {
/**
* Called when a sheet has closed.
*
- * @param sheet
+ * @param sheet The sheet that is now closed.
*/
public void sheetClosed(Sheet sheet);
}
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/SheetStateListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/SheetStateListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/SheetStateListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/SheetStateListener.java Mon Mar 14 20:52:43 2016
@@ -45,16 +45,17 @@ public interface SheetStateListener exte
/**
* Called to preview a sheet close event.
*
- * @param sheet
- * @param result
+ * @param sheet The source of the event.
+ * @param result The proposed result of the close.
+ * @return What this listener wants to decide about this proposed close.
*/
public Vote previewSheetClose(Sheet sheet, boolean result);
/**
* Called when a sheet close event has been vetoed.
*
- * @param sheet
- * @param reason
+ * @param sheet The close event source.
+ * @param reason The accumulated vote that resulted in the veto.
*/
public void sheetCloseVetoed(Sheet sheet, Vote reason);
}
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/SliderListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/SliderListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/SliderListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/SliderListener.java Mon Mar 14 20:52:43 2016
@@ -38,9 +38,9 @@ public interface SliderListener {
/**
* Called when a slider's range has changed.
*
- * @param slider
- * @param previousStart
- * @param previousEnd
+ * @param slider The slider that has changed.
+ * @param previousStart The previous start of the slider's range.
+ * @param previousEnd The previous end value.
*/
public void rangeChanged(Slider slider, int previousStart, int previousEnd);
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/SliderValueListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/SliderValueListener.java?rev=1734997&r1=1734996&r2=1734997&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/SliderValueListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/SliderValueListener.java Mon Mar 14 20:52:43 2016
@@ -23,8 +23,8 @@ public interface SliderValueListener {
/**
* Called when a slider's value has changed.
*
- * @param slider
- * @param previousValue
+ * @param slider The slider whose value has changed.
+ * @param previousValue What the previous value was.
*/
public void valueChanged(Slider slider, int previousValue);
}
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/Span.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/Span.java?rev=1734997&r1=1734996&r2=1734997&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/Span.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/Span.java Mon Mar 14 20:52:43 2016
@@ -181,8 +181,8 @@ public final class Span {
}
/**
- * Returns a normalized equivalent of the span in which <tt>start</tt> is
- * guaranteed to be less than end.
+ * @return A normalized equivalent of the span in which <tt>start</tt> is
+ * guaranteed to be less than <tt>end</tt>.
*/
public Span normalize() {
return new Span(Math.min(start, end), Math.max(start, end));
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/Spinner.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/Spinner.java?rev=1734997&r1=1734996&r2=1734997&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/Spinner.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/Spinner.java Mon Mar 14 20:52:43 2016
@@ -53,7 +53,7 @@ public class Spinner extends Container {
/**
* Converts a spinner item to a string representation.
*
- * @param item
+ * @param item The item from the spinner's data.
* @return The item's string representation, or <tt>null</tt> if the item
* does not have a string representation. <p> Note that this method may
* be called often during keyboard navigation, so implementations should
@@ -70,7 +70,8 @@ public class Spinner extends Container {
* Converts a context value to spinner data during a
* {@link Component#load(Object)} operation.
*
- * @param value
+ * @param value The value retrieved from the user context.
+ * @return That object converted to a list.
*/
public List<?> toSpinnerData(Object value);
@@ -78,7 +79,8 @@ public class Spinner extends Container {
* Converts spinner data to a context value during a
* {@link Component#store(Object)} operation.
*
- * @param spinnerData
+ * @param spinnerData The spinner data list.
+ * @return This list converted to data that can be stored in the user context.
*/
public Object valueOf(List<?> spinnerData);
}
@@ -112,6 +114,7 @@ public class Spinner extends Container {
*
* @param spinnerData The source spinner data.
* @param index The index of the value to retrieve.
+ * @return The item at the given index.
*/
public Object get(List<?> spinnerData, int index);
}
@@ -369,8 +372,6 @@ public class Spinner extends Container {
}
/**
- * Returns the spinner data.
- *
* @return The data currently presented by the spinner.
*/
public List<?> getSpinnerData() {
@@ -436,7 +437,7 @@ public class Spinner extends Container {
}
/**
- * Returns the item renderer used for items in this list.
+ * @return The item renderer used for items in this list.
*/
public ItemRenderer getItemRenderer() {
return itemRenderer;
@@ -445,7 +446,7 @@ public class Spinner extends Container {
/**
* Sets the item renderer to be used for items in this list.
*
- * @param itemRenderer The item renderer for the list.
+ * @param itemRenderer The new item renderer for the list.
*/
public void setItemRenderer(ItemRenderer itemRenderer) {
if (itemRenderer == null) {
@@ -461,12 +462,17 @@ public class Spinner extends Container {
}
/**
+ * @return Whether or not this spinner's values are circular.
*/
public boolean isCircular() {
return circular;
}
/**
+ * Set whether the values in this spinner wrap around from the end
+ * back to the beginning (and vice-versa).
+ *
+ * @param circular The new setting for this spinner.
*/
public void setCircular(boolean circular) {
if (circular != this.circular) {
@@ -476,8 +482,6 @@ public class Spinner extends Container {
}
/**
- * Returns the currently selected index.
- *
* @return The currently selected index.
*/
public int getSelectedIndex() {
@@ -700,28 +704,28 @@ public class Spinner extends Container {
}
/**
- * Returns the spinner listener list.
+ * @return The spinner listener list.
*/
public ListenerList<SpinnerListener> getSpinnerListeners() {
return spinnerListeners;
}
/**
- * Returns the spinner item listener list.
+ * @return The spinner item listener list.
*/
public ListenerList<SpinnerItemListener> getSpinnerItemListeners() {
return spinnerItemListeners;
}
/**
- * Returns the spinner selection listener list.
+ * @return The spinner selection listener list.
*/
public ListenerList<SpinnerSelectionListener> getSpinnerSelectionListeners() {
return spinnerSelectionListeners;
}
/**
- * Returns the spinner binding listener list.
+ * @return The spinner binding listener list.
*/
public ListenerList<SpinnerBindingListener> getSpinnerBindingListeners() {
return spinnerBindingListeners;