|
Eclipse Platform Release 3.3 |
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||||
java.lang.Objectorg.eclipse.core.commands.common.EventManager
org.eclipse.jface.action.AbstractAction
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.
| 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. |
String |
toString()
Returns a string representation of this action. |
| Methods inherited from class org.eclipse.ui.actions.PartEventAction |
|---|
getActivePart, partBroughtToTop, partOpened |
| Methods inherited from class org.eclipse.jface.action.AbstractAction |
|---|
addPropertyChangeListener, firePropertyChange, firePropertyChange, removePropertyChangeListener |
| Methods inherited from class org.eclipse.core.commands.common.EventManager |
|---|
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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 text
public 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.IWorkbenchActionpublic void enableAccelerator(boolean b)
b - the new enable statepublic int getAccelerator()
IActionMenuItem.getAccelerator.
getAccelerator in interface IActiongetAccelerator in class Actionpublic void partActivated(IWorkbenchPart part)
partActivated in interface IPartListenerpartActivated in class PartEventActionpart - the workbench part that has been activatedpublic void partClosed(IWorkbenchPart part)
partClosed in interface IPartListenerpartClosed in class PartEventActionpart - the workbench part that has been closedpublic void partDeactivated(IWorkbenchPart part)
partDeactivated in interface IPartListenerpartDeactivated in class PartEventActionpart - the workbench part that has been deactivatedprotected void propagateChange(PropertyChangeEvent event)
public void run()
run in interface IActionrun in class Actionpublic void runWithEvent(Event event)
runWithEvent in interface IActionrunWithEvent in class Actionevent - the SWT event which triggered this action being runpublic IAction getActionHandler()
null if there is no current
handler.public final 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 IActionisHandled in class Actionprotected void setActionHandler(IAction newHandler)
public 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 IActionsetChecked in class Actionpublic 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 IActionsetHelpListener in class Actionpublic final String toString()
|
Eclipse Platform Release 3.3 |
|||||||||||
| 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, 2007. All rights reserved.