public abstract class TextViewerAction
extends org.eclipse.ui.texteditor.ResourceAction
implements org.eclipse.ui.texteditor.IUpdate
setViewer(ITextViewer)
Subclasses must implement the run
method and if required override the update
method.
Subclasses that may modify the editor content should use canModifyViewer()
in their update
code
to check whether updating the viewer is possible.
Modifier | Constructor and Description |
---|---|
protected |
TextViewerAction(java.util.ResourceBundle bundle,
java.lang.String prefix)
Make sure the Viewer in set after calling this constructor and before calling
update() |
protected |
TextViewerAction(java.util.ResourceBundle bundle,
java.lang.String prefix,
org.eclipse.jface.text.ITextViewer viewer)
Creates and initializes the action for the given text editor.
|
protected |
TextViewerAction(java.util.ResourceBundle bundle,
java.lang.String prefix,
org.eclipse.jface.text.ITextViewer viewer,
int style)
Creates and initializes the action for the given text editor.
|
Modifier and Type | Method and Description |
---|---|
protected boolean |
canModifyViewer()
Checks the viewer's modifiable state.
|
protected org.eclipse.jface.text.ITextSelection |
getSelection(org.eclipse.jface.text.ITextViewer viewer)
Returns the viewer's selection.
|
protected org.eclipse.jface.text.ITextViewer |
getTextViewer()
Returns the action's text editor.
|
void |
setViewer(org.eclipse.jface.text.ITextViewer viewer)
Retargets this action to the given editor.
|
void |
update()
Always enables this action if it is connected to a text editor.
|
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, run, runWithEvent, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText
addPropertyChangeListener, firePropertyChange, firePropertyChange, removePropertyChangeListener
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject
protected TextViewerAction(java.util.ResourceBundle bundle, java.lang.String prefix, org.eclipse.jface.text.ITextViewer viewer)
bundle
- the resource bundleprefix
- a prefix to be prepended to the various resource keys (described in ResourceAction
constructor), or null
if noneviewer
- the text viewerResourceAction.ResourceAction(ResourceBundle, String)
protected TextViewerAction(java.util.ResourceBundle bundle, java.lang.String prefix)
update()
protected TextViewerAction(java.util.ResourceBundle bundle, java.lang.String prefix, org.eclipse.jface.text.ITextViewer viewer, int style)
bundle
- the resource bundleprefix
- a prefix to be prepended to the various resource keys (described in ResourceAction
constructor), or null
if noneviewer
- the text editorstyle
- the style of this actionResourceAction.ResourceAction(ResourceBundle, String, int)
protected org.eclipse.jface.text.ITextViewer getTextViewer()
public void setViewer(org.eclipse.jface.text.ITextViewer viewer)
viewer
- the new viewer, or null
if nonepublic void update()
null
,
the action is disabled. Subclasses may override.update
in interface org.eclipse.ui.texteditor.IUpdate
protected boolean canModifyViewer()
true
if the viewer can be modifiedtrue
if a modifying action should be enabled, false
otherwiseprotected org.eclipse.jface.text.ITextSelection getSelection(org.eclipse.jface.text.ITextViewer viewer)
viewer
- the viewer