Module jEdit
Package org.gjt.sp.jedit

Class EditAction

java.lang.Object
org.gjt.sp.jedit.JEditAbstractEditAction<View>
org.gjt.sp.jedit.EditAction
Direct Known Subclasses:
BeanShellAction, Macros.Macro
public abstract class EditAction extends JEditAbstractEditAction<View>
An action that can be bound to a menu item, tool bar button or keystroke.
Version:
$Id: EditAction.java 24750 2017-10-12 09:46:15Z ezust $
Author:
Slava Pestov
See Also:

  • Constructor Details

    • EditAction

      public EditAction(String name)
      Creates a new edit action with the specified name.
      Parameters:
      name - The action name

    • EditAction

      public EditAction(String name, Object[] newArgs)

  • Method Details

    • getLabel

      public String getLabel()
      Returns:
      the action's label. This returns the value of the property named by JEditAbstractEditAction.getName() suffixed with .label.

    • getMouseOverText

      public final String getMouseOverText()
      Returns:
      the action's mouse over message. This returns the value of the property named by JEditAbstractEditAction.getName() suffixed with .mouse-over.

    • getToolTip

      public String getToolTip()
      Returns:
      the action's tooltip text. This returns the value of the property named by JEditAbstractEditAction.getName() suffixed with .tooltip.

    • invoke

      public abstract void invoke(View view)
      Invokes the action. This is an implementation of the Command pattern, and concrete actions should override this.
      Specified by:
      invoke in class JEditAbstractEditAction<View>
      Parameters:
      view - The view
      Since:
      jEdit 2.7pre2 abstract since jEdit 4.3pre7

    • isToggle

      public final boolean isToggle()
      Returns:
      if this edit action should be displayed as a check box in menus. This returns the value of the property named by JEditAbstractEditAction.getName() suffixed with .toggle.
      Since:
      jEdit 2.2pre4

    • isSelected

      public boolean isSelected(Component comp)
      Parameters:
      comp - The component
      Returns:
      If this edit action is a toggle, returns if it is selected or not.
      Since:
      jEdit 4.2pre1

    • noRepeat

      public boolean noRepeat()
      Returns:
      if this edit action should not be repeated. Returns false by default.
      Since:
      jEdit 2.7pre2

    • noRecord

      public boolean noRecord()
      Returns:
      if this edit action should not be recorded. Returns false by default.
      Since:
      jEdit 2.7pre2

    • noRememberLast

      public boolean noRememberLast()
      Returns:
      if this edit action should not be remembered as the most recently invoked action.
      Since:
      jEdit 4.2pre1

    • getCode

      public String getCode()
      Returns:
      the BeanShell code that will replay this action. BeanShellAction.getCode() returns something more interesting for Actions that were loaded from the actions.xml file. You do not need to override this method if your action name is unique, this EditAction was added to an ActionSet and that to an ActionContext of jEdit. concrete since jEdit 4.3pre7
      Since:
      jEdit 2.7pre2