Package org.eclipse.ui.texteditor
Class RetargetTextEditorAction
java.lang.Object
org.eclipse.core.commands.common.EventManager
org.eclipse.jface.action.AbstractAction
org.eclipse.jface.action.Action
org.eclipse.ui.texteditor.ResourceAction
org.eclipse.ui.texteditor.RetargetTextEditorAction
- All Implemented Interfaces:
IAction
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 notifications to adapt its enabling state and
its visual presentation.
-
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
ConstructorsConstructorDescriptionRetargetTextEditorAction(ResourceBundle bundle, String prefix) Creates a new action.RetargetTextEditorAction(ResourceBundle bundle, String prefix, int style) Creates a new action.RetargetTextEditorAction(ResourceBundle bundle, String prefix, String actionId) Creates a new action.RetargetTextEditorAction(ResourceBundle bundle, String prefix, String actionId, int style) Creates a new action. -
Method Summary
Modifier and TypeMethodDescriptionvoidrun()The default implementation of thisIActionmethod does nothing.voidSets the underlying action.voidsetHelpListener(HelpListener listener) TheRetargetTextEditorActionimplementation of this method declared onIActionstores the help listener in a local field.Methods inherited from class org.eclipse.ui.texteditor.ResourceAction
getString, initialize, setHelpContextIdMethods inherited from class org.eclipse.jface.action.Action
convertAccelerator, convertAccelerator, findKeyCode, findKeyString, findModifier, findModifierString, getAccelerator, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isChecked, isEnabled, isHandled, notifyResult, removeAcceleratorText, removeMnemonics, runWithEvent, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipTextMethods inherited from class org.eclipse.jface.action.AbstractAction
addPropertyChangeListener, firePropertyChange, firePropertyChange, removePropertyChangeListenerMethods inherited from class org.eclipse.core.commands.common.EventManager
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject
-
Constructor Details
-
RetargetTextEditorAction
Creates a new action. The action configures its initial visual representation from the given resource bundle. If this action's wrapped action is set tonullit also uses the information in the resource bundle.- Parameters:
bundle- the resource bundleprefix- a prefix to be prepended to the various resource keys (described inResourceActionconstructor), ornullif nonestyle- one ofIAction.AS_PUSH_BUTTON,IAction.AS_CHECK_BOX, andIAction.AS_RADIO_BUTTON.- Since:
- 2.1
- See Also:
-
RetargetTextEditorAction
Creates a new action. The action configures its initial visual representation from the given resource bundle. If this action's wrapped action is set tonullit also uses the information in the resource bundle.- Parameters:
bundle- the resource bundleprefix- a prefix to be prepended to the various resource keys (described inResourceActionconstructor), ornullif none- See Also:
-
RetargetTextEditorAction
Creates a new action. The action configures its initial visual representation from the given resource bundle. If this action's wrapped action is set tonullit also uses the information in the resource bundle. The action gets the given action id.- Parameters:
bundle- the resource bundleprefix- a prefix to be prepended to the various resource keys (described inResourceActionconstructor), ornullif noneactionId- the action idstyle- one ofIAction.AS_PUSH_BUTTON,IAction.AS_CHECK_BOX, andIAction.AS_RADIO_BUTTON.- Since:
- 2.1
- See Also:
-
RetargetTextEditorAction
Creates a new action. The action configures its initial visual representation from the given resource bundle. If this action's wrapped action is set tonullit also uses the information in the resource bundle. The action gets the given action id.- Parameters:
bundle- the resource bundleprefix- a prefix to be prepended to the various resource keys (described inResourceActionconstructor), ornullif noneactionId- the action id- Since:
- 2.0
- See Also:
-
-
Method Details
-
setAction
Sets the underlying action.- Parameters:
action- the underlying action
-
setHelpListener
TheRetargetTextEditorActionimplementation of this method declared onIActionstores the help listener in a local field. The supplied listener is only used if there is no handler.- Specified by:
setHelpListenerin interfaceIAction- Overrides:
setHelpListenerin classAction- Parameters:
listener- the help listener- Since:
- 2.1
-
run
public void run()Description copied from class:ActionThe default implementation of thisIActionmethod does nothing. Subclasses should override this method if they do not need information from the triggering event, or overriderunWithEvent(Event)if they do.
-