|
Eclipse Platform 2.1 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.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.
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, IMAGE, TEXT, TOOL_TIP_TEXT |
Constructor Summary | |
RetargetAction(String actionID,
String label)
Constructs a RetargetAction. |
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. |
protected IAction |
getActionHandler()
Returns the action handler. |
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 |
Constructor Detail |
public RetargetAction(String actionID, String label)
Method Detail |
public void dispose()
public void enableAccelerator(boolean b)
boolean
- the new enable statepublic int getAccelerator()
IAction
MenuItem.getAccelerator
.getAccelerator
in class Action
org.eclipse.jface.action.IAction
MenuItem.getAccelerator()
public void partActivated(IWorkbenchPart part)
partActivated
in class PartEventAction
part
- the workbench part that has been activatedpublic void partClosed(IWorkbenchPart part)
partClosed
in class PartEventAction
part
- the workbench part that has been closedpublic void partDeactivated(IWorkbenchPart part)
partDeactivated
in class PartEventAction
part
- the workbench part that has been deactivatedprotected void propagateChange(PropertyChangeEvent event)
public void run()
run
in class Action
public void runWithEvent(Event event)
runWithEvent
in class Action
org.eclipse.jface.action.IAction
event
- the SWT event which triggered this action being runprotected IAction getActionHandler()
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 class Action
org.eclipse.jface.action.IAction
checked
- the new checked statusIAction.CHECKED
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 class Action
org.eclipse.jface.action.IAction
listener
- a help listener for this action
|
Eclipse Platform 2.1 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |