Author: rwhitcomb Date: Mon May 2 17:18:33 2016 New Revision: 1742009 URL: http://svn.apache.org/viewvc?rev=1742009&view=rev Log: PIVOT-976: More Javadoc fixes for the warnings from Java 8.
Continuing on down the list, basically, to finish off the "Listener" classes, and a few others along the way. Almost all are descriptions for @param elements that were listed but had no descriptions. Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TabPaneAttributeListener.java pivot/trunk/wtk/src/org/apache/pivot/wtk/TabPaneListener.java pivot/trunk/wtk/src/org/apache/pivot/wtk/TabPaneSelectionListener.java pivot/trunk/wtk/src/org/apache/pivot/wtk/TextArea.java pivot/trunk/wtk/src/org/apache/pivot/wtk/TextAreaBindingListener.java pivot/trunk/wtk/src/org/apache/pivot/wtk/TextAreaListener.java pivot/trunk/wtk/src/org/apache/pivot/wtk/TextAreaSelectionListener.java pivot/trunk/wtk/src/org/apache/pivot/wtk/TextInput.java pivot/trunk/wtk/src/org/apache/pivot/wtk/TextInputBindingListener.java pivot/trunk/wtk/src/org/apache/pivot/wtk/TextInputContentListener.java pivot/trunk/wtk/src/org/apache/pivot/wtk/TextInputListener.java pivot/trunk/wtk/src/org/apache/pivot/wtk/TextPaneCharacterListener.java pivot/trunk/wtk/src/org/apache/pivot/wtk/TextPaneListener.java pivot/trunk/wtk/src/org/apache/pivot/wtk/TextPaneSelectionListener.java pivot/trunk/wtk/src/org/apache/pivot/wtk/Theme.java pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeView.java pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewBranchListener.java pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewListener.java pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewNodeListener.java pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewNodeStateListener.java pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewSelectionListener.java pivot/trunk/wtk/src/org/apache/pivot/wtk/VFSBrowserListener.java pivot/trunk/wtk/src/org/apache/pivot/wtk/VFSBrowserSheetListener.java pivot/trunk/wtk/src/org/apache/pivot/wtk/Viewport.java pivot/trunk/wtk/src/org/apache/pivot/wtk/ViewportListener.java pivot/trunk/wtk/src/org/apache/pivot/wtk/WindowActionMappingListener.java pivot/trunk/wtk/src/org/apache/pivot/wtk/WindowClassListener.java pivot/trunk/wtk/src/org/apache/pivot/wtk/WindowListener.java pivot/trunk/wtk/src/org/apache/pivot/wtk/WindowStateListener.java Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TabPaneAttributeListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TabPaneAttributeListener.java?rev=1742009&r1=1742008&r2=1742009&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/TabPaneAttributeListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TabPaneAttributeListener.java Mon May 2 17:18:33 2016 @@ -48,8 +48,9 @@ public interface TabPaneAttributeListene /** * Called when a tab's tooltipText attribute has changed. * - * @param tabPane - * @param component + * @param tabPane The source of this event. + * @param component The actual tab component whose tooltip was changed. + * @param previousTooltipText What the text used to be. */ public void tooltipTextChanged(TabPane tabPane, Component component, String previousTooltipText); } Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TabPaneListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TabPaneListener.java?rev=1742009&r1=1742008&r2=1742009&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/TabPaneListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TabPaneListener.java Mon May 2 17:18:33 2016 @@ -72,64 +72,65 @@ public interface TabPaneListener { /** * Called when a tab has been inserted into a tab pane's tab sequence. * - * @param tabPane - * @param index + * @param tabPane The source of this event. + * @param index Where the newly inserted tab was placed. */ public void tabInserted(TabPane tabPane, int index); /** * Called to preview a tab removal. * - * @param tabPane - * @param index - * @param count + * @param tabPane The component that wants to change. + * @param index The proposed starting index of the tab or tabs to be removed. + * @param count The count of tabs to remove. + * @return Whether or not to accept this tab removal (or defer it). */ public Vote previewRemoveTabs(TabPane tabPane, int index, int count); /** * Called when a tab removal has been vetoed. * - * @param tabPane - * @param reason + * @param tabPane The source of this event. + * @param reason The vote result that vetoed the tab removal. */ public void removeTabsVetoed(TabPane tabPane, Vote reason); /** * Called when a tab has been removed from a tab pane's tab sequence. * - * @param tabPane - * @param index - * @param tabs + * @param tabPane The source of this event. + * @param index The starting location of the tabs that were removed. + * @param tabs The actual sequence of tab components that were removed. */ public void tabsRemoved(TabPane tabPane, int index, Sequence<Component> tabs); /** * Called when a tab pane's corner component has changed. * - * @param tabPane - * @param previousCorner + * @param tabPane The component that changed. + * @param previousCorner What the corner component used to be. */ public void cornerChanged(TabPane tabPane, Component previousCorner); /** * Called when a tab pane's tab data renderer has changed. * - * @param tabPane - * @param previousTabDataRenderer + * @param tabPane The source of this event. + * @param previousTabDataRenderer The previous renderer for the tab data. */ public void tabDataRendererChanged(TabPane tabPane, Button.DataRenderer previousTabDataRenderer); /** * Called when a tab pane's closeable property has changed. * - * @param tabPane + * @param tabPane The component that changed. */ public void closeableChanged(TabPane tabPane); /** * Called when a tab pane's collapsible property has changed. * - * @param tabPane + * @param tabPane The source of this event. */ public void collapsibleChanged(TabPane tabPane); } Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TabPaneSelectionListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TabPaneSelectionListener.java?rev=1742009&r1=1742008&r2=1742009&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/TabPaneSelectionListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TabPaneSelectionListener.java Mon May 2 17:18:33 2016 @@ -47,6 +47,7 @@ public interface TabPaneSelectionListene * * @param tabPane The source of the event. * @param selectedIndex The index that will be selected. + * @return The vote result as to whether to accept this selected index change. */ public Vote previewSelectedIndexChange(TabPane tabPane, int selectedIndex); Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TextArea.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TextArea.java?rev=1742009&r1=1742008&r2=1742009&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/TextArea.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TextArea.java Mon May 2 17:18:33 2016 @@ -220,58 +220,58 @@ public class TextArea extends Component /** * Returns the insertion point for a given location. * - * @param x - * @param y + * @param x The X-location to check (likely from the mouse location). + * @param y The Y-location to check. */ public int getInsertionPoint(int x, int y); /** - * Returns the next insertion point given an x coordinate and a + * @return The next insertion point given an x coordinate and a * character index. * - * @param x - * @param from - * @param direction + * @param x The current X-location. + * @param from The current character index to move from. + * @param direction The direction we want to move. */ public int getNextInsertionPoint(int x, int from, ScrollDirection direction); /** - * Returns the row index of the character at a given index. + * @return The row index of the character at a given index. * - * @param index + * @param index The character index to check. */ public int getRowAt(int index); /** - * Returns the index of the first character in the row containing a + * @return The index of the first character in the row containing a * given character index. * - * @param index + * @param index The character index to check. */ public int getRowOffset(int index); /** - * Returns the number of characters in the row containing a given + * @return The number of characters in the row containing a given * character index. * - * @param index + * @param index The character index to check. */ public int getRowLength(int index); /** - * Returns the total number of rows in the text area. + * @return The total number of rows in the text area. */ public int getRowCount(); /** - * Returns the bounds of the character at a given index. + * @return The bounds of the character at a given index. * - * @param index + * @param index The index of the character to check. */ public Bounds getCharacterBounds(int index); /** - * Returns the current setting of the "tabWidth" style (so "setText" + * @return The current setting of the "tabWidth" style (so "setText" * uses the same value as Ctrl-Tab from user). */ public int getTabWidth(); @@ -285,7 +285,8 @@ public class TextArea extends Component * Converts a value from the bind context to a text representation * during a {@link Component#load(Object)} operation. * - * @param value + * @param value The value from the bind context to convert to text. + * @return The string representation of the value to display. */ public String toString(Object value); @@ -293,7 +294,9 @@ public class TextArea extends Component * Converts a text string to a value to be stored in the bind context * during a {@link Component#store(Object)} operation. * - * @param text + * @param text The current text from the control to convert to an object + * suitable for storage in the bind context. + * @return The text converted to an object suitable for the bind context. */ public Object valueOf(String text); } Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TextAreaBindingListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TextAreaBindingListener.java?rev=1742009&r1=1742008&r2=1742009&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/TextAreaBindingListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TextAreaBindingListener.java Mon May 2 17:18:33 2016 @@ -44,24 +44,24 @@ public interface TextAreaBindingListener /** * Called when a text area's text key has changed. * - * @param textArea - * @param previousTextKey + * @param textArea The component that has changed. + * @param previousTextKey What the text key used to be for this component. */ public void textKeyChanged(TextArea textArea, String previousTextKey); /** * Called when a text area's text bind type has changed. * - * @param textArea - * @param previousTextBindType + * @param textArea The source of this event. + * @param previousTextBindType The previous bind type for this component. */ public void textBindTypeChanged(TextArea textArea, BindType previousTextBindType); /** * Called when a text area's text bind mapping has changed. * - * @param textArea - * @param previousTextBindMapping + * @param textArea The source of this event. + * @param previousTextBindMapping The previous bind mapping for this component. */ public void textBindMappingChanged(TextArea textArea, TextArea.TextBindMapping previousTextBindMapping); Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TextAreaListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TextAreaListener.java?rev=1742009&r1=1742008&r2=1742009&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/TextAreaListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TextAreaListener.java Mon May 2 17:18:33 2016 @@ -38,15 +38,15 @@ public interface TextAreaListener { /** * Called when a text area's maximum length has changed. * - * @param textArea - * @param previousMaximumLength + * @param textArea The source of this event. + * @param previousMaximumLength What the maximum length used to be. */ public void maximumLengthChanged(TextArea textArea, int previousMaximumLength); /** * Called when a text area's editable state has changed. * - * @param textArea + * @param textArea The source of this event. */ public void editableChanged(TextArea textArea); } Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TextAreaSelectionListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TextAreaSelectionListener.java?rev=1742009&r1=1742008&r2=1742009&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/TextAreaSelectionListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TextAreaSelectionListener.java Mon May 2 17:18:33 2016 @@ -23,9 +23,9 @@ public interface TextAreaSelectionListen /** * Called when a text area's selection state has changed. * - * @param textArea - * @param previousSelectionStart - * @param previousSelectionLength + * @param textArea The source of this event. + * @param previousSelectionStart Where the selection used to start. + * @param previousSelectionLength The previous selection length. */ public void selectionChanged(TextArea textArea, int previousSelectionStart, int previousSelectionLength); Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TextInput.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TextInput.java?rev=1742009&r1=1742008&r2=1742009&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/TextInput.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TextInput.java Mon May 2 17:18:33 2016 @@ -35,16 +35,16 @@ public class TextInput extends Component */ public interface Skin { /** - * Returns the insertion point for a given location. + * @return The insertion point for a given location. * - * @param x + * @param x The X-position (of the mouse probably). */ public int getInsertionPoint(int x); /** - * Returns the bounds of the character at a given index. + * @return The bounds of the character at a given index. * - * @param index + * @param index The location to check. */ public Bounds getCharacterBounds(int index); } @@ -57,7 +57,8 @@ public class TextInput extends Component * Converts a value from the bind context to a text representation * during a {@link Component#load(Object)} operation. * - * @param value + * @param value The value retrieved from the bound object. + * @return A text representation of this value for display. */ public String toString(Object value); @@ -65,7 +66,8 @@ public class TextInput extends Component * Converts a text string to a value to be stored in the bind context * during a {@link Component#store(Object)} operation. * - * @param text + * @param text The current text from the control. + * @return A value suitable for storage in the bound object. */ public Object valueOf(String text); } @@ -316,8 +318,8 @@ public class TextInput extends Component /** * Returns a portion of the text content of the text input. * - * @param beginIndex - * @param endIndex + * @param beginIndex The starting index of the text to retrieve (inclusive). + * @param endIndex The ending index of the text (exclusive). * @return A string containing a copy of the text area's text content. */ public String getText(int beginIndex, int endIndex) { @@ -461,23 +463,23 @@ public class TextInput extends Component } /** - * Returns a character sequence representing the text input's content. + * @return A character sequence representing the text input's content. */ public CharSequence getCharacters() { return characters; } /** - * Returns the character at a given index. + * @return The character at a given index. * - * @param index + * @param index Location of the character to retrieve. */ public char getCharacterAt(int index) { return characters.charAt(index); } /** - * Returns the number of characters in the text input. + * @return The number of characters in the text input. */ public int getCharacterCount() { return characters.length(); @@ -549,8 +551,6 @@ public class TextInput extends Component } /** - * Returns the starting index of the selection. - * * @return The starting index of the selection. */ public int getSelectionStart() { @@ -558,8 +558,6 @@ public class TextInput extends Component } /** - * Returns the length of the selection. - * * @return The length of the selection; may be <tt>0</tt>. */ public int getSelectionLength() { @@ -609,8 +607,9 @@ public class TextInput extends Component /** * Sets the selection. * - * @param selection + * @param selection The span (start inclusive to end inclusive). * @see #setSelection(int, int) + * @throws IllegalArgumentException if the selection span is {@code null}. */ public final void setSelection(Span selection) { if (selection == null) { @@ -656,6 +655,7 @@ public class TextInput extends Component * Sets the text size. * * @param textSize The number of characters to display in the text input. + * @throws IllegalArgumentException if the size value is negative. */ public void setTextSize(int textSize) { if (textSize < 0) { @@ -683,6 +683,7 @@ public class TextInput extends Component * Sets the maximum length of the text input's text content. * * @param maximumLength The maximum length of the text input's text content. + * @throws IllegalArgumentException if the length value is negative. */ public void setMaximumLength(int maximumLength) { if (maximumLength < 0) { @@ -734,7 +735,7 @@ public class TextInput extends Component } /** - * Returns the text input's prompt. + * @return The text input's prompt. */ public String getPrompt() { return prompt; @@ -849,7 +850,7 @@ public class TextInput extends Component } /** - * Gets the validator associated with this text input. + * @return The validator associated with this text input. */ public Validator getValidator() { return validator; @@ -883,7 +884,7 @@ public class TextInput extends Component } /** - * Returns the text input's strict validation flag. + * @return The text input's strict validation flag. */ public boolean isStrictValidation() { return strictValidation; @@ -893,7 +894,7 @@ public class TextInput extends Component * Sets the text input's strict validation flag. When enabled, only valid * text will be accepted by the text input. * - * @param strictValidation + * @param strictValidation The new flag setting. */ public void setStrictValidation(boolean strictValidation) { if (this.strictValidation != strictValidation) { @@ -914,7 +915,7 @@ public class TextInput extends Component } /** - * Returns the text area's editable flag. + * @return The text area's editable flag. */ public boolean isEditable() { return editable; @@ -923,7 +924,7 @@ public class TextInput extends Component /** * Sets the text area's editable flag. * - * @param editable + * @param editable The new flag setting. */ public void setEditable(boolean editable) { if (this.editable != editable) { @@ -940,28 +941,28 @@ public class TextInput extends Component } /** - * Returns the text input listener list. + * @return The text input listener list. */ public ListenerList<TextInputListener> getTextInputListeners() { return textInputListeners; } /** - * Returns the text input text listener list. + * @return The text input content listener list. */ public ListenerList<TextInputContentListener> getTextInputContentListeners() { return textInputContentListeners; } /** - * Returns the text input selection listener list. + * @return The text input selection listener list. */ public ListenerList<TextInputSelectionListener> getTextInputSelectionListeners() { return textInputSelectionListeners; } /** - * Returns the text input binding listener list. + * @return The text input binding listener list. */ public ListenerList<TextInputBindingListener> getTextInputBindingListeners() { return textInputBindingListeners; Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TextInputBindingListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TextInputBindingListener.java?rev=1742009&r1=1742008&r2=1742009&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/TextInputBindingListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TextInputBindingListener.java Mon May 2 17:18:33 2016 @@ -44,24 +44,24 @@ public interface TextInputBindingListene /** * Called when a text input's text key has changed. * - * @param textInput - * @param previousTextKey + * @param textInput The source of this event. + * @param previousTextKey The previous text key for the component. */ public void textKeyChanged(TextInput textInput, String previousTextKey); /** * Called when a text input's text bind type has changed. * - * @param textInput - * @param previousTextBindType + * @param textInput The source of this event. + * @param previousTextBindType The previous bind type for this component. */ public void textBindTypeChanged(TextInput textInput, BindType previousTextBindType); /** * Called when a text input's text bind mapping has changed. * - * @param textInput - * @param previousTextBindMapping + * @param textInput The source of this event. + * @param previousTextBindMapping The previous bind mapping for this component. */ public void textBindMappingChanged(TextInput textInput, TextInput.TextBindMapping previousTextBindMapping); Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TextInputContentListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TextInputContentListener.java?rev=1742009&r1=1742008&r2=1742009&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/TextInputContentListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TextInputContentListener.java Mon May 2 17:18:33 2016 @@ -68,6 +68,7 @@ public interface TextInputContentListene * @param textInput The source of the event. * @param text The text that will be inserted. * @param index The index at which the text will be inserted. + * @return The accumulated vote as to whether to allow this insertion. */ public Vote previewInsertText(TextInput textInput, CharSequence text, int index); @@ -93,6 +94,8 @@ public interface TextInputContentListene * * @param textInput The source of the event. * @param index The starting index from which the text will be removed. + * @param count The count of characters to be removed starting from that index. + * @return The accumulated vote as to whether to allow this removal. */ public Vote previewRemoveText(TextInput textInput, int index, int count); Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TextInputListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TextInputListener.java?rev=1742009&r1=1742008&r2=1742009&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/TextInputListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TextInputListener.java Mon May 2 17:18:33 2016 @@ -70,60 +70,60 @@ public interface TextInputListener { /** * Called when a text input's text size has changed. * - * @param textInput - * @param previousTextSize + * @param textInput The source of this event. + * @param previousTextSize The previous text size for the control */ public void textSizeChanged(TextInput textInput, int previousTextSize); /** * Called when a text input's maximum length has changed. * - * @param textInput - * @param previousMaximumLength + * @param textInput The source of this event. + * @param previousMaximumLength The previous maximum text length. */ public void maximumLengthChanged(TextInput textInput, int previousMaximumLength); /** * Called when a text input's password flag has changed. * - * @param textInput + * @param textInput The source of this event. */ public void passwordChanged(TextInput textInput); /** * Called when a text input's prompt has changed. * - * @param textInput - * @param previousPrompt + * @param textInput The source of this event. + * @param previousPrompt The previous prompt string. */ public void promptChanged(TextInput textInput, String previousPrompt); /** * Called when the validator changes. * - * @param textInput - * @param previousValidator + * @param textInput The source of this event. + * @param previousValidator The previous validator for the text. */ public void textValidatorChanged(TextInput textInput, Validator previousValidator); /** * Called when a text input's strict validation flag has changed. * - * @param textInput + * @param textInput The text input that has changed. */ public void strictValidationChanged(TextInput textInput); /** * Called when the text changes validity. * - * @param textInput + * @param textInput The text input that has been changed. */ public void textValidChanged(TextInput textInput); /** * Called when the editable state has changed. * - * @param textInput + * @param textInput The text input whose state has changed. */ public void editableChanged(TextInput textInput); Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TextPaneCharacterListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TextPaneCharacterListener.java?rev=1742009&r1=1742008&r2=1742009&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/TextPaneCharacterListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TextPaneCharacterListener.java Mon May 2 17:18:33 2016 @@ -38,18 +38,18 @@ public interface TextPaneCharacterListen /** * Called when characters have been inserted into a text pane. * - * @param textPane - * @param index - * @param count + * @param textPane The text pane whose text has changed. + * @param index The starting point of the text insertion. + * @param count The count of characters inserted there. */ public void charactersInserted(TextPane textPane, int index, int count); /** * Called when characters have been removed from a text pane. * - * @param textPane - * @param index - * @param count + * @param textPane The text pane whose text has changed. + * @param index The starting point where text was removed. + * @param count Number of characters removed starting from there. */ public void charactersRemoved(TextPane textPane, int index, int count); } Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TextPaneListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TextPaneListener.java?rev=1742009&r1=1742008&r2=1742009&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/TextPaneListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TextPaneListener.java Mon May 2 17:18:33 2016 @@ -40,15 +40,15 @@ public interface TextPaneListener { /** * Called when a text pane's document has changed. * - * @param textPane - * @param previousDocument + * @param textPane The text pane that changed. + * @param previousDocument What the document used to be. */ public void documentChanged(TextPane textPane, Document previousDocument); /** * Called when a text pane's editable state has changed. * - * @param textPane + * @param textPane The source of this event. */ public void editableChanged(TextPane textPane); } Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TextPaneSelectionListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TextPaneSelectionListener.java?rev=1742009&r1=1742008&r2=1742009&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/TextPaneSelectionListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TextPaneSelectionListener.java Mon May 2 17:18:33 2016 @@ -23,9 +23,9 @@ public interface TextPaneSelectionListen /** * Called when a text pane's selection state has changed. * - * @param textPane - * @param previousSelectionStart - * @param previousSelectionLength + * @param textPane The source of this event. + * @param previousSelectionStart The offset where the selection used to start. + * @param previousSelectionLength What the selection length was previously. */ public void selectionChanged(TextPane textPane, int previousSelectionStart, int previousSelectionLength); Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/Theme.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/Theme.java?rev=1742009&r1=1742008&r2=1742009&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/Theme.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/Theme.java Mon May 2 17:18:33 2016 @@ -105,21 +105,21 @@ public abstract class Theme { } /** - * Gets the theme's font. + * @return The theme's font. */ public abstract Font getFont(); /** * Sets the theme's font. * - * @param font the font + * @param font The font. */ public abstract void setFont(Font font); /** - * Gets a color from the theme's base color palette. + * @return A color from the theme's base color palette. * - * @param index the index of the color, starting from 0 + * @param index The index of the color, starting from 0. */ public abstract Color getBaseColor(int index); @@ -132,10 +132,10 @@ public abstract class Theme { public abstract void setBaseColor(int index, Color baseColor); /** - * Gets a value from the theme's complete color palette (including derived + * @return A value from the theme's complete color palette (including derived * colors, if any). * - * @param index the index of the color, starting from 0 + * @param index The index of the color, starting from 0. */ public abstract Color getColor(int index); @@ -151,14 +151,14 @@ public abstract class Theme { /** * Gets the number of Palette Colors. * - * @return the number + * @return The number of colors in the theme's palette. */ public abstract int getNumberOfPaletteColors(); /** * Gets the total number of Colors (including derived colors, if any). * - * @return the number + * @return The total number of colors. */ public abstract int getNumberOfColors(); @@ -166,8 +166,9 @@ public abstract class Theme { * Tell if the theme is dark.<br> Usually this means that (if true) any * color will be transformed in the opposite way (brightening instead of * darkening, and darkening instead of brightening). + * <p>Note: this value is set in the theme properties file. * - * @return true if dark, false otherwise + * @return {@code true} if dark, {@code false} otherwise. */ public abstract boolean isThemeDark(); @@ -175,7 +176,7 @@ public abstract class Theme { * Tell if the theme is flat.<br> Usually this means that (if true) any * border/shadow will not be drawn. * - * @return true if flat, false otherwise + * @return {@code true} if flat, {@code false} otherwise. */ public abstract boolean isThemeFlat(); @@ -183,7 +184,7 @@ public abstract class Theme { * Tell if the theme has transitions enabled.<br> Usually this means that (if false) any * effect/transition will not be drawn. * - * @return true if enabled (default), false otherwise + * @return {@code true} if enabled (default), {@code false} otherwise. */ public abstract boolean isTransitionEnabled(); @@ -237,7 +238,7 @@ public abstract class Theme { /** * Returns a safe (and general) default foreground color. * - * @return Black if the theme is not dark (default), or White. + * @return Black if the theme is not dark (default), or White otherwise. */ public Color getDefaultForegroundColor() { if (!isThemeDark()) { @@ -247,7 +248,7 @@ public abstract class Theme { } /** - * Gets the current theme, as determined by the {@linkplain #PROVIDER_NAME + * @return The current theme, as determined by the {@linkplain #PROVIDER_NAME * theme provider}. * * @throws IllegalStateException If a theme has not been installed. @@ -261,7 +262,7 @@ public abstract class Theme { } /** - * Produce a font by describing it relative to the current theme's font + * Produce a font by describing it relative to the current theme's font. * * @param dictionary A dictionary with any of the following keys: <ul> <li> * {@value #NAME_KEY} - the family name of the font</li> <li> @@ -269,6 +270,7 @@ public abstract class Theme { * relative size</li> <li>{@value #BOLD_KEY} - true/false</li> <li> * {@value #ITALIC_KEY} - true/false</li> </ul> Omitted values are taken * from the theme's font. + * @return The new font derived from the current font. */ public static Font deriveFont(Dictionary<String, ?> dictionary) { Font font = theme.getFont(); Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeView.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeView.java?rev=1742009&r1=1742008&r2=1742009&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeView.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeView.java Mon May 2 17:18:33 2016 @@ -485,7 +485,7 @@ public class TreeView extends Component /** * Gets the path that leads from the root of the tree data to this - * branch. Note: <tt>rootBranchHandler.getPath()</tt> will return and + * branch. Note: <tt>rootBranchHandler.getPath()</tt> will return an * empty sequence. */ @SuppressWarnings("unchecked") Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewBranchListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewBranchListener.java?rev=1742009&r1=1742008&r2=1742009&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewBranchListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewBranchListener.java Mon May 2 17:18:33 2016 @@ -71,6 +71,7 @@ public interface TreeViewBranchListener * * @param treeView The source of the event. * @param path The path of the node about to be collapsed or expanded. + * @return The accumulated vote as to whether to allow this expansion or collapse. */ public Vote previewBranchExpandedChange(TreeView treeView, Path path); Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewListener.java?rev=1742009&r1=1742008&r2=1742009&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewListener.java Mon May 2 17:18:33 2016 @@ -74,62 +74,62 @@ public interface TreeViewListener { /** * Called when a tree view's data has changed. * - * @param treeView - * @param previousTreeData + * @param treeView The source of this event. + * @param previousTreeData The previous data for this tree. */ public void treeDataChanged(TreeView treeView, List<?> previousTreeData); /** * Called when a tree view's node renderer has changed. * - * @param treeView - * @param previousNodeRenderer + * @param treeView The source of this event. + * @param previousNodeRenderer The previous renderer for tree nodes. */ public void nodeRendererChanged(TreeView treeView, TreeView.NodeRenderer previousNodeRenderer); /** * Called when a tree view's node editor has changed. * - * @param treeView - * @param previousNodeEditor + * @param treeView The source of this event. + * @param previousNodeEditor The previous editor for tree nodes. */ public void nodeEditorChanged(TreeView treeView, TreeView.NodeEditor previousNodeEditor); /** * Called when a tree view's select mode has changed. * - * @param treeView - * @param previousSelectMode + * @param treeView The source of this event. + * @param previousSelectMode What the tree view's select mode was before the change. */ public void selectModeChanged(TreeView treeView, TreeView.SelectMode previousSelectMode); /** * Called when a tree view's checkmarks enabled flag has changed. * - * @param treeView + * @param treeView The source of this event. */ public void checkmarksEnabledChanged(TreeView treeView); /** * Called when a tree view's "show mixed checkmark state" flag has changed. * - * @param treeView + * @param treeView The tree view that has changed. */ public void showMixedCheckmarkStateChanged(TreeView treeView); /** * Called when a tree view's disabled node filter has changed. * - * @param treeView - * @param previousDisabledNodeFilter + * @param treeView The tree view that has changed. + * @param previousDisabledNodeFilter The previous filter that determines the disabled nodes. */ public void disabledNodeFilterChanged(TreeView treeView, Filter<?> previousDisabledNodeFilter); /** * Called when a tree view's disabled checkmark filter has changed. * - * @param treeView - * @param previousDisabledCheckmarkFilter + * @param treeView The source of this event. + * @param previousDisabledCheckmarkFilter The previous filter that determined the disabled checkmarks. */ public void disabledCheckmarkFilterChanged(TreeView treeView, Filter<?> previousDisabledCheckmarkFilter); Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewNodeListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewNodeListener.java?rev=1742009&r1=1742008&r2=1742009&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewNodeListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewNodeListener.java Mon May 2 17:18:33 2016 @@ -55,19 +55,19 @@ public interface TreeViewNodeListener { /** * Called when a node has been inserted into the tree view. * - * @param treeView - * @param path - * @param index + * @param treeView The source of this event. + * @param path The path to the branch where the node was inserted. + * @param index The index of the newly inserted node within the branch. */ public void nodeInserted(TreeView treeView, Path path, int index); /** * Called when nodes have been removed from the tree view. * - * @param treeView - * @param path - * @param index - * @param count The number of nodes that were removed, or <tt>-1</tt> if all + * @param treeView The source of this event. + * @param path The path to the branch where the node(s) were removed. + * @param index The index to the first removed node within the branch. + * @param count The number of nodes that were removed, or <tt>-1</tt> if all * nodes were removed. */ public void nodesRemoved(TreeView treeView, Path path, int index, int count); @@ -75,24 +75,25 @@ public interface TreeViewNodeListener { /** * Called when a node in the tree view has been updated. * - * @param treeView - * @param path - * @param index + * @param treeView The source of this event. + * @param path Path to the branch that is the parent of the updated node. + * @param index Index of the updated node within the branch. */ public void nodeUpdated(TreeView treeView, Path path, int index); /** * Called when the nodes in a branch have been cleared. * - * @param treeView + * @param treeView The source of this event. + * @param path Path to the branch where the nodes were cleared. */ public void nodesCleared(TreeView treeView, Path path); /** * Called when the nodes in a branch have been sorted. * - * @param treeView - * @param path + * @param treeView The source of this event. + * @param path Path to the branch where the nodes were sorted. */ public void nodesSorted(TreeView treeView, Path path); } Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewNodeStateListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewNodeStateListener.java?rev=1742009&r1=1742008&r2=1742009&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewNodeStateListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewNodeStateListener.java Mon May 2 17:18:33 2016 @@ -25,9 +25,9 @@ public interface TreeViewNodeStateListen /** * Called when a node's checked state has changed. * - * @param treeView - * @param path - * @param previousCheckState + * @param treeView The source of this event. + * @param path Path to the node whose state has changed. + * @param previousCheckState The previous check state of this node. */ public void nodeCheckStateChanged(TreeView treeView, Path path, TreeView.NodeCheckState previousCheckState); Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewSelectionListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewSelectionListener.java?rev=1742009&r1=1742008&r2=1742009&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewSelectionListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/TreeViewSelectionListener.java Mon May 2 17:18:33 2016 @@ -51,32 +51,32 @@ public interface TreeViewSelectionListen /** * Called when a selected path has been added to a tree view. * - * @param treeView - * @param path + * @param treeView The source of this event. + * @param path The path that has been added to the selection. */ public void selectedPathAdded(TreeView treeView, Path path); /** * Called when a selected path has been removed from a tree view. * - * @param treeView - * @param path + * @param treeView The source of this event. + * @param path The path that was removed from the selection. */ public void selectedPathRemoved(TreeView treeView, Path path); /** * Called when a tree view's selection state has been reset. * - * @param treeView - * @param previousSelectedPaths + * @param treeView The source of this event. + * @param previousSelectedPaths The list of paths that were previously selected. */ public void selectedPathsChanged(TreeView treeView, Sequence<Path> previousSelectedPaths); /** * Called when a tree view's selected node has changed. * - * @param treeView - * @param previousSelectedNode + * @param treeView The source of this event. + * @param previousSelectedNode The node that used to be selected. */ public void selectedNodeChanged(TreeView treeView, Object previousSelectedNode); } Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/VFSBrowserListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/VFSBrowserListener.java?rev=1742009&r1=1742008&r2=1742009&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/VFSBrowserListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/VFSBrowserListener.java Mon May 2 17:18:33 2016 @@ -76,48 +76,48 @@ public interface VFSBrowserListener { * Called when a file browser's FileSystemManager has changed, (such as when * a nested VirtualFileSystem is opened). * - * @param fileBrowser - * @param previousManager + * @param fileBrowser The browser that has changed. + * @param previousManager The previous file manager for this browser. */ public void managerChanged(VFSBrowser fileBrowser, FileSystemManager previousManager); /** * Called when a file browser's root directory has changed. * - * @param fileBrowser - * @param previousRootDirectory + * @param fileBrowser The browser that has changed. + * @param previousRootDirectory The previous root directory that we were browsing. */ public void rootDirectoryChanged(VFSBrowser fileBrowser, FileObject previousRootDirectory); /** * Called when a file browser's home directory has changed. * - * @param fileBrowser - * @param previousHomeDirectory + * @param fileBrowser The browser that has changed. + * @param previousHomeDirectory The previous home directory. */ public void homeDirectoryChanged(VFSBrowser fileBrowser, FileObject previousHomeDirectory); /** * Called when a file has been added to a file browser's selection. * - * @param fileBrowser - * @param file + * @param fileBrowser The source of this event. + * @param file The file newly added to the selection. */ public void selectedFileAdded(VFSBrowser fileBrowser, FileObject file); /** * Called when a file has been removed from a file browser's selection. * - * @param fileBrowser - * @param file + * @param fileBrowser The source of this event. + * @param file The file just removed from the selection. */ public void selectedFileRemoved(VFSBrowser fileBrowser, FileObject file); /** * Called when a file browser's selection state has been reset. * - * @param fileBrowser - * @param previousSelectedFiles + * @param fileBrowser The source of this event. + * @param previousSelectedFiles The sequence of files that were previously selected. */ public void selectedFilesChanged(VFSBrowser fileBrowser, Sequence<FileObject> previousSelectedFiles); @@ -125,15 +125,15 @@ public interface VFSBrowserListener { /** * Called when a file browser's multi-select flag has changed. * - * @param fileBrowser + * @param fileBrowser The browser that has changed selection modes. */ public void multiSelectChanged(VFSBrowser fileBrowser); /** * Called when a file browser's file filter has changed. * - * @param fileBrowser - * @param previousDisabledFileFilter + * @param fileBrowser The source of this event. + * @param previousDisabledFileFilter The previous filter for disabled files (if any). */ public void disabledFileFilterChanged(VFSBrowser fileBrowser, Filter<FileObject> previousDisabledFileFilter); Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/VFSBrowserSheetListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/VFSBrowserSheetListener.java?rev=1742009&r1=1742008&r2=1742009&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/VFSBrowserSheetListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/VFSBrowserSheetListener.java Mon May 2 17:18:33 2016 @@ -69,24 +69,24 @@ public interface VFSBrowserSheetListener * Called when a file browser's file system manager has changed (as when * browsing into a new virtual file system). * - * @param fileBrowserSheet - * @param previousManager + * @param fileBrowserSheet The source of this event. + * @param previousManager The previous file manager that was set. */ public void managerChanged(VFSBrowserSheet fileBrowserSheet, FileSystemManager previousManager); /** * Called when a file browser sheet's mode has changed. * - * @param fileBrowserSheet - * @param previousMode + * @param fileBrowserSheet The source of this event. + * @param previousMode The previous mode for this browser. */ public void modeChanged(VFSBrowserSheet fileBrowserSheet, VFSBrowserSheet.Mode previousMode); /** * Called when a file browser sheet's root directory has changed. * - * @param fileBrowserSheet - * @param previousRootDirectory + * @param fileBrowserSheet The browser sheet that has changed. + * @param previousRootDirectory The previously set root directory for this browser. */ public void rootDirectoryChanged(VFSBrowserSheet fileBrowserSheet, FileObject previousRootDirectory); @@ -95,8 +95,8 @@ public interface VFSBrowserSheetListener * Called when a file browser sheet's home directory has changed. * <p> Usually this would only be when you browse to another file system. * - * @param fileBrowserSheet - * @param previousHomeDirectory + * @param fileBrowserSheet The browser sheet that has changed. + * @param previousHomeDirectory The previously set home directory for this browser. */ public void homeDirectoryChanged(VFSBrowserSheet fileBrowserSheet, FileObject previousHomeDirectory); @@ -104,8 +104,8 @@ public interface VFSBrowserSheetListener /** * Called when a file browser sheet's selection state has been reset. * - * @param fileBrowserSheet - * @param previousSelectedFiles + * @param fileBrowserSheet The source of this event. + * @param previousSelectedFiles The previous sequence of selected files. */ public void selectedFilesChanged(VFSBrowserSheet fileBrowserSheet, Sequence<FileObject> previousSelectedFiles); @@ -113,8 +113,8 @@ public interface VFSBrowserSheetListener /** * Called when a file browser sheet's disabled file filter has changed. * - * @param fileBrowserSheet - * @param previousDisabledFileFilter + * @param fileBrowserSheet The source of this event. + * @param previousDisabledFileFilter The previous filter for disabled files. */ public void disabledFileFilterChanged(VFSBrowserSheet fileBrowserSheet, Filter<FileObject> previousDisabledFileFilter); Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/Viewport.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/Viewport.java?rev=1742009&r1=1742008&r2=1742009&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/Viewport.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/Viewport.java Mon May 2 17:18:33 2016 @@ -36,7 +36,7 @@ public abstract class Viewport extends C */ public interface Skin { /** - * The bounds of the Viewport within the container, for example, in + * @return The bounds of the Viewport within the container, for example, in * ScrollPaneSkin, this excludes the scrollbars. */ public Bounds getViewportBounds(); Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/ViewportListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/ViewportListener.java?rev=1742009&r1=1742008&r2=1742009&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/ViewportListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/ViewportListener.java Mon May 2 17:18:33 2016 @@ -43,24 +43,24 @@ public interface ViewportListener { /** * Called when a viewport's scroll top has changed. * - * @param scrollPane - * @param previousScrollTop + * @param scrollPane The viewport that has scrolled. + * @param previousScrollTop The previous top scroll position. */ public void scrollTopChanged(Viewport scrollPane, int previousScrollTop); /** * Called when a viewport's scroll left has changed. * - * @param scrollPane - * @param previousScrollLeft + * @param scrollPane The viewport that has been scrolled. + * @param previousScrollLeft The previous left scroll position. */ public void scrollLeftChanged(Viewport scrollPane, int previousScrollLeft); /** * Called when a viewport's view component has changed. * - * @param scrollPane - * @param previousView + * @param scrollPane The viewport whose view has changed. + * @param previousView What the view (or the scrollable component) used to be. */ public void viewChanged(Viewport scrollPane, Component previousView); } Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/WindowActionMappingListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/WindowActionMappingListener.java?rev=1742009&r1=1742008&r2=1742009&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/WindowActionMappingListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/WindowActionMappingListener.java Mon May 2 17:18:33 2016 @@ -25,16 +25,16 @@ public interface WindowActionMappingList /** * Called when an action mapping has been added to a window. * - * @param window + * @param window The source of this event. */ public void actionMappingAdded(Window window); /** * Called when action mappings have been removed from a window. * - * @param window - * @param index - * @param removed + * @param window The window that is affected. + * @param index Starting index of the action mappings that were removed. + * @param removed The sequence of action mappings that were removed. */ public void actionMappingsRemoved(Window window, int index, Sequence<Window.ActionMapping> removed); @@ -42,8 +42,8 @@ public interface WindowActionMappingList /** * Called when an action mapping's keystroke has changed. * - * @param actionMapping - * @param previousKeyStroke + * @param actionMapping The action mapping that has changed. + * @param previousKeyStroke The previous keystroke (if any) associated with this mapping. */ public void keyStrokeChanged(Window.ActionMapping actionMapping, Keyboard.KeyStroke previousKeyStroke); @@ -51,8 +51,8 @@ public interface WindowActionMappingList /** * Called when an action mapping's action has changed. * - * @param actionMapping - * @param previousAction + * @param actionMapping The action mapping that has changed. + * @param previousAction The action previously associated with this mapping. */ public void actionChanged(Window.ActionMapping actionMapping, Action previousAction); } Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/WindowClassListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/WindowClassListener.java?rev=1742009&r1=1742008&r2=1742009&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/WindowClassListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/WindowClassListener.java Mon May 2 17:18:33 2016 @@ -23,7 +23,7 @@ public interface WindowClassListener { /** * Called when the active window has changed. * - * @param previousActiveWindow + * @param previousActiveWindow The window that was previously the active window. */ public void activeWindowChanged(Window previousActiveWindow); } Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/WindowListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/WindowListener.java?rev=1742009&r1=1742008&r2=1742009&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/WindowListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/WindowListener.java Mon May 2 17:18:33 2016 @@ -66,56 +66,59 @@ public interface WindowListener { /** * Called when a window's title has changed. * - * @param window - * @param previousTitle + * @param window The window whose title has changed. + * @param previousTitle What the title was previously (can be {@code null}). */ public void titleChanged(Window window, String previousTitle); /** - * Called when a window's icon has changed. + * Called when an icon has been added to a window. * - * @param window - * @param addedIcon + * @param window The window that has changed. + * @param addedIcon The icon that was added. */ public void iconAdded(Window window, Image addedIcon); /** - * Called when a window's icon has changed. + * Called when a window has had an icon inserted. * - * @param window - * @param addedIcon + * @param window The window that has changed. + * @param addedIcon The newly added icon. + * @param index The index where this icon was inserted in the + * window's icon sequence.. */ public void iconInserted(Window window, Image addedIcon, int index); /** - * Called when a window's icon has changed. + * Called when one or more of the window's icons were removed. * - * @param window - * @param index - * @param removed + * @param window The window that has changed. + * @param index Starting index of the icons that were removed in + * the window's icon sequence. + * @param removed The sequence of icons that were actually removed. */ public void iconsRemoved(Window window, int index, Sequence<Image> removed); /** * Called when a window's content component has changed. * - * @param window - * @param previousContent + * @param window The window whose content has changed. + * @param previousContent What the window's content was previously. */ public void contentChanged(Window window, Component previousContent); /** * Called when a window's active state has changed. * - * @param window - * @param obverseWindow + * @param window The window that has changed its active state. + * @param obverseWindow The "other" window that is affected. */ public void activeChanged(Window window, Window obverseWindow); /** * Called when a window's maximized state has changed. * - * @param window + * @param window The window whose state has changed. */ public void maximizedChanged(Window window); } Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/WindowStateListener.java URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/WindowStateListener.java?rev=1742009&r1=1742008&r2=1742009&view=diff ============================================================================== --- pivot/trunk/wtk/src/org/apache/pivot/wtk/WindowStateListener.java (original) +++ pivot/trunk/wtk/src/org/apache/pivot/wtk/WindowStateListener.java Mon May 2 17:18:33 2016 @@ -60,46 +60,50 @@ public interface WindowStateListener { /** * Called when a window has opened. * - * @param window + * @param window The newly opened window. */ public void windowOpened(Window window); /** * Called to preview a window close event. * - * @param window + * @param window The window that wants to close. + * @return The vote from each listener as to whether to allow the close. */ public Vote previewWindowClose(Window window); /** * Called to preview a window open event. * - * @param window + * @param window The window that wants to open. + * @return The vote from the listener as to whether to allow the open. */ public Vote previewWindowOpen(Window window); /** * Called when a window close event has been vetoed. * - * @param window - * @param reason + * @param window The window that was to close, but now will not. + * @param reason The accumulated vote from all the listeners that + * vetoed this event. */ public void windowCloseVetoed(Window window, Vote reason); /** * Called when a window open event has been vetoed. * - * @param window - * @param reason + * @param window The window that was to open, but now will not. + * @param reason The accumulated vote from all the listeners that + * vetoed this event. */ public void windowOpenVetoed(Window window, Vote reason); /** * Called when a window has closed. * - * @param window - * @param display - * @param owner + * @param window The window that is now closed. + * @param display The display in which the window was shown. + * @param owner The owner of this window (which could be {@code null}). */ public void windowClosed(Window window, Display display, Window owner); }