Author: rwhitcomb
Date: Mon Nov 2 20:06:36 2015
New Revision: 1712137
URL: http://svn.apache.org/viewvc?rev=1712137&view=rev
Log:
PIVOT-976: More Javadoc corrections to warnings found by Java 8.
This time it is the A*-D*Listener files, with a few excursions to other
files with warnings.
We're still getting >>100 warnings left....
Modified:
pivot/trunk/wtk/src/org/apache/pivot/wtk/AccordionAttributeListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/AccordionListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/AccordionSelectionListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/Action.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/ActionClassListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/ActionListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/ActivityIndicatorListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/AlertListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/BorderListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/BoxPaneListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/Button.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/ButtonBindingListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/ButtonGroupListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/ButtonListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/ButtonPressListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/ButtonStateListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/CalendarBindingListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/CalendarButtonBindingListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/CalendarButtonListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/CalendarButtonSelectionListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/CalendarListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/CalendarSelectionListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/CardPaneListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/ColorChooserBindingListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/ColorChooserButtonBindingListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/ColorChooserButtonSelectionListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/ColorChooserSelectionListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentClassListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentDataListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentDecoratorListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/Container.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/ContainerListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/ContainerMouseListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/DialogCloseListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/DialogListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/DialogStateListener.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/Renderer.java
Modified:
pivot/trunk/wtk/src/org/apache/pivot/wtk/AccordionAttributeListener.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/AccordionAttributeListener.java?rev=1712137&r1=1712136&r2=1712137&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/AccordionAttributeListener.java
(original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/AccordionAttributeListener.java
Mon Nov 2 20:06:36 2015
@@ -40,9 +40,9 @@ public interface AccordionAttributeListe
/**
* Called when a panel's header data attribute has changed.
*
- * @param accordion
- * @param component
- * @param previousHeaderData
+ * @param accordion The enclosing accordion that has changed.
+ * @param component The child component in question.
+ * @param previousHeaderData The previous header data for this component.
*/
public void headerDataChanged(Accordion accordion, Component component,
Object previousHeaderData);
@@ -50,9 +50,9 @@ public interface AccordionAttributeListe
/**
* Called when a panel's tooltip text has changed.
*
- * @param accordion
- * @param component
- * @param previousTooltipText
+ * @param accordion The enclosing accordion that has changed.
+ * @param component The child component in question.
+ * @param previousTooltipText The previous tooltip text for the component.
*/
public void tooltipTextChanged(Accordion accordion, Component component,
String previousTooltipText);
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/AccordionListener.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/AccordionListener.java?rev=1712137&r1=1712136&r2=1712137&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/AccordionListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/AccordionListener.java Mon Nov 2
20:06:36 2015
@@ -46,25 +46,25 @@ public interface AccordionListener {
/**
* Called when a panel has been inserted into a accordion's panel sequence.
*
- * @param accordion
- * @param index
+ * @param accordion The accordion that has changed.
+ * @param index The index of the newly inserted panel.
*/
public void panelInserted(Accordion accordion, int index);
/**
* Called when a panel has been removed from an accordion's panel sequence.
*
- * @param accordion
- * @param index
- * @param removed
+ * @param accordion The accordion that has changed.
+ * @param index The starting index of the panel(s) that were removed.
+ * @param removed The sequence of removed panels.
*/
public void panelsRemoved(Accordion accordion, int index,
Sequence<Component> removed);
/**
* Called when an accordion's header data renderer has changed.
*
- * @param accordion
- * @param previousHeaderDataRenderer
+ * @param accordion The accordion that was changed.
+ * @param previousHeaderDataRenderer The previous version of the header
data renderer.
*/
public void headerDataRendererChanged(Accordion accordion,
Button.DataRenderer previousHeaderDataRenderer);
Modified:
pivot/trunk/wtk/src/org/apache/pivot/wtk/AccordionSelectionListener.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/AccordionSelectionListener.java?rev=1712137&r1=1712136&r2=1712137&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/AccordionSelectionListener.java
(original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/AccordionSelectionListener.java
Mon Nov 2 20:06:36 2015
@@ -47,6 +47,7 @@ public interface AccordionSelectionListe
*
* @param accordion The source of the event.
* @param selectedIndex The index that will be selected.
+ * @return The consensus vote as to whether to allow the selected index
change.
*/
public Vote previewSelectedIndexChange(Accordion accordion, int
selectedIndex);
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/Action.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/Action.java?rev=1712137&r1=1712136&r2=1712137&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/Action.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/Action.java Mon Nov 2 20:06:36
2015
@@ -136,6 +136,8 @@ public abstract class Action {
/**
* Returns a text description of the action. Subclasses should override
this
* to return a meaningful description if one is needed.
+ *
+ * @return The text description of the action.
*/
public String getDescription() {
return null;
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/ActionClassListener.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/ActionClassListener.java?rev=1712137&r1=1712136&r2=1712137&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/ActionClassListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/ActionClassListener.java Mon Nov
2 20:06:36 2015
@@ -43,23 +43,23 @@ public interface ActionClassListener {
/**
* Called when an action has been added to the named action dictionary.
*
- * @param id
+ * @param id The identifier for the newly added action.
*/
public void actionAdded(String id);
/**
* Called when an action has been updated in the named action dictionary.
*
- * @param id
- * @param previousAction
+ * @param id The identifier for the updated action.
+ * @param previousAction The previous {@link Action} associated with this
identifier.
*/
public void actionUpdated(String id, Action previousAction);
/**
* Called when an action has been removed from the named action dictionary.
*
- * @param id
- * @param action
+ * @param id Identifier for the action that was removed.
+ * @param action The removed action.
*/
public void actionRemoved(String id, Action action);
}
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/ActionListener.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/ActionListener.java?rev=1712137&r1=1712136&r2=1712137&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/ActionListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/ActionListener.java Mon Nov 2
20:06:36 2015
@@ -23,7 +23,7 @@ public interface ActionListener {
/**
* Called when an action's enabled state has changed.
*
- * @param action
+ * @param action The action that has been enabled/disabled.
*/
public void enabledChanged(Action action);
}
Modified:
pivot/trunk/wtk/src/org/apache/pivot/wtk/ActivityIndicatorListener.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/ActivityIndicatorListener.java?rev=1712137&r1=1712136&r2=1712137&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/ActivityIndicatorListener.java
(original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/ActivityIndicatorListener.java Mon
Nov 2 20:06:36 2015
@@ -23,7 +23,7 @@ public interface ActivityIndicatorListen
/**
* Called when an activity indicator's active state has changed.
*
- * @param activityIndicator
+ * @param activityIndicator Component whose state has changed.
*/
public void activeChanged(ActivityIndicator activityIndicator);
}
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/AlertListener.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/AlertListener.java?rev=1712137&r1=1712136&r2=1712137&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/AlertListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/AlertListener.java Mon Nov 2
20:06:36 2015
@@ -60,49 +60,49 @@ public interface AlertListener {
/**
* Called when an alert's message type has changed.
*
- * @param alert
- * @param previousMessageType
+ * @param alert The alert that has changed.
+ * @param previousMessageType The previous message type for the alert.
*/
public void messageTypeChanged(Alert alert, MessageType
previousMessageType);
/**
* Called when an alert's message has changed.
*
- * @param alert
- * @param previousMessage
+ * @param alert The alert that has changed.
+ * @param previousMessage The previous message for this alert.
*/
public void messageChanged(Alert alert, String previousMessage);
/**
* Called when an alert's body has changed.
*
- * @param alert
- * @param previousBody
+ * @param alert The alert that has changed.
+ * @param previousBody The previous body for this alert.
*/
public void bodyChanged(Alert alert, Component previousBody);
/**
* Called when an option has been inserted into an alert's option sequence.
*
- * @param alert
- * @param index
+ * @param alert The alert that has changed.
+ * @param index The index where the new option was inserted.
*/
public void optionInserted(Alert alert, int index);
/**
* Called when options have been removed from an alert's option sequence.
*
- * @param alert
- * @param index
- * @param removed
+ * @param alert The alert that has changed.
+ * @param index The starting index where the options were removed.
+ * @param removed The actual sequence of the options that were removed.
*/
public void optionsRemoved(Alert alert, int index, Sequence<?> removed);
/**
* Called when an alert's selected option has changed.
*
- * @param alert
- * @param previousSelectedOption
+ * @param alert The alert that has changed.
+ * @param previousSelectedOption The index of the previously selected
option.
*/
public void selectedOptionChanged(Alert alert, int previousSelectedOption);
}
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/BorderListener.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/BorderListener.java?rev=1712137&r1=1712136&r2=1712137&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/BorderListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/BorderListener.java Mon Nov 2
20:06:36 2015
@@ -38,16 +38,16 @@ public interface BorderListener {
/**
* Called when a border's title has changed.
*
- * @param border
- * @param previousTitle
+ * @param border The border component that has changed.
+ * @param previousTitle The previous title for the border.
*/
public void titleChanged(Border border, String previousTitle);
/**
* Called when a border's content component has changed.
*
- * @param border
- * @param previousContent
+ * @param border The border that has changed.
+ * @param previousContent The previous content of the border.
*/
public void contentChanged(Border border, Component previousContent);
}
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/BoxPaneListener.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/BoxPaneListener.java?rev=1712137&r1=1712136&r2=1712137&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/BoxPaneListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/BoxPaneListener.java Mon Nov 2
20:06:36 2015
@@ -23,7 +23,7 @@ public interface BoxPaneListener {
/**
* Called when a box pane's orientation has changed.
*
- * @param boxPane
+ * @param boxPane The box pane whose orientation has changed.
*/
public void orientationChanged(BoxPane boxPane);
}
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/Button.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/Button.java?rev=1712137&r1=1712136&r2=1712137&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/Button.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/Button.java Mon Nov 2 20:06:36
2015
@@ -51,7 +51,7 @@ public abstract class Button extends Com
/**
* Converts button data to a string representation.
*
- * @param data
+ * @param data The button's data.
* @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
@@ -68,7 +68,9 @@ public abstract class Button extends Com
* Converts a context value to a selection state during a
* {@link Component#load(Object)} operation.
*
- * @param value
+ * @param value The value from the bound object that must be
+ * converted to a {@code boolean} value for the "selected" state.
+ * @return The converted value.
*/
public boolean isSelected(Object value);
@@ -76,7 +78,10 @@ public abstract class Button extends Com
* Converts a selection state to a context value during a
* {@link Component#store(Object)} operation.
*
- * @param selected
+ * @param selected The button's "selected" value which must be
+ * converted to a suitable value to store as the bound object's
+ * property.
+ * @return The converted "selected" value.
*/
public Object valueOf(boolean selected);
}
@@ -89,7 +94,9 @@ public abstract class Button extends Com
* Converts a context value to a button state during a
* {@link Component#load(Object)} operation.
*
- * @param value
+ * @param value The bound object's property value which must be
+ * converted to a button's state value.
+ * @return The converted button state.
*/
public State toState(Object value);
@@ -97,13 +104,16 @@ public abstract class Button extends Com
* Converts a button state to a context value during a
* {@link Component#store(Object)} operation.
*
- * @param state
+ * @param state The button's current state value which must be
+ * converted to a value suitable for storage in the bound object's
+ * property.
+ * @return The converted state value.
*/
public Object valueOf(State state);
}
/**
- * Translates between button buttonData and context data during data
+ * Translates between a button's buttonData and context data during data
* binding.
*/
public interface ButtonDataBindMapping {
@@ -111,7 +121,10 @@ public abstract class Button extends Com
* Converts a context value to button data during a
* {@link Component#load(Object)} operation.
*
- * @param value
+ * @param value The value returned from the bound object
+ * which must be converted to a suitable value for the
+ * button's data.
+ * @return The converted button data.
*/
public Object toButtonData(Object value);
@@ -119,7 +132,10 @@ public abstract class Button extends Com
* Converts button data to a context value during a
* {@link Component#store(Object)} operation.
*
- * @param buttonData
+ * @param buttonData The button's current button data which
+ * must be converted to a suitable value for the object's
+ * property.
+ * @return The converted value suitable for the object.
*/
public Object valueOf(Object buttonData);
}
@@ -408,7 +424,7 @@ public abstract class Button extends Com
}
/**
- * Returns the button's selected state.
+ * @return The button's selected state.
*/
public boolean isSelected() {
return (getState() == State.SELECTED);
@@ -417,23 +433,23 @@ public abstract class Button extends Com
/**
* Sets the button's selected state.
*
- * @param selected
+ * @param selected The new "selected" value.
*/
public void setSelected(boolean selected) {
setState(selected ? State.SELECTED : State.UNSELECTED);
}
/**
- * Returns the button's selection state.
+ * @return The button's selection state (for tri-state buttons).
*/
public State getState() {
return state;
}
/**
- * Sets the button's selection state.
+ * Sets the button's tri-state selection state.
*
- * @param state
+ * @param state The new button selection state.
*/
public void setState(State state) {
if (state == null) {
@@ -469,7 +485,7 @@ public abstract class Button extends Com
}
/**
- * Returns the button's toggle state.
+ * @return The button's toggle state.
*/
public boolean isToggleButton() {
return toggleButton;
@@ -478,7 +494,7 @@ public abstract class Button extends Com
/**
* Sets the button's toggle state.
*
- * @param toggleButton
+ * @param toggleButton Whether or not this should be a toggle button.
*/
public void setToggleButton(boolean toggleButton) {
if (this.toggleButton != toggleButton) {
@@ -497,7 +513,7 @@ public abstract class Button extends Com
}
/**
- * Returns the button's tri-state state.
+ * @return The button's tri-state state.
*/
public boolean isTriState() {
return triState;
@@ -506,7 +522,7 @@ public abstract class Button extends Com
/**
* Sets the button's tri-state state.
*
- * @param triState
+ * @param triState Whether or not to make this a tri-state button.
*/
public void setTriState(boolean triState) {
if (!toggleButton) {
@@ -565,10 +581,19 @@ public abstract class Button extends Com
}
}
+ /**
+ * @return The binding key used for this button's data.
+ */
public String getButtonDataKey() {
return buttonDataKey;
}
+ /**
+ * Set the binding key to use for this button's data.
+ *
+ * @param buttonDataKey The binding key for button data, which should be
+ * a field name or object "property" that supplies the button data.
+ */
public void setButtonDataKey(String buttonDataKey) {
String previousButtonDataKey = this.buttonDataKey;
if (previousButtonDataKey != buttonDataKey) {
@@ -577,6 +602,10 @@ public abstract class Button extends Com
}
}
+ /**
+ * @return The type of binding used for button data (that is "load",
"store"
+ * or "both").
+ */
public BindType getButtonDataBindType() {
return buttonDataBindType;
}
@@ -594,10 +623,21 @@ public abstract class Button extends Com
}
}
+ /**
+ * @return The bind mapping used for button data.
+ */
public ButtonDataBindMapping getButtonDataBindMapping() {
return buttonDataBindMapping;
}
+ /**
+ * Set the bind mapping used for this button's data. This is a method
that is used
+ * make a translation between the type of object needed for this button's
data and
+ * the actual data supplied by the bound object.
+ *
+ * @param buttonDataBindMapping The new mapping to use (can be {@code
null} to disable
+ * bind mapping).
+ */
public void setButtonDataBindMapping(ButtonDataBindMapping
buttonDataBindMapping) {
ButtonDataBindMapping previousButtonDataBindMapping =
this.buttonDataBindMapping;
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/ButtonBindingListener.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/ButtonBindingListener.java?rev=1712137&r1=1712136&r2=1712137&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/ButtonBindingListener.java
(original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/ButtonBindingListener.java Mon Nov
2 20:06:36 2015
@@ -76,24 +76,24 @@ public interface ButtonBindingListener {
/**
* Called when a button's buttonData key has changed.
*
- * @param button
- * @param previousButtonDataKey
+ * @param button The button that has changed.
+ * @param previousButtonDataKey The previous binding key for the button
data.
*/
public void buttonDataKeyChanged(Button button, String
previousButtonDataKey);
/**
* Called when a button's buttonData bind type has changed.
*
- * @param button
- * @param previousButtonDataBindType
+ * @param button The button that has changed.
+ * @param previousButtonDataBindType The previous bind type for the button
data.
*/
public void buttonDataBindTypeChanged(Button button, BindType
previousButtonDataBindType);
/**
* Called when a button's buttonData bind mapping has changed.
*
- * @param button
- * @param previousButtonDataBindMapping
+ * @param button The button that has changed.
+ * @param previousButtonDataBindMapping The previous bind mapping for the
button data.
*/
public void buttonDataBindMappingChanged(Button button,
Button.ButtonDataBindMapping previousButtonDataBindMapping);
@@ -101,24 +101,24 @@ public interface ButtonBindingListener {
/**
* Called when a button's selected key has changed.
*
- * @param button
- * @param previousSelectedKey
+ * @param button The button that has changed.
+ * @param previousSelectedKey The previous binding key for the selected
state.
*/
public void selectedKeyChanged(Button button, String previousSelectedKey);
/**
* Called when a button's selected bind type has changed.
*
- * @param button
- * @param previousSelectedBindType
+ * @param button The button that has changed.
+ * @param previousSelectedBindType The previous bind type for the selected
state.
*/
public void selectedBindTypeChanged(Button button, BindType
previousSelectedBindType);
/**
* Called when a button's selected bind mapping has changed.
*
- * @param button
- * @param previousSelectedBindMapping
+ * @param button The button that has changed.
+ * @param previousSelectedBindMapping The previous bind mapping for the
selected state.
*/
public void selectedBindMappingChanged(Button button,
Button.SelectedBindMapping previousSelectedBindMapping);
@@ -126,24 +126,24 @@ public interface ButtonBindingListener {
/**
* Called when a button's state key has changed.
*
- * @param button
- * @param previousStateKey
+ * @param button The button that has changed.
+ * @param previousStateKey The previous binding key for the button state.
*/
public void stateKeyChanged(Button button, String previousStateKey);
/**
* Called when a button's state bind type has changed.
*
- * @param button
- * @param previousStateBindType
+ * @param button The button that has changed.
+ * @param previousStateBindType The previous bind type for the button
state.
*/
public void stateBindTypeChanged(Button button, BindType
previousStateBindType);
/**
* Called when a button's state bind mapping has changed.
*
- * @param button
- * @param previousStateBindMapping
+ * @param button The button that has changed.
+ * @param previousStateBindMapping The previous bind mapping for the
button state.
*/
public void stateBindMappingChanged(Button button,
Button.StateBindMapping previousStateBindMapping);
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/ButtonGroupListener.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/ButtonGroupListener.java?rev=1712137&r1=1712136&r2=1712137&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/ButtonGroupListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/ButtonGroupListener.java Mon Nov
2 20:06:36 2015
@@ -43,24 +43,24 @@ public interface ButtonGroupListener {
/**
* Called when a button has been added to a button group.
*
- * @param buttonGroup
- * @param button
+ * @param buttonGroup The button group that has changed.
+ * @param button The button that was added to the group.
*/
public void buttonAdded(ButtonGroup buttonGroup, Button button);
/**
* Called when a button has been removed from a button group.
*
- * @param buttonGroup
- * @param button
+ * @param buttonGroup The button group that has changed.
+ * @param button The button that was removed from the group.
*/
public void buttonRemoved(ButtonGroup buttonGroup, Button button);
/**
* Called when a button group's selection has changed.
*
- * @param buttonGroup
- * @param previousSelection
+ * @param buttonGroup The button group that changed.
+ * @param previousSelection The previously selected button in the group.
*/
public void selectionChanged(ButtonGroup buttonGroup, Button
previousSelection);
}
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/ButtonListener.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/ButtonListener.java?rev=1712137&r1=1712136&r2=1712137&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/ButtonListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/ButtonListener.java Mon Nov 2
20:06:36 2015
@@ -58,46 +58,46 @@ public interface ButtonListener {
/**
* Called when a button's data has changed.
*
- * @param button
- * @param previousButtonData
+ * @param button The button that changed.
+ * @param previousButtonData The previous value of the button data.
*/
public void buttonDataChanged(Button button, Object previousButtonData);
/**
* Called when a button's data renderer has changed.
*
- * @param button
- * @param previousDataRenderer
+ * @param button The button that changed.
+ * @param previousDataRenderer The previous data renderer for the button.
*/
public void dataRendererChanged(Button button, Button.DataRenderer
previousDataRenderer);
/**
* Called when a button's action has changed.
*
- * @param button
- * @param previousAction
+ * @param button The button that changed.
+ * @param previousAction The previous action that was assigned to the
button.
*/
public void actionChanged(Button button, Action previousAction);
/**
* Called when a button's toggle button flag has changed.
*
- * @param button
+ * @param button The button that changed.
*/
public void toggleButtonChanged(Button button);
/**
* Called when a button's tri-state flag has changed.
*
- * @param button
+ * @param button The button that changed.
*/
public void triStateChanged(Button button);
/**
* Called when a button's button group has changed.
*
- * @param button
- * @param previousButtonGroup
+ * @param button The button whose group changed.
+ * @param previousButtonGroup The button group the button used to belong
to (can be {@code null}).
*/
public void buttonGroupChanged(Button button, ButtonGroup
previousButtonGroup);
}
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/ButtonPressListener.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/ButtonPressListener.java?rev=1712137&r1=1712136&r2=1712137&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/ButtonPressListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/ButtonPressListener.java Mon Nov
2 20:06:36 2015
@@ -23,7 +23,7 @@ public interface ButtonPressListener {
/**
* Called when a button is pressed.
*
- * @param button
+ * @param button The button that was just pressed.
*/
public void buttonPressed(Button button);
}
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/ButtonStateListener.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/ButtonStateListener.java?rev=1712137&r1=1712136&r2=1712137&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/ButtonStateListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/ButtonStateListener.java Mon Nov
2 20:06:36 2015
@@ -23,8 +23,8 @@ public interface ButtonStateListener {
/**
* Called when a button's state has changed.
*
- * @param button
- * @param previousState
+ * @param button The button whose state changed.
+ * @param previousState The previous state of the button.
*/
public void stateChanged(Button button, Button.State previousState);
}
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/CalendarBindingListener.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/CalendarBindingListener.java?rev=1712137&r1=1712136&r2=1712137&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/CalendarBindingListener.java
(original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/CalendarBindingListener.java Mon
Nov 2 20:06:36 2015
@@ -45,24 +45,24 @@ public interface CalendarBindingListener
/**
* Called when a calendar's selected date key has changed.
*
- * @param calendar
- * @param previousSelectedDateKey
+ * @param calendar The calendar that was updated.
+ * @param previousSelectedDateKey The previous bind key for the calendar's
selected date.
*/
public void selectedDateKeyChanged(Calendar calendar, String
previousSelectedDateKey);
/**
* Called when a calendar's selected date bind type has changed.
*
- * @param calendar
- * @param previousSelectedDateBindType
+ * @param calendar The calendar that has changed.
+ * @param previousSelectedDateBindType The previous bind type for the
selected date.
*/
public void selectedDateBindTypeChanged(Calendar calendar, BindType
previousSelectedDateBindType);
/**
* Called when a calendar's selected date bind mapping has changed.
*
- * @param calendar
- * @param previousSelectedDateBindMapping
+ * @param calendar The calendar that changed.
+ * @param previousSelectedDateBindMapping The previous bind mapping for
the selected date.
*/
public void selectedDateBindMappingChanged(Calendar calendar,
Calendar.SelectedDateBindMapping previousSelectedDateBindMapping);
Modified:
pivot/trunk/wtk/src/org/apache/pivot/wtk/CalendarButtonBindingListener.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/CalendarButtonBindingListener.java?rev=1712137&r1=1712136&r2=1712137&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/CalendarButtonBindingListener.java
(original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/CalendarButtonBindingListener.java
Mon Nov 2 20:06:36 2015
@@ -46,16 +46,16 @@ public interface CalendarButtonBindingLi
/**
* Called when a calendar button's selected date key has changed.
*
- * @param calendarButton
- * @param previousSelectedDateKey
+ * @param calendarButton The calendar button that changed.
+ * @param previousSelectedDateKey The previous value of the selected date
binding key.
*/
public void selectedDateKeyChanged(CalendarButton calendarButton, String
previousSelectedDateKey);
/**
* Called when a calendar button's selected date bind type has changed.
*
- * @param calendarButton
- * @param previousSelectedDateBindType
+ * @param calendarButton The calendar button that changed.
+ * @param previousSelectedDateBindType The previous bind type for the
selected date.
*/
public void selectedDateBindTypeChanged(CalendarButton calendarButton,
BindType previousSelectedDateBindType);
@@ -63,8 +63,8 @@ public interface CalendarButtonBindingLi
/**
* Called when a calendar button's selected date bind mapping has changed.
*
- * @param calendarButton
- * @param previousSelectedDateBindMapping
+ * @param calendarButton The calendar button that changed.
+ * @param previousSelectedDateBindMapping The previous bind mapping for
the selected date.
*/
public void selectedDateBindMappingChanged(CalendarButton calendarButton,
Calendar.SelectedDateBindMapping previousSelectedDateBindMapping);
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/CalendarButtonListener.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/CalendarButtonListener.java?rev=1712137&r1=1712136&r2=1712137&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/CalendarButtonListener.java
(original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/CalendarButtonListener.java Mon
Nov 2 20:06:36 2015
@@ -54,32 +54,32 @@ public interface CalendarButtonListener
/**
* Called when a calendar button's year value has changed.
*
- * @param calendarButton
- * @param previousYear
+ * @param calendarButton The calendar button that changed.
+ * @param previousYear The previously selected year.
*/
public void yearChanged(CalendarButton calendarButton, int previousYear);
/**
* Called when a calendar button's month value has changed.
*
- * @param calendarButton
- * @param previousMonth
+ * @param calendarButton The calendar button that changed.
+ * @param previousMonth The previously selected month.
*/
public void monthChanged(CalendarButton calendarButton, int previousMonth);
/**
* Called when a calendar button's locale has changed.
*
- * @param calendarButton
- * @param previousLocale
+ * @param calendarButton The calendar button that changed.
+ * @param previousLocale The previously selected locale for the calendar.
*/
public void localeChanged(CalendarButton calendarButton, Locale
previousLocale);
/**
* Called when a calendar button's disabled date filter has changed.
*
- * @param calendarButton
- * @param previousDisabledDateFilter
+ * @param calendarButton The calendar button that changed.
+ * @param previousDisabledDateFilter The previous disabled date filter.
*/
public void disabledDateFilterChanged(CalendarButton calendarButton,
Filter<CalendarDate> previousDisabledDateFilter);
Modified:
pivot/trunk/wtk/src/org/apache/pivot/wtk/CalendarButtonSelectionListener.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/CalendarButtonSelectionListener.java?rev=1712137&r1=1712136&r2=1712137&view=diff
==============================================================================
---
pivot/trunk/wtk/src/org/apache/pivot/wtk/CalendarButtonSelectionListener.java
(original)
+++
pivot/trunk/wtk/src/org/apache/pivot/wtk/CalendarButtonSelectionListener.java
Mon Nov 2 20:06:36 2015
@@ -25,8 +25,8 @@ public interface CalendarButtonSelection
/**
* Called when a calendar button's selected date has changed.
*
- * @param calendarButton
- * @param previousSelectedDate
+ * @param calendarButton The calendar button that changed.
+ * @param previousSelectedDate The date that was previously selected in
the calendar.
*/
public void selectedDateChanged(CalendarButton calendarButton,
CalendarDate previousSelectedDate);
}
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/CalendarListener.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/CalendarListener.java?rev=1712137&r1=1712136&r2=1712137&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/CalendarListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/CalendarListener.java Mon Nov 2
20:06:36 2015
@@ -54,32 +54,32 @@ public interface CalendarListener {
/**
* Called when a calendar's year value has changed.
*
- * @param calendar
- * @param previousYear
+ * @param calendar The calendar that changed.
+ * @param previousYear The previously selected year.
*/
public void yearChanged(Calendar calendar, int previousYear);
/**
* Called when a calendar's month value has changed.
*
- * @param calendar
- * @param previousMonth
+ * @param calendar The calendar that changed.
+ * @param previousMonth The previously selected month value.
*/
public void monthChanged(Calendar calendar, int previousMonth);
/**
* Called when a calendar's locale has changed.
*
- * @param calendar
- * @param previousLocale
+ * @param calendar The calendar that changed.
+ * @param previousLocale The previously selected locale for the calendar.
*/
public void localeChanged(Calendar calendar, Locale previousLocale);
/**
* Called when a calendar's disabled date filter has changed.
*
- * @param calendar
- * @param previousDisabledDateFilter
+ * @param calendar The calendar that changed.
+ * @param previousDisabledDateFilter The previous disabled date filter.
*/
public void disabledDateFilterChanged(Calendar calendar,
Filter<CalendarDate> previousDisabledDateFilter);
Modified:
pivot/trunk/wtk/src/org/apache/pivot/wtk/CalendarSelectionListener.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/CalendarSelectionListener.java?rev=1712137&r1=1712136&r2=1712137&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/CalendarSelectionListener.java
(original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/CalendarSelectionListener.java Mon
Nov 2 20:06:36 2015
@@ -25,8 +25,8 @@ public interface CalendarSelectionListen
/**
* Called when a calendar's selected date has changed.
*
- * @param calendar
- * @param previousSelectedDate
+ * @param calendar The calendar that changed.
+ * @param previousSelectedDate The previously selected date in the
calendar.
*/
public void selectedDateChanged(Calendar calendar, CalendarDate
previousSelectedDate);
}
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/CardPaneListener.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/CardPaneListener.java?rev=1712137&r1=1712136&r2=1712137&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/CardPaneListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/CardPaneListener.java Mon Nov 2
20:06:36 2015
@@ -47,6 +47,7 @@ public interface CardPaneListener {
*
* @param cardPane The source of the event.
* @param selectedIndex The index that will be selected.
+ * @return The consensus vote as to whether to allow this change.
*/
public Vote previewSelectedIndexChange(CardPane cardPane, int
selectedIndex);
Modified:
pivot/trunk/wtk/src/org/apache/pivot/wtk/ColorChooserBindingListener.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/ColorChooserBindingListener.java?rev=1712137&r1=1712136&r2=1712137&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/ColorChooserBindingListener.java
(original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/ColorChooserBindingListener.java
Mon Nov 2 20:06:36 2015
@@ -46,16 +46,16 @@ public interface ColorChooserBindingList
/**
* Called when a color chooser's selected color key has changed.
*
- * @param colorChooser
- * @param previousSelectedColorKey
+ * @param colorChooser The color chooser that has changed.
+ * @param previousSelectedColorKey The previous value of the selected
color binding key.
*/
public void selectedColorKeyChanged(ColorChooser colorChooser, String
previousSelectedColorKey);
/**
* Called when a color chooser's selected color bind type has changed.
*
- * @param colorChooser
- * @param previousSelectedColorBindType
+ * @param colorChooser The color chooser that has changed.
+ * @param previousSelectedColorBindType The previous value of the selected
color bind type.
*/
public void selectedColorBindTypeChanged(ColorChooser colorChooser,
BindType previousSelectedColorBindType);
@@ -63,8 +63,8 @@ public interface ColorChooserBindingList
/**
* Called when a color chooser's selected color bind mapping has changed.
*
- * @param colorChooser
- * @param previousSelectedColorBindMapping
+ * @param colorChooser The color chooser that has
changed.
+ * @param previousSelectedColorBindMapping The previous bind mapping for
the selected color.
*/
public void selectedColorBindMappingChanged(ColorChooser colorChooser,
ColorChooser.SelectedColorBindMapping
previousSelectedColorBindMapping);
Modified:
pivot/trunk/wtk/src/org/apache/pivot/wtk/ColorChooserButtonBindingListener.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/ColorChooserButtonBindingListener.java?rev=1712137&r1=1712136&r2=1712137&view=diff
==============================================================================
---
pivot/trunk/wtk/src/org/apache/pivot/wtk/ColorChooserButtonBindingListener.java
(original)
+++
pivot/trunk/wtk/src/org/apache/pivot/wtk/ColorChooserButtonBindingListener.java
Mon Nov 2 20:06:36 2015
@@ -46,8 +46,8 @@ public interface ColorChooserButtonBindi
/**
* Called when a color chooser button's selected color key has changed.
*
- * @param colorChooserButton
- * @param previousSelectedColorKey
+ * @param colorChooserButton The color chooser button that has
changed.
+ * @param previousSelectedColorKey The previous binding key for the
selected color.
*/
public void selectedColorKeyChanged(ColorChooserButton colorChooserButton,
String previousSelectedColorKey);
@@ -56,8 +56,8 @@ public interface ColorChooserButtonBindi
* Called when a color chooser button's selected color bind type has
* changed.
*
- * @param colorChooserButton
- * @param previousSelectedColorBindType
+ * @param colorChooserButton The color chooser button that has
changed.
+ * @param previousSelectedColorBindType The previous bind type for the
selected color.
*/
public void selectedColorBindTypeChanged(ColorChooserButton
colorChooserButton,
BindType previousSelectedColorBindType);
@@ -66,8 +66,8 @@ public interface ColorChooserButtonBindi
* Called when a color chooser button's selected color bind mapping has
* changed.
*
- * @param colorChooserButton
- * @param previousSelectedColorBindMapping
+ * @param colorChooserButton The color chooser button that
has changed.
+ * @param previousSelectedColorBindMapping The previous bind mapping for
the selected color.
*/
public void selectedColorBindMappingChanged(ColorChooserButton
colorChooserButton,
ColorChooser.SelectedColorBindMapping
previousSelectedColorBindMapping);
Modified:
pivot/trunk/wtk/src/org/apache/pivot/wtk/ColorChooserButtonSelectionListener.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/ColorChooserButtonSelectionListener.java?rev=1712137&r1=1712136&r2=1712137&view=diff
==============================================================================
---
pivot/trunk/wtk/src/org/apache/pivot/wtk/ColorChooserButtonSelectionListener.java
(original)
+++
pivot/trunk/wtk/src/org/apache/pivot/wtk/ColorChooserButtonSelectionListener.java
Mon Nov 2 20:06:36 2015
@@ -25,8 +25,8 @@ public interface ColorChooserButtonSelec
/**
* Called when a color chooser button's selected color has changed.
*
- * @param colorChooserButton
- * @param previousSelectedColor
+ * @param colorChooserButton The color chooser button that changed.
+ * @param previousSelectedColor The previously selected color.
*/
public void selectedColorChanged(ColorChooserButton colorChooserButton,
Color previousSelectedColor);
Modified:
pivot/trunk/wtk/src/org/apache/pivot/wtk/ColorChooserSelectionListener.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/ColorChooserSelectionListener.java?rev=1712137&r1=1712136&r2=1712137&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/ColorChooserSelectionListener.java
(original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/ColorChooserSelectionListener.java
Mon Nov 2 20:06:36 2015
@@ -25,8 +25,8 @@ public interface ColorChooserSelectionLi
/**
* Called when a color chooser's selected color has changed.
*
- * @param colorChooser
- * @param previousSelectedColor
+ * @param colorChooser The color chooser that has changed.
+ * @param previousSelectedColor The previously selected color in the
chooser.
*/
public void selectedColorChanged(ColorChooser colorChooser, Color
previousSelectedColor);
}
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentClassListener.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentClassListener.java?rev=1712137&r1=1712136&r2=1712137&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentClassListener.java
(original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentClassListener.java Mon
Nov 2 20:06:36 2015
@@ -23,7 +23,7 @@ public interface ComponentClassListener
/**
* Called when the focused component changes.
*
- * @param previousFocusedComponent
+ * @param previousFocusedComponent The component that previously had the
focus (can be {@code null}).
*/
public void focusedComponentChanged(Component previousFocusedComponent);
}
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentDataListener.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentDataListener.java?rev=1712137&r1=1712136&r2=1712137&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentDataListener.java
(original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentDataListener.java Mon Nov
2 20:06:36 2015
@@ -43,8 +43,8 @@ public interface ComponentDataListener {
/**
* Called when a value has been added to a component's user data
dictionary.
*
- * @param component
- * @param key
+ * @param component The component that has changed.
+ * @param key The key for the key/value pair that was added to this
component's data dictionary.
*/
public void valueAdded(Component component, String key);
@@ -52,9 +52,9 @@ public interface ComponentDataListener {
* Called when a value has been updated in a component's user data
* dictionary.
*
- * @param component
- * @param key
- * @param previousValue
+ * @param component The component that has changed.
+ * @param key The key for the value that has been updated.
+ * @param previousValue The previous value for this key.
*/
public void valueUpdated(Component component, String key, Object
previousValue);
@@ -62,9 +62,9 @@ public interface ComponentDataListener {
* Called when a value has been removed from a component's user data
* dictionary.
*
- * @param component
- * @param key
- * @param value
+ * @param component The component that has changed.
+ * @param key The key for the key/value pair that has been removed.
+ * @param value The corresponding value that was removed.
*/
public void valueRemoved(Component component, String key, Object value);
}
Modified:
pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentDecoratorListener.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentDecoratorListener.java?rev=1712137&r1=1712136&r2=1712137&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentDecoratorListener.java
(original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/ComponentDecoratorListener.java
Mon Nov 2 20:06:36 2015
@@ -47,8 +47,8 @@ public interface ComponentDecoratorListe
* Called when a decorator has been inserted into a component's decorator
* sequence.
*
- * @param component
- * @param index
+ * @param component The component that has changed.
+ * @param index The starting index of the decorator that has been
inserted.
*/
public void decoratorInserted(Component component, int index);
@@ -56,9 +56,9 @@ public interface ComponentDecoratorListe
* Called when a decorator has been updated in a component's decorator
* sequence.
*
- * @param component
- * @param index
- * @param previousDecorator
+ * @param component The component that has changed.
+ * @param index The index of the decorator that has been
updated.
+ * @param previousDecorator The previous decorator at that index.
*/
public void decoratorUpdated(Component component, int index, Decorator
previousDecorator);
@@ -66,9 +66,9 @@ public interface ComponentDecoratorListe
* Called when decorators have been removed from a component's decorator
* sequence.
*
- * @param component
- * @param index
- * @param decorators
+ * @param component The component that has changed.
+ * @param index The starting index where decorators were removed.
+ * @param decorators The complete sequence of decorators that were removed.
*/
public void decoratorsRemoved(Component component, int index,
Sequence<Decorator> decorators);
}
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/Container.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/Container.java?rev=1712137&r1=1712136&r2=1712137&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/Container.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/Container.java Mon Nov 2 20:06:36
2015
@@ -220,8 +220,8 @@ public abstract class Container extends
/**
* Moves a component within the component sequence.
*
- * @param from
- * @param to
+ * @param from The index where the component is currently located.
+ * @param to The index to move it to.
*/
public void move(int from, int to) {
assertEventDispatchThread();
@@ -521,6 +521,7 @@ public abstract class Container extends
*
* @param component The component from which focus will be transferred.
* @param direction The direction in which to transfer focus.
+ * @return The newly focused component.
*/
public Component transferFocus(Component component,
FocusTraversalDirection direction) {
Component componentUpdated = component;
@@ -554,7 +555,7 @@ public abstract class Container extends
}
/**
- * Returns this container's focus traversal policy.
+ * @return This container's focus traversal policy.
*/
public FocusTraversalPolicy getFocusTraversalPolicy() {
return this.focusTraversalPolicy;
@@ -622,7 +623,7 @@ public abstract class Container extends
/**
* Propagates binding to subcomponents.
*
- * @param context
+ * @param context The object we're binding to.
*/
@Override
public void load(Object context) {
@@ -634,7 +635,7 @@ public abstract class Container extends
/**
* Propagates binding to subcomponents.
*
- * @param context
+ * @param context The object we're binding to.
*/
@Override
public void store(Object context) {
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/ContainerListener.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/ContainerListener.java?rev=1712137&r1=1712136&r2=1712137&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/ContainerListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/ContainerListener.java Mon Nov 2
20:06:36 2015
@@ -52,8 +52,8 @@ public interface ContainerListener {
* Called when a component has been inserted into a container's component
* sequence.
*
- * @param container
- * @param index
+ * @param container The container that has changed.
+ * @param index The index where the new component has been inserted.
*/
public void componentInserted(Container container, int index);
@@ -61,9 +61,9 @@ public interface ContainerListener {
* Called when components have been removed from a container's component
* sequence.
*
- * @param container
- * @param index
- * @param removed
+ * @param container The container that has changed.
+ * @param index The starting index of the components that were removed.
+ * @param removed The complete sequence of removed components.
*/
public void componentsRemoved(Container container, int index,
Sequence<Component> removed);
@@ -71,17 +71,17 @@ public interface ContainerListener {
* Called when a component has moved from one z-index to another within a
* container.
*
- * @param container
- * @param from
- * @param to
+ * @param container The container that has changed.
+ * @param from The starting index of the component (in Z-order).
+ * @param to The place in the Z-order where this component ended up.
*/
public void componentMoved(Container container, int from, int to);
/**
* Called when a container's focus traversal policy has changed.
*
- * @param container
- * @param previousFocusTraversalPolicy
+ * @param container The container that has changed.
+ * @param previousFocusTraversalPolicy The previous value of the focus
traversal policy for this container.
*/
public void focusTraversalPolicyChanged(Container container,
FocusTraversalPolicy previousFocusTraversalPolicy);
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/ContainerMouseListener.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/ContainerMouseListener.java?rev=1712137&r1=1712136&r2=1712137&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/ContainerMouseListener.java
(original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/ContainerMouseListener.java Mon
Nov 2 20:06:36 2015
@@ -50,9 +50,9 @@ public interface ContainerMouseListener
/**
* Called when the mouse is moved over a container.
*
- * @param container
- * @param x
- * @param y
+ * @param container The container under the mouse.
+ * @param x The X-position of the mouse.
+ * @param y The Y-position of the mouse.
* @return <tt>true</tt> to consume the event; <tt>false</tt> to allow it
to
* propagate.
*/
@@ -61,10 +61,10 @@ public interface ContainerMouseListener
/**
* Called when the mouse is pressed over a container.
*
- * @param container
- * @param button
- * @param x
- * @param y
+ * @param container The container under the mouse.
+ * @param button Which button was pressed.
+ * @param x The X-position of the mouse.
+ * @param y The Y-position of the mouse.
* @return <tt>true</tt> to consume the event; <tt>false</tt> to allow it
to
* propagate.
*/
@@ -73,10 +73,10 @@ public interface ContainerMouseListener
/**
* Called when the mouse is released over a container.
*
- * @param container
- * @param button
- * @param x
- * @param y
+ * @param container The container under the mouse.
+ * @param button Which mouse button was released.
+ * @param x The X-position at the time of release.
+ * @param y The Y-position at the time of release.
* @return <tt>true</tt> to consume the event; <tt>false</tt> to allow it
to
* propagate.
*/
@@ -85,12 +85,12 @@ public interface ContainerMouseListener
/**
* Called when the mouse wheel is scrolled over a container.
*
- * @param container
- * @param scrollType
- * @param scrollAmount
- * @param wheelRotation
- * @param x
- * @param y
+ * @param container The container under the mouse.
+ * @param scrollType Which type of scroll happened.
+ * @param scrollAmount How much scrolling was requested.
+ * @param wheelRotation The amount and direction of wheel rotation.
+ * @param x The X-position of the mouse at the time.
+ * @param y The Y-position of the mouse.
* @return <tt>true</tt> to consume the event; <tt>false</tt> to allow it
to
* propagate.
*/
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/DialogCloseListener.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/DialogCloseListener.java?rev=1712137&r1=1712136&r2=1712137&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/DialogCloseListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/DialogCloseListener.java Mon Nov
2 20:06:36 2015
@@ -23,7 +23,8 @@ public interface DialogCloseListener {
/**
* Called when a dialog has closed.
*
- * @param dialog
+ * @param dialog The dialog that has been closed.
+ * @param modal Whether this was a modal dialog or not.
*/
public void dialogClosed(Dialog dialog, boolean modal);
}
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/DialogListener.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/DialogListener.java?rev=1712137&r1=1712136&r2=1712137&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/DialogListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/DialogListener.java Mon Nov 2
20:06:36 2015
@@ -23,7 +23,7 @@ public interface DialogListener {
/**
* Called when a dialog's modal flag has changed.
*
- * @param dialog
+ * @param dialog The dialog that has changed.
*/
public void modalChanged(Dialog dialog);
}
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/DialogStateListener.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/DialogStateListener.java?rev=1712137&r1=1712136&r2=1712137&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/DialogStateListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/DialogStateListener.java Mon Nov
2 20:06:36 2015
@@ -45,16 +45,17 @@ public interface DialogStateListener ext
/**
* Called to preview a dialog close event.
*
- * @param dialog
- * @param result
+ * @param dialog The dialog that is requesting to close.
+ * @param result The result flag ({@code true} means "OK", while {@code
false} roughly means "Cancel").
+ * @return The consensus vote as to whether or not to allow the
close to occur.
*/
public Vote previewDialogClose(Dialog dialog, boolean result);
/**
* Called when a dialog close event has been vetoed.
*
- * @param dialog
- * @param reason
+ * @param dialog The dialog that is not going to close because of this
veto.
+ * @param reason The vote result that indicates the veto.
*/
public void dialogCloseVetoed(Dialog dialog, Vote reason);
}
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/Renderer.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/Renderer.java?rev=1712137&r1=1712136&r2=1712137&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/Renderer.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/Renderer.java Mon Nov 2 20:06:36
2015
@@ -67,7 +67,7 @@ import org.apache.pivot.collections.Dict
*/
public interface Renderer extends ConstrainedVisual {
/**
- * Returns the renderer's style dictionary.
+ * @return The renderer's style dictionary.
*/
public Dictionary<String, Object> getStyles();
}
