org.eclipse.ui.texteditor
Class TextOperationAction
java.lang.Object
|
+--org.eclipse.jface.action.Action
|
+--org.eclipse.ui.texteditor.ResourceAction
|
+--org.eclipse.ui.texteditor.TextEditorAction
|
+--org.eclipse.ui.texteditor.TextOperationAction
- All Implemented Interfaces:
- IAction, IUpdate
- public final class TextOperationAction
- extends TextEditorAction
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.
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 |
Method Summary |
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. |
Methods inherited from class org.eclipse.jface.action.Action |
addPropertyChangeListener, convertAccelerator, convertAccelerator, findKeyCode, findKeyString, findModifier, findModifierString, firePropertyChange, firePropertyChange, getAccelerator, getActionDefinitionId, 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 |
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 (using
getAdapter(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 in ResourceAction
constructor), or
null
if noneeditor
- the text editoroperationCode
- the operation code- See Also:
ResourceAction.ResourceAction(java.util.ResourceBundle, java.lang.String, int)
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 (using
getAdapter(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 in ResourceAction
constructor), or
null
if noneeditor
- the text editoroperationCode
- the operation coderunsOnReadOnly
- true
if action can be executed on read-only files- Since:
- 2.0
- See Also:
ResourceAction.ResourceAction(java.util.ResourceBundle, java.lang.String, int)
run
public void run()
- The
TextOperationAction
implementation of this
IAction
method runs the operation with the current
operation code.
- Overrides:
run
in class Action
update
public 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.
- Overrides:
update
in class TextEditorAction
setEditor
public void setEditor(ITextEditor editor)
- Description copied from class:
TextEditorAction
- Retargets this action to the given editor.
- Overrides:
setEditor
in class TextEditorAction
- Following copied from class:
org.eclipse.ui.texteditor.TextEditorAction
- Parameters:
editor
- the new editor, or null
if none
Copyright (c) IBM Corp. and others 2000, 2003. All Rights Reserved.