Class LabelRetargetAction
- All Implemented Interfaces:
IAction
,ActionFactory.IWorkbenchAction
,IPartListener
LabelRetargetAction
extends the behavior of RetargetAction. It
will track the enable state, label, and tool tip text of the target action..
This class may be instantiated. It is not intented to be subclassed.
- Since:
- 2.0
- Restriction:
- This class is not intended to be subclassed by clients.
-
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
ConstructorDescriptionLabelRetargetAction
(String actionID, String text) Constructs a LabelRetargetAction with the given action id and text.LabelRetargetAction
(String actionID, String text, int style) Constructs a RetargetAction with the given action id, text and style. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
The action handler has changed.protected void
setActionHandler
(IAction handler) Sets the action handler.void
Sets the disabled image for this action, as an image descriptor.void
Sets the hover image for this action, as an image descriptor.void
Sets the image for this action, as an image descriptor.void
Sets the action's label text to the given value.void
setToolTipText
(String text) Sets the tooltip text to the given text.Methods inherited from class org.eclipse.ui.actions.RetargetAction
dispose, enableAccelerator, getAccelerator, getActionHandler, isHandled, partActivated, partClosed, partDeactivated, run, runWithEvent, setChecked, setHelpListener, toString
Methods inherited from class org.eclipse.ui.actions.PartEventAction
getActivePart, partBroughtToTop, partOpened
Methods inherited from class org.eclipse.jface.action.Action
convertAccelerator, convertAccelerator, findKeyCode, findKeyString, findModifier, findModifierString, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isChecked, isEnabled, notifyResult, removeAcceleratorText, removeMnemonics, setAccelerator, setActionDefinitionId, setDescription, setEnabled, setId, setMenuCreator
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, setEnabled, setId, setMenuCreator
-
Constructor Details
-
LabelRetargetAction
Constructs a LabelRetargetAction with the given action id and text.- Parameters:
actionID
- the retargetable action idtext
- the action's text, ornull
if there is no text
-
LabelRetargetAction
Constructs a RetargetAction with the given action id, text and style.- Parameters:
actionID
- the retargetable action idtext
- the action's text, ornull
if there is no textstyle
- one ofAS_PUSH_BUTTON
,AS_CHECK_BOX
,AS_DROP_DOWN_MENU
,AS_RADIO_BUTTON
, andAS_UNSPECIFIED
.- Since:
- 3.0
-
-
Method Details
-
propagateChange
The action handler has changed. Update self.- Overrides:
propagateChange
in classRetargetAction
-
setActionHandler
Sets the action handler. Update self.- Overrides:
setActionHandler
in classRetargetAction
-
setDisabledImageDescriptor
Description copied from interface:IAction
Sets the disabled image for this action, as an image descriptor.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.- Specified by:
setDisabledImageDescriptor
in interfaceIAction
- Overrides:
setDisabledImageDescriptor
in classAction
- Parameters:
image
- the image, ornull
if this action should not have an image- See Also:
-
setHoverImageDescriptor
Description copied from interface:IAction
Sets the hover image for this action, as an image descriptor.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.- Specified by:
setHoverImageDescriptor
in interfaceIAction
- Overrides:
setHoverImageDescriptor
in classAction
- Parameters:
image
- the image, ornull
if this action should not have an image- See Also:
-
setImageDescriptor
Description copied from interface:IAction
Sets the image for this action, as an image descriptor.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.
- Specified by:
setImageDescriptor
in interfaceIAction
- Overrides:
setImageDescriptor
in classAction
- Parameters:
image
- the image, ornull
if this action should not have an image- See Also:
-
setText
Sets the action's label text to the given value. -
setToolTipText
Sets the tooltip text to the given text. The valuenull
clears the tooltip text.- Specified by:
setToolTipText
in interfaceIAction
- Overrides:
setToolTipText
in classAction
- Parameters:
text
- the tool tip text, ornull
if none- See Also:
-