|
Eclipse Platform Release 3.1 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.jface.action.Action
public abstract class Action
The standard abstract implementation of an action.
Subclasses must implement the IAction.run method to carry out
the action's semantics.
| Field Summary |
|---|
| Fields inherited from interface org.eclipse.jface.action.IAction |
|---|
AS_CHECK_BOX, AS_DROP_DOWN_MENU, AS_PUSH_BUTTON, AS_RADIO_BUTTON, AS_UNSPECIFIED, CHECKED, DESCRIPTION, ENABLED, HANDLED, IMAGE, RESULT, TEXT, TOOL_TIP_TEXT |
| Constructor Summary | |
|---|---|
protected |
Action()
Creates a new action with no text and no image. |
protected |
Action(java.lang.String text)
Creates a new action with the given text and no image. |
protected |
Action(java.lang.String text,
ImageDescriptor image)
Creates a new action with the given text and image. |
protected |
Action(java.lang.String text,
int style)
Creates a new action with the given text and style. |
| Method Summary | |
|---|---|
void |
addPropertyChangeListener(IPropertyChangeListener listener)
Adds a property change listener to this action. |
static java.lang.String |
convertAccelerator(int keyCode)
Converts an accelerator key code to a string representation. |
static int |
convertAccelerator(java.lang.String acceleratorText)
Parses the given accelerator text, and converts it to an accelerator key code. |
static int |
findKeyCode(java.lang.String token)
Maps a standard keyboard key name to an SWT key code. |
static java.lang.String |
findKeyString(int keyCode)
Maps an SWT key code to a standard keyboard key name. |
static int |
findModifier(java.lang.String token)
Maps standard keyboard modifier key names to the corresponding SWT modifier bit. |
static java.lang.String |
findModifierString(int keyCode)
Returns a string representation of an SWT modifier bit (SWT.CTRL, SWT.ALT, SWT.SHIFT, and SWT.COMMAND). |
protected void |
firePropertyChange(PropertyChangeEvent event)
Notifies any property change listeners that a property has changed. |
protected void |
firePropertyChange(java.lang.String propertyName,
java.lang.Object oldValue,
java.lang.Object newValue)
Notifies any property change listeners that a property has changed. |
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 |
notifyResult(boolean success)
Reports the outcome of the running of this action via the IAction.RESULT property. |
static java.lang.String |
removeAcceleratorText(java.lang.String text)
Convenience method for removing any optional accelerator text from the given string. |
static java.lang.String |
removeMnemonics(java.lang.String text)
Convenience method for removing any mnemonics from the given string. |
void |
removePropertyChangeListener(IPropertyChangeListener listener)
Removes the given listener from this action. |
void |
run()
The default implementation of this IAction method
does nothing. |
void |
runWithEvent(Event event)
The default implementation of this IAction method
ignores the event argument, and simply calls run(). |
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 toolTipText)
Sets the tool tip text for this action. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
protected Action()
Configure the action later using the set methods.
protected Action(java.lang.String text)
setText.
text - the string used as the text for the action,
or null if there is no textsetText(java.lang.String)
protected Action(java.lang.String text,
ImageDescriptor image)
setText and setImageDescriptor.
text - the action's text, or null if there is no textimage - the action's image, or null if there is no imagesetText(java.lang.String),
setImageDescriptor(org.eclipse.jface.resource.ImageDescriptor)
protected Action(java.lang.String text,
int style)
text - the action's text, or null if there is no textstyle - one of AS_PUSH_BUTTON, AS_CHECK_BOX,
AS_DROP_DOWN_MENU, AS_RADIO_BUTTON, and
AS_UNSPECIFIED.| Method Detail |
|---|
public void addPropertyChangeListener(IPropertyChangeListener listener)
IAction
addPropertyChangeListener in interface IActionlistener - a property change listenerpublic static int convertAccelerator(java.lang.String acceleratorText)
acceleratorText - the accelerator text
public static java.lang.String convertAccelerator(int keyCode)
keyCode - the key code to be translated
public static int findKeyCode(java.lang.String token)
The following key names are known (case is ignored):
"BACKSPACE""TAB""RETURN""ENTER""ESC""ESCAPE""DELETE""SPACE""ARROW_UP", "ARROW_DOWN",
"ARROW_LEFT", and "ARROW_RIGHT""PAGE_UP" and "PAGE_DOWN""HOME""END""INSERT""F1", "F2" through "F12"
token - the key name
-1 if no match was foundSWTpublic static java.lang.String findKeyString(int keyCode)
keyCode - the key code to be translated
SWTpublic static int findModifier(java.lang.String token)
"CTRL", "SHIFT",
"ALT", and "COMMAND".
The given modifier key name is converted to upper case before comparison.
token - the modifier key name
0 if no match was foundSWTpublic static java.lang.String findModifierString(int keyCode)
null if the key code
is not an SWT modifier bit.
keyCode - the SWT modifier bit to be translated
null if the key code was not an SWT modifier bitSWT
protected void firePropertyChange(java.lang.String propertyName,
java.lang.Object oldValue,
java.lang.Object newValue)
firePropertyChange(PropertyChangeEvent) if there are.
propertyName - the name of the property that has changedoldValue - the old value of the property, or null if nonenewValue - the new value of the property, or null if noneIPropertyChangeListener.propertyChange(org.eclipse.jface.util.PropertyChangeEvent)protected void firePropertyChange(PropertyChangeEvent event)
event - the property change eventIPropertyChangeListener.propertyChange(org.eclipse.jface.util.PropertyChangeEvent)public int getAccelerator()
IActionMenuItem.getAccelerator.
getAccelerator in interface IActionMenuItem.getAccelerator()public java.lang.String getActionDefinitionId()
IAction
getActionDefinitionId in interface IActionnull if nonepublic java.lang.String getDescription()
IActiongetToolTipText().
getDescription in interface IActionnullpublic ImageDescriptor getDisabledImageDescriptor()
IAction
This method is associated with the IMAGE property;
property change events are reported when its value changes.
getDisabledImageDescriptor in interface IActionnull if this action has no imageIAction.IMAGEpublic HelpListener getHelpListener()
IAction
getHelpListener in interface IActionpublic ImageDescriptor getHoverImageDescriptor()
IAction
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.
getHoverImageDescriptor in interface IActionnull if this action has no imageIAction.IMAGEpublic java.lang.String getId()
IActionnull if it has
none.
getId in interface IActionnull if nonepublic ImageDescriptor getImageDescriptor()
IAction
This method is associated with the IMAGE property;
property change events are reported when its value changes.
getImageDescriptor in interface IActionnull if this action has no imageIAction.IMAGEpublic IMenuCreator getMenuCreator()
IAction
getMenuCreator in interface IActionnull if nonepublic int getStyle()
IAction
getStyle in interface IActionAS_PUSH_BUTTON, AS_CHECK_BOX,
AS_RADIO_BUTTON and AS_DROP_DOWN_MENU.public java.lang.String getText()
IAction
This method is associated with the TEXT property;
property change events are reported when its value changes.
getText in interface IActionnull if noneIAction.TEXTpublic java.lang.String getToolTipText()
IAction
This method is associated with the TOOL_TIP_TEXT property;
property change events are reported when its value changes.
getToolTipText in interface IActionnull if noneIAction.TOOL_TIP_TEXTpublic boolean isChecked()
IActionAS_CHECK_BOX or AS_RADIO_BUTTON.
This method is associated with the CHECKED property;
property change events are reported when its value changes.
isChecked in interface IActionIAction.CHECKEDpublic boolean isEnabled()
IAction
This method is associated with the ENABLED property;
property change events are reported when its value changes.
isEnabled in interface IActiontrue if enabled, and
false if disabledIAction.ENABLEDpublic boolean isHandled()
IActiontrue. 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.
isHandled in interface IActiontrue if all of the action's behaviour is
available; false otherwise.public static java.lang.String removeAcceleratorText(java.lang.String text)
'\t'.
text - the text
public static java.lang.String removeMnemonics(java.lang.String text)
removeMnemonics("&Open") will return "Open".
text - the text
public void removePropertyChangeListener(IPropertyChangeListener listener)
IAction
removePropertyChangeListener in interface IActionlistener - a property change listenerpublic void run()
IAction method
does nothing. Subclasses should override this method
if they do not need information from the triggering event,
or override runWithEvent(Event) if they do.
run in interface IActionpublic void runWithEvent(Event event)
IAction method
ignores the event argument, and simply calls run().
Subclasses should override this method if they need information
from the triggering event, or override run() if not.
runWithEvent in interface IActionevent - the SWT event which triggered this action being runpublic void setActionDefinitionId(java.lang.String id)
IAction
setActionDefinitionId in interface IActionid - the action definition idpublic void setChecked(boolean checked)
IActionAS_CHECK_BOX or AS_RADIO_BUTTON.
Fires a property change event for the CHECKED property
if the checked status actually changes as a consequence.
setChecked in interface IActionchecked - the new checked statusIAction.CHECKEDpublic void setDescription(java.lang.String text)
IAction
Fires a property change event for the DESCRIPTION property
if the description actually changes as a consequence.
setDescription in interface IActiontext - the description, or null to clear the descriptionIAction.DESCRIPTIONpublic void setDisabledImageDescriptor(ImageDescriptor newImage)
IAction
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.
setDisabledImageDescriptor in interface IActionnewImage - the image, or null if this
action should not have an imageIAction.IMAGEpublic void setEnabled(boolean enabled)
IAction
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.
setEnabled in interface IActionenabled - true to enable, and
false to disableIAction.ENABLEDpublic void setHelpListener(HelpListener listener)
IAction
setHelpListener in interface IActionlistener - a help listener for this actionpublic void setHoverImageDescriptor(ImageDescriptor newImage)
IAction
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.
setHoverImageDescriptor in interface IActionnewImage - the image, or null if this
action should not have an imageIAction.IMAGEpublic void setId(java.lang.String id)
IAction
setId in interface IActionid - the action idActionContributionItem,
IContributionItem.getId()public void setImageDescriptor(ImageDescriptor newImage)
IAction
Fires a property change event for the IMAGE property
if the image actually changes as a consequence.
setImageDescriptor in interface IActionnewImage - the image, or null if this
action should not have an imageIAction.IMAGEpublic void setMenuCreator(IMenuCreator creator)
Note that if this method is called, it overrides the check status.
setMenuCreator in interface IActioncreator - the menu creator, or null if nonepublic void setText(java.lang.String text)
Fires a property change event for the TEXT property
if the text actually changes as a consequence.
The accelerator is identified by the last index of a tab character. If there are no tab characters, then it is identified by the last index of a '@' character. If neither, then there is no accelerator text. Note that if you want to insert a '@' character into the text (but no accelerator, you can simply insert a '@' or a tab at the end of the text.
setText in interface IActiontext - the text, or null if noneIAction.TEXT,
findModifier(java.lang.String),
findKeyCode(java.lang.String)public void setToolTipText(java.lang.String toolTipText)
Fires a property change event for the TOOL_TIP_TEXT property
if the tool tip text actually changes as a consequence.
setToolTipText in interface IActiontoolTipText - the tool tip text, or null if noneIAction.TOOL_TIP_TEXTpublic void setAccelerator(int keycode)
IAction
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.
setAccelerator in interface IActionkeycode - the keycode to be accepted.public final void notifyResult(boolean success)
IAction.RESULT property.
success - true if the action succeeded and
false if the action failed or was not completedIAction.RESULT
|
Eclipse Platform Release 3.1 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.