org.eclipse.ui.texteditor
Class TextEditorAction

java.lang.Object
  |
  +--org.eclipse.jface.action.Action
        |
        +--org.eclipse.ui.texteditor.ResourceAction
              |
              +--org.eclipse.ui.texteditor.TextEditorAction

All Implemented Interfaces:

IAction, IUpdate

Direct Known Subclasses:

AddMarkerAction, ContentAssistAction, ConvertLineDelimitersAction, DeleteLineAction, GotoLineAction, MarkAction, RevertToSavedAction, SaveAction, ShiftAction, TextOperationAction

public abstract class TextEditorAction

extends ResourceAction

implements IUpdate

Sekelleton of a standard text editor action. The action is initially associated with a text editor via the constructor, but can subsequently be changed using setEditor. Subclasses must implement the run method and if required override the update method.

Field Summary

Fields inherited from interface org.eclipse.jface.action.IAction

AS_CHECK_BOX, AS_DROP_DOWN_MENU, AS_PUSH_BUTTON, CHECKED, DESCRIPTION, ENABLED, IMAGE, TEXT, TOOL_TIP_TEXT

Constructor Summary

protected

TextEditorAction(ResourceBundle bundle, String prefix, ITextEditor editor) Creates and initializes the action for the given text editor.

Method Summary

protected ITextEditor	getTextEditor() Returns the action's text editor.
void	setEditor(ITextEditor editor) Retargets this action to the given editor.
void	update() Always enables this action if it is connected to a text editor.

Methods inherited from class org.eclipse.ui.texteditor.ResourceAction

getString, setHelpContextId

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, run, 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

Constructor Detail

TextEditorAction

protected TextEditorAction(ResourceBundle bundle,
                           String prefix,
                           ITextEditor editor)

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 bundle

prefix - a prefix to be prepended to the various resource keys (described in ResourceAction constructor), or null if none

editor - the text editor

See Also:

ResourceAction.ResourceAction(java.util.ResourceBundle, java.lang.String)

Method Detail

getTextEditor

protected ITextEditor getTextEditor()

Returns the action's text editor.

Returns:

the action's text editor

setEditor

public void setEditor(ITextEditor editor)

Retargets this action to the given editor.

Parameters:

editor - the new editor, or null if none

update

public void update()

Always enables this action if it is connected to a text editor. If the asocciated editor is null, the action is disabled. Subclasses may override.

Specified by:

update in interface IUpdate