Eclipse Platform
2.1

org.eclipse.ui.actions
Class LabelRetargetAction

java.lang.Object
  |
  +--org.eclipse.jface.action.Action
        |
        +--org.eclipse.ui.actions.PartEventAction
              |
              +--org.eclipse.ui.actions.RetargetAction
                    |
                    +--org.eclipse.ui.actions.LabelRetargetAction
All Implemented Interfaces:
IAction, 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

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
LabelRetargetAction(String actionID, String text)
          Constructs a LabelRetargetAction.
 
Method Summary
protected  void propagateChange(PropertyChangeEvent event)
          The action handler has changed.
protected  void setActionHandler(IAction handler)
          Sets the action handler.
 void setDisabledImageDescriptor(ImageDescriptor image)
          Sets the disabled image for this action, as an image descriptor.
 void setHoverImageDescriptor(ImageDescriptor image)
          Sets the hover image for this action, as an image descriptor.
 void setImageDescriptor(ImageDescriptor image)
          Sets the image for this action, as an image descriptor.
 void setText(String text)
          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, partActivated, partClosed, partDeactivated, run, runWithEvent, setChecked, setHelpListener
 
Methods inherited from class org.eclipse.ui.actions.PartEventAction
getActivePart, partBroughtToTop, partOpened
 
Methods inherited from class org.eclipse.jface.action.Action
addPropertyChangeListener, convertAccelerator, convertAccelerator, findKeyCode, findKeyString, findModifier, findModifierString, firePropertyChange, firePropertyChange, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isChecked, isEnabled, removeAcceleratorText, removePropertyChangeListener, setAccelerator, setActionDefinitionId, setDescription, setEnabled, setId, setMenuCreator
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LabelRetargetAction

public LabelRetargetAction(String actionID,
                           String text)
Constructs a LabelRetargetAction.
Method Detail

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.

Overrides:
setDisabledImageDescriptor in class Action
Following copied from interface: org.eclipse.jface.action.IAction
Parameters:
newImage - the image, or null if this action should not have an image
See Also:
IAction.IMAGE

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.

Overrides:
setHoverImageDescriptor in class Action
Following copied from interface: org.eclipse.jface.action.IAction
Parameters:
newImage - the image, or null if this action should not have an image
See Also:
IAction.IMAGE

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.

Overrides:
setImageDescriptor in class Action
Following copied from interface: org.eclipse.jface.action.IAction
Parameters:
newImage - the image, or null if this action should not have an image
See Also:
IAction.IMAGE

setText

public void setText(String text)
Sets the action's label text to the given value.
Overrides:
setText in class Action
Following copied from class: org.eclipse.jface.action.Action
Parameters:
text - the text, or null if none

setToolTipText

public void setToolTipText(String text)
Sets the tooltip text to the given text. The value null clears the tooltip text.
Overrides:
setToolTipText in class Action
Following copied from class: org.eclipse.jface.action.Action
Parameters:
toolTipText - the tool tip text, or null if none

Eclipse Platform
2.1

Copyright (c) IBM Corp. and others 2000, 2003. All Rights Reserved.