org.modelio.api.module.command

Interface IModuleCommandHandler

All Known Implementing Classes:

AbstractCreateMatrixCommandHandler, ApplyPatternStandardHandler, CreateCustomMatrixCommandHandler, CreateMatrixStandardCommandHandler, DefaultModuleCommandHandler, DiagramCreationStandardHandler, ElementCreationStandardHandler, GenDocCommandStandardHandler, RunJythonScriptBasicHandler, RunJythonScriptStandardHandler

public interface IModuleCommandHandler

Base interface of all the module contextual commands.

The module contextual commands are displayed in the contextual menu and in the specific toolbar of each module property page.

The developer may inherit the DefaultModuleCommandHandler class which contains a default standard contextual command implementation.

Method Summary

Modifier and Type	Method and Description
boolean	accept(java.util.List<MObject> selectedElements, IModule module) This methods authorizes a command to be displayed in a defined context.
void	actionPerformed(java.util.List<MObject> selectedElements, IModule module) Method invoked when the command is launched.
java.util.Map<java.lang.String,java.lang.String>	getParameters()
java.util.List<ElementScope>	getScopes()
void	initialize(java.util.List<ElementScope> scopes, java.util.Map<java.lang.String,java.lang.String> hParameters) This method is called right after the constructor to initialize scopes and parameters for the handler.
boolean	isActiveFor(java.util.List<MObject> selectedElements, IModule module) This method precizes if a command has to be desactivated.

Method Detail

actionPerformed

void actionPerformed(java.util.List<MObject> selectedElements,
                     IModule module)

Method invoked when the command is launched.

This command is launched by Modelio when the user clicks on the contextual menu command. The selected elements that corresponds to the current selection are given as parameter.

The module that is passed as parameter corresponds to the owner of the command.

Parameters:

selectedElements - Current selection

module - Owner of the command

accept

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

This methods authorizes a command to be displayed in a defined context.

The commands are displayed, by default, depending on the kind of metaclass on which the command has been launched. If the module developer wants to refine the command activation depending on specific markers that can be defined on the selection (tagged value, specific properties...), it can be implemented in the accept method.

This method is invoked only if all the default filters are passed (if the kind of metaclass is valid)

Parameters:

selectedElements - Current selection

module - Owner of the command

Returns:

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

isActiveFor

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

This method precizes if a command has to be desactivated.

If the command has to be displayed (which means that the accept method has returned a positive value, it is sometimes needed to deactivate the command depending on specific constraints that are specific to the module.

This method is invoked only if all the default filters are passed (depending on the read only status of the tool and the objects)

Parameters:

selectedElements - Current selection

module - Owner of the command

Returns:

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

initialize

void initialize(java.util.List<ElementScope> scopes,
                java.util.Map<java.lang.String,java.lang.String> hParameters)

This method is called right after the constructor to initialize scopes and parameters for the handler.

getParameters

java.util.Map<java.lang.String,java.lang.String> getParameters()

getScopes

java.util.List<ElementScope> getScopes()