Package org.eclipse.ui.texteditor
Class TextOperationAction
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.TextEditorAction
org.eclipse.ui.texteditor.TextOperationAction
An action which gets a text operation target from its text editor.
The action is initially associated with a text editor via the constructor,
but can subsequently be changed using setEditor
.
If this class is used as is, it works by asking the text editor for its
text operation target adapter (using getAdapter(ITextOperationTarget.class)
.
The action runs this operation with the pre-configured opcode.
-
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
ConstructorDescriptionTextOperationAction
(ResourceBundle bundle, String prefix, ITextEditor editor, int operationCode) Creates and initializes the action for the given text editor and operation code.TextOperationAction
(ResourceBundle bundle, String prefix, ITextEditor editor, int operationCode, boolean runsOnReadOnly) Creates and initializes the action for the given text editor and operation code. -
Method Summary
Modifier and TypeMethodDescriptionvoid
run()
TheTextOperationAction
implementation of thisIAction
method runs the operation with the current operation code.void
setEditor
(ITextEditor editor) Retargets this action to the given editor.void
update()
TheTextOperationAction
implementation of thisIUpdate
method discovers the operation through the current editor'sITextOperationTarget
adapter, and sets the enabled state accordingly.Methods inherited from class org.eclipse.ui.texteditor.TextEditorAction
canModifyEditor, getTextEditor, validateEditorInputState
Methods inherited from class org.eclipse.ui.texteditor.ResourceAction
getString, initialize, setHelpContextId
Methods 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, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText
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
-
Constructor Details
-
TextOperationAction
public TextOperationAction(ResourceBundle bundle, String prefix, ITextEditor editor, int operationCode) Creates and initializes the action for the given text editor and operation code. The action configures its visual representation from the given resource bundle. The action works by asking the text editor at the time for its text operation target adapter (usinggetAdapter(ITextOperationTarget.class)
. The action runs that operation with the given opcode.- Parameters:
bundle
- the resource bundleprefix
- a prefix to be prepended to the various resource keys (described inResourceAction
constructor), ornull
if noneeditor
- the text editoroperationCode
- the operation code- See Also:
-
TextOperationAction
public TextOperationAction(ResourceBundle bundle, String prefix, ITextEditor editor, int operationCode, boolean runsOnReadOnly) Creates and initializes the action for the given text editor and operation code. The action configures its visual representation from the given resource bundle. The action works by asking the text editor at the time for its text operation target adapter (usinggetAdapter(ITextOperationTarget.class)
. The action runs that operation with the given opcode.- Parameters:
bundle
- the resource bundleprefix
- a prefix to be prepended to the various resource keys (described inResourceAction
constructor), ornull
if noneeditor
- the text editoroperationCode
- the operation coderunsOnReadOnly
-true
if action can be executed on read-only files- Since:
- 2.0
- See Also:
-
-
Method Details
-
run
public void run()TheTextOperationAction
implementation of thisIAction
method runs the operation with the current operation code. -
update
public void update()TheTextOperationAction
implementation of thisIUpdate
method discovers the operation through the current editor'sITextOperationTarget
adapter, and sets the enabled state accordingly.- Specified by:
update
in interfaceIUpdate
- Overrides:
update
in classTextEditorAction
-
setEditor
Description copied from class:TextEditorAction
Retargets this action to the given editor.- Overrides:
setEditor
in classTextEditorAction
- Parameters:
editor
- the new editor, ornull
if none
-