|
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
org.eclipse.ui.actions.PartEventAction
org.eclipse.ui.actions.RetargetAction
A RetargetAction
tracks the active part in the workbench.
Each RetargetAction has an ID. If the active part provides an action
handler for the ID the enable and check state of the RetargetAction
is determined from the enable and check state of the handler. If the
active part does not provide an action handler then this action is
disabled.
Note: instances of this class add themselves as listeners to their action handler. It is important for the creator of a retarget action to call dispose when the action is no longer needed. This will ensure that the listener is removed.
This class may be instantiated. It is not intented to be subclassed.
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 | |
---|---|
RetargetAction(String actionID,
String text)
Constructs a RetargetAction with the given action id and text. |
|
RetargetAction(String actionID,
String text,
int style)
Constructs a RetargetAction with the given action id, text and style. |
Method Summary | |
---|---|
void |
dispose()
Disposes of the action and any resources held. |
void |
enableAccelerator(boolean b)
Enables the accelerator for this action. |
int |
getAccelerator()
Returns the accelerator keycode for this action. |
IAction |
getActionHandler()
Returns the action handler. |
boolean |
isHandled()
Returns whether this action is handled. |
void |
partActivated(IWorkbenchPart part)
A workbench part has been activated. |
void |
partClosed(IWorkbenchPart part)
A workbench part has been closed. |
void |
partDeactivated(IWorkbenchPart part)
A workbench part has been deactivated. |
protected void |
propagateChange(PropertyChangeEvent event)
Either the action handler itself has changed, or the configured action handlers on the action bars have changed. |
void |
run()
Invoked when an action occurs. |
void |
runWithEvent(Event event)
Invoked when an action occurs. |
protected void |
setActionHandler(IAction newHandler)
Sets the action handler. |
void |
setChecked(boolean checked)
Sets the checked status of this action. |
void |
setHelpListener(HelpListener listener)
The RetargetAction implementation of this method declared on
IAction stores the help listener in a local field. |
Methods inherited from class org.eclipse.ui.actions.PartEventAction |
---|
getActivePart, partBroughtToTop, partOpened |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.eclipse.jface.action.IAction |
---|
addPropertyChangeListener, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isChecked, isEnabled, removePropertyChangeListener, setAccelerator, setActionDefinitionId, setDescription, setDisabledImageDescriptor, setEnabled, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText |
Constructor Detail |
public RetargetAction(String actionID, String text)
actionID
- the retargetable action idtext
- the action's text, or null
if there is no textpublic RetargetAction(String actionID, String text, int style)
actionID
- the retargetable action idtext
- 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 dispose()
dispose
in interface ActionFactory.IWorkbenchAction
public void enableAccelerator(boolean b)
b
- the new enable statepublic int getAccelerator()
IAction
MenuItem.getAccelerator
.
getAccelerator
in interface IAction
getAccelerator
in class Action
public void partActivated(IWorkbenchPart part)
partActivated
in interface IPartListener
partActivated
in class PartEventAction
part
- the workbench part that has been activatedpublic void partClosed(IWorkbenchPart part)
partClosed
in interface IPartListener
partClosed
in class PartEventAction
part
- the workbench part that has been closedpublic void partDeactivated(IWorkbenchPart part)
partDeactivated
in interface IPartListener
partDeactivated
in class PartEventAction
part
- the workbench part that has been deactivatedprotected void propagateChange(PropertyChangeEvent event)
public void run()
run
in interface IAction
run
in class Action
public void runWithEvent(Event event)
runWithEvent
in interface IAction
runWithEvent
in class Action
event
- the SWT event which triggered this action being runpublic IAction getActionHandler()
null
if there is no current
handler.public final boolean isHandled()
IAction
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.
isHandled
in interface IAction
isHandled
in class Action
protected void setActionHandler(IAction newHandler)
public void setChecked(boolean checked)
IAction
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.
setChecked
in interface IAction
setChecked
in class Action
public void setHelpListener(HelpListener listener)
RetargetAction
implementation of this method declared on
IAction
stores the help listener in a local field. The
supplied listener is only used if there is no hanlder.
setHelpListener
in interface IAction
setHelpListener
in class Action
|
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.