aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRobin Stocker2013-12-01 14:13:14 (EST)
committerRobin Stocker2013-12-05 16:08:03 (EST)
commita42800f44856d631b2cb90c9e7dc63005033ab1e (patch)
tree733080832c6c892d9f2ae5a3a3b31a5ae8781cbc
parentaad29ac0fb309642899d2e21a59ca0e43dc4197f (diff)
downloadeclipse.platform.ui-a42800f44856d631b2cb90c9e7dc63005033ab1e.zip
eclipse.platform.ui-a42800f44856d631b2cb90c9e7dc63005033ab1e.tar.gz
eclipse.platform.ui-a42800f44856d631b2cb90c9e7dc63005033ab1e.tar.bz2
Bug 422910 - [Commands] Extend documentation of IAction AS_RADIO_BUTTONrefs/changes/87/19187/2
Also add a note to AS_CHECK_BOX. Change-Id: I6d45bef187761abdb9bae481f45cef0ac8b15c46 Signed-off-by: Robin Stocker <robin@nibor.org>
-rw-r--r--bundles/org.eclipse.jface/src/org/eclipse/jface/action/IAction.java13
1 files changed, 13 insertions, 0 deletions
diff --git a/bundles/org.eclipse.jface/src/org/eclipse/jface/action/IAction.java b/bundles/org.eclipse.jface/src/org/eclipse/jface/action/IAction.java
index d48a75c..525fd1c 100644
--- a/bundles/org.eclipse.jface/src/org/eclipse/jface/action/IAction.java
+++ b/bundles/org.eclipse.jface/src/org/eclipse/jface/action/IAction.java
@@ -63,6 +63,9 @@ public interface IAction {
/**
* Action style constant (value <code>2</code>) indicating action is
* a check box (or a toggle button).
+ * <p>
+ * <strong>Note:</strong> The action is also run when a check box gets
+ * deselected. Use {@link #isChecked} to determine the selection state.
*/
public static int AS_CHECK_BOX = 0x02;
@@ -75,6 +78,10 @@ public interface IAction {
/**
* Action style constant (value <code>8</code>) indicating action is
* a radio button.
+ * <p>
+ * <strong>Note:</strong> When a radio button gets selected, the action for
+ * the unselected radio button will also be run. Use {@link #isChecked} to
+ * determine the selection state.
*
* @since 2.1
*/
@@ -323,6 +330,9 @@ public interface IAction {
* Each action implementation must define the steps needed to carry out this action.
* The default implementation of this method in <code>Action</code>
* does nothing.
+ *
+ * @see #AS_RADIO_BUTTON How radio buttons are handled
+ * @see #AS_CHECK_BOX How check boxes are handled
*/
public void run();
@@ -335,6 +345,9 @@ public interface IAction {
*
* @param event the SWT event which triggered this action being run
* @since 2.0
+ *
+ * @see #AS_RADIO_BUTTON How radio buttons are handled
+ * @see #AS_CHECK_BOX How check boxes are handled
*/
public void runWithEvent(Event event);