summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSteve Northover <steve>2006-09-27 15:38:11 +0000
committerSteve Northover <steve>2006-09-27 15:38:11 +0000
commitceedcf5af4838ba1b70de7247ed9c5b47873dd01 (patch)
tree4fc1eb00e47d38c06db58a9d732776e85cd4a088
parent31d850c816ad1a00754ad7fbb4fdd2f395ce5309 (diff)
downloadeclipse.platform.swt-ceedcf5af4838ba1b70de7247ed9c5b47873dd01.tar.gz
eclipse.platform.swt-ceedcf5af4838ba1b70de7247ed9c5b47873dd01.tar.xz
eclipse.platform.swt-ceedcf5af4838ba1b70de7247ed9c5b47873dd01.zip
157797 - Improve javadoc of Control#addKeyListener(..) to tell about changed traversal behavior
-rwxr-xr-xbundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/events/KeyEvent.java4
-rwxr-xr-xbundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Control.java13
2 files changed, 14 insertions, 3 deletions
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/events/KeyEvent.java b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/events/KeyEvent.java
index da63a35bc3..022d535d30 100755
--- a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/events/KeyEvent.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/events/KeyEvent.java
@@ -18,8 +18,8 @@ import org.eclipse.swt.widgets.Event;
* keys being pressed and released on the keyboard.
* <p>
* When a key listener is added to a control, the control
- * is expected to take part in widget traversal. By default,
- * all traversal keys (such as the tab key and so on) are
+ * will take part in widget traversal. By default, all
+ * traversal keys (such as the tab key and so on) are
* delivered to the control. In order for a control to take
* part in traversal, it should listen for traversal events.
* Otherwise, the user can traverse into a control but not
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Control.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Control.java
index 23b82fe32b..ed534fdb2e 100755
--- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Control.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Control.java
@@ -183,7 +183,18 @@ public void addHelpListener (HelpListener listener) {
* be notified when keys are pressed and released on the system keyboard, by sending
* it one of the messages defined in the <code>KeyListener</code>
* interface.
- *
+ * <p>
+ * When a key listener is added to a control, the control
+ * will take part in widget traversal. By default, all
+ * traversal keys (such as the tab key and so on) are
+ * delivered to the control. In order for a control to take
+ * part in traversal, it should listen for traversal events.
+ * Otherwise, the user can traverse into a control but not
+ * out. Note that native controls such as table and tree
+ * implement key traversal in the operating system. It is
+ * not necessary to add traversal listeners for these controls,
+ * unless you want to override the default traversal.
+ * </p>
* @param listener the listener which should be notified
*
* @exception IllegalArgumentException <ul>