org.modelio.api.module.command.standard

Class RunJythonScriptStandardHandler

java.lang.Object

org.modelio.api.module.command.DefaultModuleCommandHandler

org.modelio.api.module.command.standard.RunJythonScriptBasicHandler

org.modelio.api.module.command.standard.RunJythonScriptStandardHandler

All Implemented Interfaces:

IModuleCommandHandler

public class RunJythonScriptStandardHandler
extends RunJythonScriptBasicHandler

Command handler that runs a Jython script.

The jython script must be in the SCRIPT_PARAM command parameter.

Used parameters:

• "accept" : Jython script called by accept(List, IModule)
• "isActiveFor" : Jython script called by isActiveFor(List, IModule)

The scripts are run with the bindings configured by RunJythonScriptBasicHandler.configure(ScriptEngine, List, IModule).

Since:

3.4

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACCEPT_PARAM Command parameter containing the Jython script called by accept(List, IModule).
static java.lang.String	IS_ACTIVE_FOR_PARAM Command parameter containing the Jython script called by isActiveFor(List, IModule).

Fields inherited from class org.modelio.api.module.command.standard.RunJythonScriptBasicHandler

SCRIPT_PARAM

Constructor Summary

Constructors

Constructor and Description
RunJythonScriptStandardHandler()

Method Summary

Modifier and Type	Method and Description
boolean	accept(java.util.List<MObject> selectedElements, IModule module) The handler accepts elements matching at least one scope
boolean	isActiveFor(java.util.List<MObject> selectedElements, IModule module) The handler is active by default.

Methods inherited from class org.modelio.api.module.command.standard.RunJythonScriptBasicHandler

actionPerformed, configure, runBooleanScript

Methods inherited from class org.modelio.api.module.command.DefaultModuleCommandHandler

findStereotypeFromSpec, getParameter, getParameters, getScopes, initialize

Methods inherited from class java.lang.Object

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

Field Detail

IS_ACTIVE_FOR_PARAM

public static final java.lang.String IS_ACTIVE_FOR_PARAM

Command parameter containing the Jython script called by isActiveFor(List, IModule).

See Also:

Constant Field Values

ACCEPT_PARAM

public static final java.lang.String ACCEPT_PARAM

Command parameter containing the Jython script called by accept(List, IModule).

See Also:

Constant Field Values

Constructor Detail

RunJythonScriptStandardHandler

public RunJythonScriptStandardHandler()

Method Detail

accept

public boolean accept(java.util.List<MObject> selectedElements,
                      IModule module)

Description copied from class: DefaultModuleCommandHandler

The handler accepts elements matching at least one scope

Specified by:

accept in interface IModuleCommandHandler

Overrides:

accept in class DefaultModuleCommandHandler

Parameters:

selectedElements - Current selection

module - Owner of the command

Returns:

true if the command is valid for all the elements, false otherwise.

isActiveFor

public boolean isActiveFor(java.util.List<MObject> selectedElements,
                           IModule module)

Description copied from class: DefaultModuleCommandHandler

The handler is active by default.

Specified by:

isActiveFor in interface IModuleCommandHandler

Overrides:

isActiveFor in class DefaultModuleCommandHandler

Parameters:

selectedElements - Current selection

module - Owner of the command

Returns:

false if the command has to be grayed, false otherwise.