org.modelio.api.module.command

Class DefaultModuleAction

java.lang.Object

org.modelio.api.module.command.DefaultModuleAction

All Implemented Interfaces:

IModuleAction

public class DefaultModuleAction
extends java.lang.Object
implements IModuleAction

Default implementation of the IModuleAction interface.

Constructor Summary

Constructors

Constructor and Description
DefaultModuleAction(IModule module, java.lang.String name, java.lang.String label, java.lang.String tooltip, java.lang.String bitmapPath, java.lang.String slotPattern, java.lang.String slotImagePaths, boolean needReadWriteObject, boolean editTheModel, IModuleCommandHandler command)

Method Summary

Modifier and Type	Method and Description
boolean	accept(MObject[] selectedElements)
java.nio.file.Path	getBitmapPath()
IModuleCommandHandler	getHandler()
java.lang.String	getLabel()
IModule	getModule()
java.lang.String	getName()
java.nio.file.Path	getSlotImagePath(int slotIndex)
java.util.List<java.lang.String>	getSlots()
java.lang.String	getTooltip()
boolean	isActiveFor(MObject[] selectedElements, boolean readOnlyTool)
boolean	needReadWriteObject()
void	parseSlotImagePaths(java.lang.String slotImagePathPatterns)
void	parseSlotPattern(java.lang.String slotPattern)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultModuleAction

public DefaultModuleAction(IModule module,
                           java.lang.String name,
                           java.lang.String label,
                           java.lang.String tooltip,
                           java.lang.String bitmapPath,
                           java.lang.String slotPattern,
                           java.lang.String slotImagePaths,
                           boolean needReadWriteObject,
                           boolean editTheModel,
                           IModuleCommandHandler command)

Parameters:

module - the module

name - the action name

label - the label

tooltip - the tooltip

bitmapPath - the icon

slotPattern - the sub menu path

slotImagePaths - the slot images path

needReadWriteObject - whether the target must be writeable

editTheModel - whether the command modifies the model

command - the command handler

Method Detail

accept

public final boolean accept(MObject[] selectedElements)

Specified by:

accept in interface IModuleAction

getBitmapPath

public java.nio.file.Path getBitmapPath()

Specified by:

getBitmapPath in interface IModuleAction

getHandler

public IModuleCommandHandler getHandler()

Specified by:

getHandler in interface IModuleAction

getLabel

public java.lang.String getLabel()

Specified by:

getLabel in interface IModuleAction

getModule

public IModule getModule()

Specified by:

getModule in interface IModuleAction

getName

public java.lang.String getName()

Specified by:

getName in interface IModuleAction

getSlotImagePath

public java.nio.file.Path getSlotImagePath(int slotIndex)

Specified by:

getSlotImagePath in interface IModuleAction

getSlots

public java.util.List<java.lang.String> getSlots()

Specified by:

getSlots in interface IModuleAction

getTooltip

public java.lang.String getTooltip()

Specified by:

getTooltip in interface IModuleAction

isActiveFor

public final boolean isActiveFor(MObject[] selectedElements,
                                 boolean readOnlyTool)

Specified by:

isActiveFor in interface IModuleAction

needReadWriteObject

public boolean needReadWriteObject()

Specified by:

needReadWriteObject in interface IModuleAction

parseSlotPattern

public void parseSlotPattern(java.lang.String slotPattern)

Specified by:

parseSlotPattern in interface IModuleAction

parseSlotImagePaths

public void parseSlotImagePaths(java.lang.String slotImagePathPatterns)

Specified by:

parseSlotImagePaths in interface IModuleAction