Class LabelRetargetAction

All Implemented Interfaces:
IAction, ActionFactory.IWorkbenchAction, IPartListener

public class LabelRetargetAction extends RetargetAction
A 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.
  • Constructor Details

    • LabelRetargetAction

      public LabelRetargetAction(String actionID, String text)
      Constructs a LabelRetargetAction with the given action id and text.
      Parameters:
      actionID - the retargetable action id
      text - the action's text, or null if there is no text
    • LabelRetargetAction

      public LabelRetargetAction(String actionID, String text, int style)
      Constructs a RetargetAction with the given action id, text and style.
      Parameters:
      actionID - the retargetable action id
      text - the action's text, or null if there is no text
      style - one of AS_PUSH_BUTTON, AS_CHECK_BOX, AS_DROP_DOWN_MENU, AS_RADIO_BUTTON, and AS_UNSPECIFIED.
      Since:
      3.0
  • Method Details

    • propagateChange

      protected void propagateChange(PropertyChangeEvent event)
      The action handler has changed. Update self.
      Overrides:
      propagateChange in class RetargetAction
    • setActionHandler

      protected void setActionHandler(IAction handler)
      Sets the action handler. Update self.
      Overrides:
      setActionHandler in class RetargetAction
    • setDisabledImageDescriptor

      public void setDisabledImageDescriptor(ImageDescriptor image)
      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 interface IAction
      Overrides:
      setDisabledImageDescriptor in class Action
      Parameters:
      image - the image, or null if this action should not have an image
      See Also:
    • setHoverImageDescriptor

      public void setHoverImageDescriptor(ImageDescriptor image)
      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 interface IAction
      Overrides:
      setHoverImageDescriptor in class Action
      Parameters:
      image - the image, or null if this action should not have an image
      See Also:
    • setImageDescriptor

      public void setImageDescriptor(ImageDescriptor image)
      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 interface IAction
      Overrides:
      setImageDescriptor in class Action
      Parameters:
      image - the image, or null if this action should not have an image
      See Also:
    • setText

      public void setText(String text)
      Sets the action's label text to the given value.
      Specified by:
      setText in interface IAction
      Overrides:
      setText in class Action
      Parameters:
      text - the text, or null if none
      See Also:
    • setToolTipText

      public void setToolTipText(String text)
      Sets the tooltip text to the given text. The value null clears the tooltip text.
      Specified by:
      setToolTipText in interface IAction
      Overrides:
      setToolTipText in class Action
      Parameters:
      text - the tool tip text, or null if none
      See Also: