You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pivot.apache.org by cb...@apache.org on 2010/09/17 00:26:34 UTC

svn commit: r997941 - in /pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra: TerraListViewSkin.java TerraSliderSkin.java TerraSpinnerSkin.java TerraTableViewSkin.java TerraTextInputSkin.java TerraTreeViewSkin.java

Author: cbartlett
Date: Thu Sep 16 22:26:34 2010
New Revision: 997941

URL: http://svn.apache.org/viewvc?rev=997941&view=rev
Log:
PIVOT-637 - Javadoc comments for ComponentKeyListener#keyPressed() methods (Remaining ComponentSkin sub-classes)

Modified:
    pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraListViewSkin.java
    pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraSliderSkin.java
    pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraSpinnerSkin.java
    pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTableViewSkin.java
    pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTextInputSkin.java
    pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTreeViewSkin.java

Modified: pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraListViewSkin.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraListViewSkin.java?rev=997941&r1=997940&r2=997941&view=diff
==============================================================================
--- pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraListViewSkin.java (original)
+++ pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraListViewSkin.java Thu Sep 16 22:26:34 2010
@@ -42,6 +42,9 @@ import org.apache.pivot.wtk.Mouse;
 import org.apache.pivot.wtk.Platform;
 import org.apache.pivot.wtk.Span;
 import org.apache.pivot.wtk.Theme;
+import org.apache.pivot.wtk.Keyboard.KeyCode;
+import org.apache.pivot.wtk.Keyboard.Modifier;
+import org.apache.pivot.wtk.ListView.SelectMode;
 import org.apache.pivot.wtk.skin.ComponentSkin;
 
 /**
@@ -977,6 +980,18 @@ public class TerraListViewSkin extends C
         return super.mouseWheel(component, scrollType, scrollAmount, wheelRotation, x, y);
     }
 
+    /**
+     * {@link KeyCode#UP UP} Selects the previous enabled list item when select
+     * mode is not {@link SelectMode#NONE}<br>
+     * {@link KeyCode#DOWN DOWN} Selects the next enabled list item when select
+     * mode is not {@link SelectMode#NONE}<p>
+     * {@link Modifier#SHIFT SHIFT} + {@link KeyCode#UP UP} Increases the 
+     * selection size by including the previous enabled list item when select 
+     * mode is {@link SelectMode#MULTI}<br>
+     * {@link Modifier#SHIFT SHIFT} + {@link KeyCode#DOWN DOWN} Increases the
+     * selection size by including the next enabled list item when select mode 
+     * is {@link SelectMode#MULTI}
+     */
     @Override
     public boolean keyPressed(Component component, int keyCode, Keyboard.KeyLocation keyLocation) {
         boolean consumed = super.keyPressed(component, keyCode, keyLocation);
@@ -1048,8 +1063,8 @@ public class TerraListViewSkin extends C
     }
 
     /**
-     * {@link Keyboard.KeyCode#SPACE} toggles check mark selection when select
-     * mode is {@link ListView.SelectMode#SINGLE}
+     * {@link KeyCode#SPACE SPACE} Toggles check mark selection when select
+     * mode is {@link SelectMode#SINGLE}
      */
     @Override
     public boolean keyReleased(Component component, int keyCode, Keyboard.KeyLocation keyLocation) {

Modified: pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraSliderSkin.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraSliderSkin.java?rev=997941&r1=997940&r2=997941&view=diff
==============================================================================
--- pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraSliderSkin.java (original)
+++ pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraSliderSkin.java Thu Sep 16 22:26:34 2010
@@ -31,6 +31,7 @@ import org.apache.pivot.wtk.Orientation;
 import org.apache.pivot.wtk.Point;
 import org.apache.pivot.wtk.Slider;
 import org.apache.pivot.wtk.Theme;
+import org.apache.pivot.wtk.Keyboard.KeyCode;
 import org.apache.pivot.wtk.skin.ComponentSkin;
 import org.apache.pivot.wtk.skin.SliderSkin;
 
@@ -215,6 +216,12 @@ public class TerraSliderSkin extends Sli
             return super.mouseClick(component, button, x, y, count);
         }
 
+        /**
+         * {@link KeyCode#LEFT LEFT} or {@link KeyCode#DOWN DOWN} Decrement 
+         * the slider's value.<br>
+         * {@link KeyCode#RIGHT RIGHT} or {@link KeyCode#UP UP} Increment 
+         * the slider's value.
+         */
         @Override
         public boolean keyPressed(Component component, int keyCode, Keyboard.KeyLocation keyLocation) {
             boolean consumed = super.keyPressed(component, keyCode, keyLocation);

Modified: pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraSpinnerSkin.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraSpinnerSkin.java?rev=997941&r1=997940&r2=997941&view=diff
==============================================================================
--- pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraSpinnerSkin.java (original)
+++ pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraSpinnerSkin.java Thu Sep 16 22:26:34 2010
@@ -38,6 +38,7 @@ import org.apache.pivot.wtk.Spinner;
 import org.apache.pivot.wtk.SpinnerListener;
 import org.apache.pivot.wtk.SpinnerSelectionListener;
 import org.apache.pivot.wtk.Theme;
+import org.apache.pivot.wtk.Keyboard.KeyCode;
 import org.apache.pivot.wtk.media.Image;
 import org.apache.pivot.wtk.skin.ComponentSkin;
 import org.apache.pivot.wtk.skin.ContainerSkin;
@@ -255,6 +256,10 @@ public class TerraSpinnerSkin extends Co
             repaintComponent();
         }
 
