Module jEdit

Package org.gjt.sp.jedit

Class BeanShellAction

java.lang.Object

org.gjt.sp.jedit.JEditAbstractEditAction<View>

org.gjt.sp.jedit.EditAction

org.gjt.sp.jedit.BeanShellAction

public class BeanShellAction
extends EditAction

An action that evaluates BeanShell code when invoked. BeanShell actions are usually loaded from actions.xml and browser.actions.xml files; see ActionSet for syntax information.

Version:

$Id: BeanShellAction.java 25106 2020-03-31 22:35:31Z kpouer $

Author:

Slava Pestov

See Also:

• jEdit.getAction(String)
• jEdit.getActionNames()
• ActionSet

Nested Class Summary

Nested classes/interfaces inherited from class org.gjt.sp.jedit.EditAction

EditAction.Wrapper

Field Summary

Fields inherited from class org.gjt.sp.jedit.JEditAbstractEditAction

args, name

Constructor Summary

Constructors

Constructor	Description
BeanShellAction(String name, String code, String isSelected, boolean noRepeat, boolean noRecord, boolean noRememberLast)

Method Summary

Modifier and Type	Method	Description
String	getCode()
void	invoke(View view)	Invokes the action.
boolean	isSelected(Component comp)
boolean	noRecord()
boolean	noRememberLast()	Returns if this edit action should not be remembered as the most recently invoked action.
boolean	noRepeat()

Methods inherited from class org.gjt.sp.jedit.EditAction

getLabel, getMouseOverText, getToolTip, isToggle

Methods inherited from class org.gjt.sp.jedit.JEditAbstractEditAction

getName, invoke, setName, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

BeanShellAction

public BeanShellAction(String name,
 String code,
 String isSelected,
 boolean noRepeat,
 boolean noRecord,
 boolean noRememberLast)

Method Details

invoke

public void invoke(View view)

Description copied from class: EditAction

Invokes the action. This is an implementation of the Command pattern, and concrete actions should override this.

Specified by:

invoke in class EditAction

Parameters:

view - The view

isSelected

public boolean isSelected(Component comp)

Overrides:

isSelected in class EditAction

Parameters:

comp - The component

Returns:

If this edit action is a toggle, returns if it is selected or not.

noRepeat

public boolean noRepeat()

Overrides:

noRepeat in class EditAction

Returns:

if this edit action should not be repeated. Returns false by default.

noRecord

public boolean noRecord()

Overrides:

noRecord in class EditAction

Returns:

if this edit action should not be recorded. Returns false by default.

noRememberLast

public boolean noRememberLast()

Returns if this edit action should not be remembered as the most recently invoked action.

Overrides:

noRememberLast in class EditAction

Returns:

if this edit action should not be remembered as the most recently invoked action.

Since:

jEdit 4.2pre1

getCode

public String getCode()

Overrides:

getCode in class EditAction

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