Class TextEditorAction
- Direct Known Subclasses:
AddMarkerAction,CaseAction,ChangeEncodingAction,ContentAssistAction,ConvertLineDelimitersAction,DeleteLineAction,GotoAnnotationAction,GotoLineAction,InsertLineAction,JoinLinesAction,MarkAction,MoveLinesAction,RecenterAction,RevertToSavedAction,SaveAction,SelectAnnotationRulerAction,ShiftAction,ShowWhitespaceCharactersAction,TextOperationAction
setEditor.
Subclasses must implement the run method and if
required override the update method.
Subclasses that may modify the editor content should use canModifyEditor()
in their update code to check whether updating the editor is most
likely possible (even if it is read-only - this may change for editor contents
that are under version control) and validateEditorInputState() before
actually modifying the editor contents.
-
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
ConstructorsModifierConstructorDescriptionprotectedTextEditorAction(ResourceBundle bundle, String prefix, ITextEditor editor) Creates and initializes the action for the given text editor.protectedTextEditorAction(ResourceBundle bundle, String prefix, ITextEditor editor, int style) Creates and initializes the action for the given text editor. -
Method Summary
Modifier and TypeMethodDescriptionprotected booleanChecks the editor's modifiable state.protected ITextEditorReturns the action's text editor.voidsetEditor(ITextEditor editor) Retargets this action to the given editor.voidupdate()Always enables this action if it is connected to a text editor.protected booleanChecks and validates the editor's modifiable state.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, run, runWithEvent, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, 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
-
TextEditorAction
Creates and initializes the action for the given text editor. The action configures its visual representation from the given resource bundle.- Parameters:
bundle- the resource bundleprefix- a prefix to be prepended to the various resource keys (described inResourceActionconstructor), ornullif noneeditor- the text editor- See Also:
-
TextEditorAction
Creates and initializes the action for the given text editor. The action configures its visual representation from the given resource bundle.- Parameters:
bundle- the resource bundleprefix- a prefix to be prepended to the various resource keys (described inResourceActionconstructor), ornullif noneeditor- the text editorstyle- the style of this action- Since:
- 3.0
- See Also:
-
-
Method Details
-
getTextEditor
Returns the action's text editor.- Returns:
- the action's text editor
-
setEditor
Retargets this action to the given editor.- Parameters:
editor- the new editor, ornullif none
-
update
public void update()Always enables this action if it is connected to a text editor. If the associated editor isnull, the action is disabled. Subclasses may override. -
canModifyEditor
protected boolean canModifyEditor()Checks the editor's modifiable state. Returnstrueif the editor can be modified, taking in account the possible editor extensions.If the editor implements
ITextEditorExtension2, this method returnsITextEditorExtension2.isEditorInputModifiable();
else if the editor implementsITextEditorExtension, it returnsITextEditorExtension.isEditorInputReadOnly();
else,ITextEditor.isEditable()is returned, orfalseif the editor isnull.There is only a difference to
validateEditorInputState()if the editor implementsITextEditorExtension2.- Returns:
trueif a modifying action should be enabled,falseotherwise- Since:
- 3.0
-
validateEditorInputState
protected boolean validateEditorInputState()Checks and validates the editor's modifiable state. Returnstrueif an action can proceed modifying the editor's input,falseif it should not.If the editor implements
ITextEditorExtension2, this method returnsITextEditorExtension2.validateEditorInputState();
else if the editor implementsITextEditorExtension, it returnsITextEditorExtension.isEditorInputReadOnly();
else,ITextEditor.isEditable()is returned, orfalseif the editor isnull.There is only a difference to
canModifyEditor()if the editor implementsITextEditorExtension2.- Returns:
trueif a modifying action can proceed to modify the underlying document,falseotherwise- Since:
- 3.0
-