|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface IAction
An action represents the non-UI side of a command which can be triggered
by the end user. Actions are typically associated with buttons, menu items,
and items in tool bars. The controls for a command are built by some container,
which furnished the context where these controls appear and configures
them with data from properties declared by the action. When the end user
triggers the command via its control, the action's run
method is invoked to do the real work.
Actions support a predefined set of properties (and possibly others as well). Clients of an action may register property change listeners so that they get notified whenever the value of a property changes.
Clients should subclass the abstract base class Action to define
concrete actions rather than implementing IAction from scratch.
This interface exists only to define the API for actions. It is not intended to be implemented by clients.
Action| Field Summary | |
|---|---|
static int |
AS_CHECK_BOX
Action style constant (value 2) indicating action is
a check box (or a toggle button). |
static int |
AS_DROP_DOWN_MENU
Action style constant (value 4) indicating action is
a drop down menu. |
static int |
AS_PUSH_BUTTON
Action style constant (value 1) indicating action is
a simple push button. |
static int |
AS_RADIO_BUTTON
Action style constant (value 8) indicating action is
a radio button. |
static int |
AS_UNSPECIFIED
Action style constant (value 0) indicating action style
is not specified yet. |
static java.lang.String |
CHECKED
Property name of an action's checked status (value "checked"). |
static java.lang.String |
DESCRIPTION
Property name of an action's description (value "description"). |
static java.lang.String |
ENABLED
Property name of an action's enabled state (value "enabled"). |
static java.lang.String |
HANDLED
Property name of an action's handler. |
static java.lang.String |
IMAGE
Property name of an action's image (value "image"). |
static java.lang.String |
RESULT
Property name of an action's success/fail result (value "result"). |
static java.lang.String |
TEXT
Property name of an action's text (value "text"). |
static java.lang.String |
TOOL_TIP_TEXT
Property name of an action's tooltip text (value "toolTipText"). |
| Method Summary | |
|---|---|
void |
addPropertyChangeListener(IPropertyChangeListener listener)
Adds a property change listener to this action. |
int |
getAccelerator()
Returns the accelerator keycode for this action. |
java.lang.String |
getActionDefinitionId()
Returns the action definition id of this action. |
java.lang.String |
getDescription()
Returns the action's description if it has one. |
ImageDescriptor |
getDisabledImageDescriptor()
Returns the disabled image for this action as an image descriptor. |
HelpListener |
getHelpListener()
Returns a help listener for this action. |
ImageDescriptor |
getHoverImageDescriptor()
Returns the hover image for this action as an image descriptor. |
java.lang.String |
getId()
Returns a unique identifier for this action, or null if it has
none. |
ImageDescriptor |
getImageDescriptor()
Returns the image for this action as an image descriptor. |
IMenuCreator |
getMenuCreator()
Returns the menu creator for this action. |
int |
getStyle()
Return this action's style. |
java.lang.String |
getText()
Returns the text for this action. |
java.lang.String |
getToolTipText()
Returns the tool tip text for this action. |
boolean |
isChecked()
Returns the checked status of this action. |
boolean |
isEnabled()
Returns whether this action is enabled. |
boolean |
isHandled()
Returns whether this action is handled. |
void |
removePropertyChangeListener(IPropertyChangeListener listener)
Removes the given listener from this action. |
void |
run()
Runs this action. |
void |
runWithEvent(Event event)
Runs this action, passing the triggering SWT event. |
void |
setAccelerator(int keycode)
Sets the accelerator keycode that this action maps to. |
void |
setActionDefinitionId(java.lang.String id)
Sets the action definition id of this action. |
void |
setChecked(boolean checked)
Sets the checked status of this action. |
void |
setDescription(java.lang.String text)
Sets this action's description. |
void |
setDisabledImageDescriptor(ImageDescriptor newImage)
Sets the disabled image for this action, as an image descriptor. |
void |
setEnabled(boolean enabled)
Sets the enabled state of this action. |
void |
setHelpListener(HelpListener listener)
Sets a help listener for this action. |
void |
setHoverImageDescriptor(ImageDescriptor newImage)
Sets the hover image for this action, as an image descriptor. |
void |
setId(java.lang.String id)
Sets the unique identifier for this action. |
void |
setImageDescriptor(ImageDescriptor newImage)
Sets the image for this action, as an image descriptor. |
void |
setMenuCreator(IMenuCreator creator)
Sets the menu creator for this action. |
void |
setText(java.lang.String text)
Sets the text for this action. |
void |
setToolTipText(java.lang.String text)
Sets the tool tip text for this action. |
| Field Detail |
|---|
static final int AS_UNSPECIFIED
0) indicating action style
is not specified yet. By default, the action will assume a push button
style. If setChecked is called, then the style will change
to a check box, or if setMenuCreator is called, then the
style will change to a drop down menu.
static final int AS_PUSH_BUTTON
1) indicating action is
a simple push button.
static final int AS_CHECK_BOX
2) indicating action is
a check box (or a toggle button).
static final int AS_DROP_DOWN_MENU
4) indicating action is
a drop down menu.
static final int AS_RADIO_BUTTON
8) indicating action is
a radio button.
static final java.lang.String TEXT
"text").
static final java.lang.String ENABLED
"enabled").
static final java.lang.String IMAGE
"image").
static final java.lang.String TOOL_TIP_TEXT
"toolTipText").
static final java.lang.String DESCRIPTION
"description").
Typically the description is shown as a (longer) help text in the status line.
static final java.lang.String CHECKED
"checked"). Applicable when the style is
AS_CHECK_BOX or AS_RADIO_BUTTON.
static final java.lang.String RESULT
"result"). The values are
Boolean.TRUE if running the action succeeded and
Boolean.FALSE if running the action failed or did not
complete.
Not all actions report whether they succeed or fail. This property is provided for use by actions that may be invoked by clients that can take advantage of this information when present (for example, actions used in cheat sheets). Clients should always assume that running the action succeeded in the absence of notification to the contrary.
static final java.lang.String HANDLED
| Method Detail |
|---|
void addPropertyChangeListener(IPropertyChangeListener listener)
listener - a property change listenerint getAccelerator()
MenuItem.getAccelerator.
MenuItem.getAccelerator()java.lang.String getActionDefinitionId()
null if nonejava.lang.String getDescription()
getToolTipText().
nullImageDescriptor getDisabledImageDescriptor()
This method is associated with the IMAGE property;
property change events are reported when its value changes.
null if this action has no imageIMAGEHelpListener getHelpListener()
ImageDescriptor getHoverImageDescriptor()
Hover images will be used on platforms that support changing the image
when the user hovers over the item. This method is associated with
the IMAGE property;
property change events are reported when its value changes.
null if this action has no imageIMAGEjava.lang.String getId()
null if it has
none.
null if noneImageDescriptor getImageDescriptor()
This method is associated with the IMAGE property;
property change events are reported when its value changes.
null if this action has no imageIMAGEIMenuCreator getMenuCreator()
null if noneint getStyle()
AS_PUSH_BUTTON, AS_CHECK_BOX,
AS_RADIO_BUTTON and AS_DROP_DOWN_MENU.java.lang.String getText()
This method is associated with the TEXT property;
property change events are reported when its value changes.
null if noneTEXTjava.lang.String getToolTipText()
This method is associated with the TOOL_TIP_TEXT property;
property change events are reported when its value changes.
null if noneTOOL_TIP_TEXTboolean isChecked()
AS_CHECK_BOX or AS_RADIO_BUTTON.
This method is associated with the CHECKED property;
property change events are reported when its value changes.
CHECKEDboolean isEnabled()
This method is associated with the ENABLED property;
property change events are reported when its value changes.
true if enabled, and
false if disabledENABLEDboolean isHandled()
true. However, if the action delegates some of its
behaviour to some other object, then this method should answer whether
such an object is currently available.
true if all of the action's behaviour is
available; false otherwise.void removePropertyChangeListener(IPropertyChangeListener listener)
listener - a property change listenervoid run()
Action
does nothing.
void runWithEvent(Event event)
ActionContributionItem calls this method
instead of run().
The default implementation of this method in Action
simply calls run() for backwards compatibility.
event - the SWT event which triggered this action being runvoid setActionDefinitionId(java.lang.String id)
id - the action definition idvoid setChecked(boolean checked)
AS_CHECK_BOX or AS_RADIO_BUTTON.
Fires a property change event for the CHECKED property
if the checked status actually changes as a consequence.
checked - the new checked statusCHECKEDvoid setDescription(java.lang.String text)
Fires a property change event for the DESCRIPTION property
if the description actually changes as a consequence.
text - the description, or null to clear the descriptionDESCRIPTIONvoid setDisabledImageDescriptor(ImageDescriptor newImage)
Disabled images will be used on platforms that support changing the image
when the item is disabled.Fires a property change event for
the IMAGE property
if the image actually changes as a consequence.
newImage - the image, or null if this
action should not have an imageIMAGEvoid setEnabled(boolean enabled)
When an action is in the enabled state, the control associated with
it is active; triggering it will end up inkoking this action's
run method.
Fires a property change event for the ENABLED property
if the enabled state actually changes as a consequence.
enabled - true to enable, and
false to disableENABLEDvoid setHelpListener(HelpListener listener)
listener - a help listener for this actionvoid setHoverImageDescriptor(ImageDescriptor newImage)
Hover images will be used on platforms that support changing the image
when the user hovers over the item.Fires a property change event for
the IMAGE property
if the image actually changes as a consequence.
newImage - the image, or null if this
action should not have an imageIMAGEvoid setId(java.lang.String id)
id - the action idActionContributionItem,
IContributionItem.getId()void setImageDescriptor(ImageDescriptor newImage)
Fires a property change event for the IMAGE property if the
image actually changes as a consequence.
Note: This operation is a hint and is not supported in all contexts on platforms that do not have this concept (for example, Windows NT). Furthermore, some platforms (such as GTK), cannot display both a check box and an image at the same time. Instead, they hide the image and display the check box.
newImage - the image, or null if this action should not have
an imageIMAGEvoid setMenuCreator(IMenuCreator creator)
AS_DROP_DOWN_MENU.
creator - the menu creator, or null if nonevoid setText(java.lang.String text)
An accelerator specification may follow the actual text, separated from it by an '@' or a '\t' character. An accelerator specification consists of zero or more modifier tokens followed by a key code token. The tokens are separated by a '+' character.
Fires a property change event for the TEXT property
if the text actually changes as a consequence.
text - the text, or null if noneTEXT,
Action.findModifier(java.lang.String),
Action.findKeyCode(java.lang.String)void setToolTipText(java.lang.String text)
Fires a property change event for the TOOL_TIP_TEXT property
if the tool tip text actually changes as a consequence.
text - the tool tip text, or null if noneTOOL_TIP_TEXTvoid setAccelerator(int keycode)
Sets the accelerator keycode that this action maps to. This is a bitwise OR
of zero or more SWT key modifier masks (i.e. SWT.CTRL or SWT.ALT) and a
character code. For example, for Ctrl+Z, use SWT.CTRL | 'Z'.
Use 0 for no accelerator.
This method should no longer be used for actions in the Eclipse workbench.
IWorkbenchCommandSupport and
IWorkbenchContextSupport provide all the functionality
required for key bindings. If you set an accelerator using this method, then
it will not work in the workbench if it conflicts any existing key binding,
or if there is a different key binding defined for this action's definition
id. The definition id should be used instead -- referring to the command in
the workbench from which the key binding should be retrieved.
keycode - the keycode to be accepted.
|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.