Class 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.

  • Constructor Details

    • 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 bundle
      prefix - a prefix to be prepended to the various resource keys (described in ResourceAction constructor), or null if none
      editor - the text editor
      operationCode - the operation code
      See Also:
    • 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 bundle
      prefix - a prefix to be prepended to the various resource keys (described in ResourceAction constructor), or null if none
      editor - the text editor
      operationCode - the operation code
      runsOnReadOnly - true if action can be executed on read-only files
      Since:
      2.0
      See Also:
  • Method Details

    • run

      public void run()
      The TextOperationAction implementation of this IAction method runs the operation with the current operation code.
      Specified by:
      run in interface IAction
      Overrides:
      run in class Action
      See Also:
    • 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.
      Specified by:
      update in interface IUpdate
      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
      Parameters:
      editor - the new editor, or null if none