public final class TextOperationAction extends TextEditorAction
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.
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 and Description |
---|
TextOperationAction(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.
|
Modifier and Type | Method and Description |
---|---|
void |
run()
The
TextOperationAction implementation of this
IAction method runs the operation with the current
operation code. |
void |
setEditor(ITextEditor editor)
Retargets this action to the given editor.
|
void |
update()
The
TextOperationAction implementation of this
IUpdate method discovers the operation through the current
editor's ITextOperationTarget adapter, and sets the
enabled state accordingly. |
canModifyEditor, getTextEditor, validateEditorInputState
getString, initialize, setHelpContextId
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
addPropertyChangeListener, firePropertyChange, firePropertyChange, removePropertyChangeListener
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject
public TextOperationAction(ResourceBundle bundle, String prefix, ITextEditor editor, int operationCode)
getAdapter(ITextOperationTarget.class)
. The action runs that
operation with the given opcode.bundle
- the resource bundleprefix
- a prefix to be prepended to the various resource keys
(described in ResourceAction
constructor), or
null
if noneeditor
- the text editoroperationCode
- the operation codeTextEditorAction.TextEditorAction(ResourceBundle, String, ITextEditor)
public TextOperationAction(ResourceBundle bundle, String prefix, ITextEditor editor, int operationCode, boolean runsOnReadOnly)
getAdapter(ITextOperationTarget.class)
. The action runs that
operation with the given opcode.bundle
- the resource bundleprefix
- a prefix to be prepended to the various resource keys
(described in ResourceAction
constructor), or
null
if noneeditor
- the text editoroperationCode
- the operation coderunsOnReadOnly
- true
if action can be executed on read-only filesTextEditorAction.TextEditorAction(ResourceBundle, String, ITextEditor)
public void run()
TextOperationAction
implementation of this
IAction
method runs the operation with the current
operation code.run
in interface IAction
run
in class Action
How radio buttons are handled
,
How check boxes are handled
public void update()
TextOperationAction
implementation of this
IUpdate
method discovers the operation through the current
editor's ITextOperationTarget
adapter, and sets the
enabled state accordingly.update
in interface IUpdate
update
in class TextEditorAction
public void setEditor(ITextEditor editor)
TextEditorAction
setEditor
in class TextEditorAction
editor
- the new editor, or null
if none
Copyright (c) 2000, 2018 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.