+        /**
+         * {@link KeyCode#UP UP} Select the previous spinner item.<br>
+         * {@link KeyCode#DOWN DOWN} Select the next spinner item.
+         */
         @Override
         public boolean keyPressed(Component component, int keyCode,
             Keyboard.KeyLocation keyLocation) {

Modified: pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTableViewSkin.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTableViewSkin.java?rev=997941&r1=997940&r2=997941&view=diff
==============================================================================
--- pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTableViewSkin.java (original)
+++ pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTableViewSkin.java Thu Sep 16 22:26:34 2010
@@ -43,6 +43,9 @@ import org.apache.pivot.wtk.TableViewLis
 import org.apache.pivot.wtk.TableViewRowListener;
 import org.apache.pivot.wtk.TableViewSelectionListener;
 import org.apache.pivot.wtk.Theme;
+import org.apache.pivot.wtk.Keyboard.KeyCode;
+import org.apache.pivot.wtk.Keyboard.Modifier;
+import org.apache.pivot.wtk.TableView.SelectMode;
 import org.apache.pivot.wtk.skin.ComponentSkin;
 
 /**
@@ -1295,6 +1298,18 @@ public class TerraTableViewSkin extends 
         return super.mouseWheel(component, scrollType, scrollAmount, wheelRotation, x, y);
     }
 
+    /**
+     * {@link KeyCode#UP UP} Selects the previous enabled row when select mode
+     * is not {@link SelectMode#NONE}<br>
+     * {@link KeyCode#DOWN DOWN} Selects the next enabled row when select mode
+     * is not {@link SelectMode#NONE}<p>
+     * {@link Modifier#SHIFT SHIFT} + {@link KeyCode#UP UP} Increases the 
+     * selection size by including the previous enabled row when select mode
+     * is {@link SelectMode#MULTI}<br>
+     * {@link Modifier#SHIFT SHIFT} + {@link KeyCode#DOWN DOWN} Increases the 
+     * selection size by including the next enabled row when select mode is
+     * {@link SelectMode#MULTI}
+     */
     @Override
     public boolean keyPressed(Component component, int keyCode, Keyboard.KeyLocation keyLocation) {
         boolean consumed = super.keyPressed(component, keyCode, keyLocation);

Modified: pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTextInputSkin.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTextInputSkin.java?rev=997941&r1=997940&r2=997941&view=diff
==============================================================================
--- pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTextInputSkin.java (original)
+++ pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTextInputSkin.java Thu Sep 16 22:26:34 2010
@@ -46,11 +46,13 @@ import org.apache.pivot.wtk.Mouse;
 import org.apache.pivot.wtk.Orientation;
 import org.apache.pivot.wtk.Platform;
 import org.apache.pivot.wtk.TextInput;
+import org.apache.pivot.wtk.TextInputContentListener;
 import org.apache.pivot.wtk.TextInputListener;
 import org.apache.pivot.wtk.TextInputSelectionListener;
-import org.apache.pivot.wtk.TextInputContentListener;
 import org.apache.pivot.wtk.Theme;
 import org.apache.pivot.wtk.Window;
+import org.apache.pivot.wtk.Keyboard.KeyCode;
+import org.apache.pivot.wtk.Keyboard.Modifier;
 import org.apache.pivot.wtk.skin.ComponentSkin;
 import org.apache.pivot.wtk.validation.Validator;
 
@@ -1050,6 +1052,56 @@ public class TerraTextInputSkin extends 
         return consumed;
     }
 
+    /**
+     * {@link KeyCode#DELETE DELETE} Delete the character after the caret or
+     * the entire selection if there is one.<br>
+     * {@link KeyCode#BACKSPACE BACKSPACE} Delete the character before the 
+     * caret or the entire selection if there is one.<p>
+     * {@link KeyCode#HOME HOME} Move the caret to the beginning of the text.
+     * <br>
+     * {@link KeyCode#LEFT LEFT} + {@link Modifier#META META} Move the caret 
+     * to the beginning of the text.<p>
+     * {@link KeyCode#HOME HOME} + {@link Modifier#SHIFT SHIFT} Select from 
+     * the caret to the beginning of the text.<br>
+     * {@link KeyCode#LEFT LEFT} + {@link Modifier#META META} +
+     * {@link Modifier#SHIFT SHIFT} Select from the caret to the beginning of
+     * the text.<p>
+     * {@link KeyCode#END END} Move the caret to the end of the text.<br>
+     * {@link KeyCode#RIGHT RIGHT} + {@link Modifier#META META} Move the caret
+     * to the end of the text.<p>
+     * {@link KeyCode#END END} + {@link Modifier#SHIFT SHIFT} Select from the 
+     * caret to the end of the text.<br>
+     * {@link KeyCode#RIGHT RIGHT} + {@link Modifier#META META} +
+     * {@link Modifier#SHIFT SHIFT} Select from the caret to the end of the
+     * text.<p>
+     * {@link KeyCode#LEFT LEFT} Clear the selection and move the caret back 
+     * by one character.<br>
+     * {@link KeyCode#LEFT LEFT} + {@link Modifier#SHIFT SHIFT} Add the 
+     * previous character to the selection.<br>
+     * {@link KeyCode#LEFT LEFT} + {@link Modifier#CTRL CTRL} Clear the 
+     * selection and move the caret to the beginning of the text.<br>
+     * {@link KeyCode#LEFT LEFT} + {@link Modifier#CTRL CTRL} +
+     * {@link Modifier#SHIFT SHIFT} Add all preceding text to the selection.
+     * <p>
+     * {@link KeyCode#RIGHT RIGHT} Clear the selection and move the caret
+     * forward by one character.<br>
+     * {@link KeyCode#RIGHT RIGHT} + {@link Modifier#SHIFT SHIFT} Add the next
+     * character to the selection.<br>
+     * {@link KeyCode#RIGHT RIGHT} + {@link Modifier#CTRL CTRL} Clear the 
+     * selection and move the caret to the end of the text.<br>
+     * {@link KeyCode#RIGHT RIGHT} + {@link Modifier#CTRL CTRL} +
+     * {@link Modifier#SHIFT SHIFT} Add all subsequent text to the selection.
+     * <p>
+     * CommandModifier + {@link KeyCode#A A} Select all.<br>
+     * CommandModifier + {@link KeyCode#X X} Cut selection to clipboard (if 
+     * not a password TextInput).<br>
+     * CommandModifier + {@link KeyCode#C C} Copy selection to clipboard (if
+     * not a password TextInput).<br>
+     * CommandModifier + {@link KeyCode#V V} Paste from clipboard.<br>
+     * CommandModifier + {@link KeyCode#Z Z} Undo.
+     *
+     * @see Platform#getCommandModifier()
+     */
     @Override
     public boolean keyPressed(Component component, int keyCode, Keyboard.KeyLocation keyLocation) {
         boolean consumed = super.keyPressed(component, keyCode, keyLocation);

Modified: pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTreeViewSkin.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTreeViewSkin.java?rev=997941&r1=997940&r2=997941&view=diff
==============================================================================
--- pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTreeViewSkin.java (original)
+++ pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTreeViewSkin.java Thu Sep 16 22:26:34 2010
@@ -49,6 +49,9 @@ import org.apache.pivot.wtk.TreeViewList
 import org.apache.pivot.wtk.TreeViewNodeListener;
 import org.apache.pivot.wtk.TreeViewNodeStateListener;
 import org.apache.pivot.wtk.TreeViewSelectionListener;
+import org.apache.pivot.wtk.Keyboard.KeyCode;
+import org.apache.pivot.wtk.Keyboard.Modifier;
+import org.apache.pivot.wtk.TreeView.SelectMode;
 import org.apache.pivot.wtk.skin.ComponentSkin;
 
 /**
@@ -1741,6 +1744,18 @@ public class TerraTreeViewSkin extends C
         return super.mouseWheel(component, scrollType, scrollAmount, wheelRotation, x, y);
     }
 
+    /**
+     * {@link KeyCode#UP UP} Selects the previous enabled node when select mode
+     * is not {@link SelectMode#NONE}<br>
+     * {@link KeyCode#DOWN DOWN} Selects the next enabled node when select mode
+     * is not {@link SelectMode#NONE}<p>
+     * {@link Modifier#SHIFT SHIFT} + {@link KeyCode#UP UP} Increases the 
+     * selection size by including the previous enabled node when select  mode 
+     * is {@link SelectMode#MULTI}<br>
+     * {@link Modifier#SHIFT SHIFT} + {@link KeyCode#DOWN DOWN} Increases the 
+     * selection size by including the next enabled node when select mode is
+     * {@link SelectMode#MULTI}
+     */
     @Override
     public boolean keyPressed(Component component, int keyCode, Keyboard.KeyLocation keyLocation) {
         boolean consumed = false;
@@ -1877,8 +1892,8 @@ public class TerraTreeViewSkin extends C
     }
 
     /**
-     * {@link Keyboard.KeyCode#SPACE} toggles check mark selection when select
-     * mode is {@link TreeView.SelectMode#SINGLE}
+     * {@link KeyCode#SPACE SPACE} toggles check mark selection when select
+     * mode is {@link SelectMode#SINGLE}
      */
     @Override
     public boolean keyReleased(Component component, int keyCode, Keyboard.KeyLocation keyLocation) {