org.eclipse.ui.texteditor
Class RetargetTextEditorAction

java.lang.Object
  |
  +--org.eclipse.jface.action.Action
        |
        +--org.eclipse.ui.texteditor.ResourceAction
              |
              +--org.eclipse.ui.texteditor.RetargetTextEditorAction

All Implemented Interfaces:

IAction

public final class RetargetTextEditorAction

extends ResourceAction

Action used by an editor action bar contributor to establish placeholders in menus or action bars which can be retargeted to dynamically changing actions, for example, those which come from the active editor. This action assumes that the "wrapped" action sends out property change events in response to state changes. It uses these change notification to adapt its enabling state and its visual presentation.

This class may be instantiated; it is not intended to be subclassed.

Field Summary

Fields inherited from interface org.eclipse.jface.action.IAction

AS_CHECK_BOX, AS_DROP_DOWN_MENU, AS_PUSH_BUTTON, CHECKED, DESCRIPTION, ENABLED, IMAGE, TEXT, TOOL_TIP_TEXT

Constructor Summary

RetargetTextEditorAction(ResourceBundle bundle, String prefix)
Creates a new action.

RetargetTextEditorAction(ResourceBundle bundle, String prefix, String actionId)
Creates a new action.

Method Summary

String	getActionDefinitionId() Returns the action definition id of this action.
void	run() The default implementation of this IAction method does nothing.
void	setAction(IAction action) Sets the underlying action.

Methods inherited from class org.eclipse.ui.texteditor.ResourceAction

getString, setHelpContextId

Methods inherited from class org.eclipse.jface.action.Action

addPropertyChangeListener, convertAccelerator, convertAccelerator, findKeyCode, findKeyString, findModifier, findModifierString, firePropertyChange, firePropertyChange, getAccelerator, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isChecked, isEnabled, removeAcceleratorText, removePropertyChangeListener, runWithEvent, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RetargetTextEditorAction

public RetargetTextEditorAction(ResourceBundle bundle,
                                String prefix)

Creates a new action. The action configures its initial visual representation from the given resource bundle. If this action's wrapped action is set to null it also uses the information in the resource bundle.

Parameters:

bundle - the resource bundle

prefix - a prefix to be prepended to the various resource keys (described in ResourceAction constructor), or null if none

See Also:

ResourceAction.ResourceAction(java.util.ResourceBundle, java.lang.String)

RetargetTextEditorAction

public RetargetTextEditorAction(ResourceBundle bundle,
                                String prefix,
                                String actionId)

Creates a new action. The action configures its initial visual representation from the given resource bundle. If this action's wrapped action is set to null it also uses the information in the resource bundle. The action gets the given action id.

Parameters:

bundle - the resource bundle

prefix - a prefix to be prepended to the various resource keys (described in ResourceAction constructor), or null if none

actionId - the action id

Since:

2.0

See Also:

ResourceAction.ResourceAction(java.util.ResourceBundle, java.lang.String)

Method Detail

setAction

public void setAction(IAction action)

Sets the underlying action.

Parameters:

action - the underlying action

run

public void run()

Description copied from class: Action

The default implementation of this IAction method does nothing. Subclasses should override this method if they do not need information from the triggering event, or override run(Event) if they do.

Specified by:

run in interface IAction

Overrides:

run in class Action

getActionDefinitionId

public String getActionDefinitionId()

Description copied from interface: IAction

Returns the action definition id of this action.

Specified by:

getActionDefinitionId in interface IAction

Overrides:

getActionDefinitionId in class Action

Returns:

the action definition id of this action, or null if none