org.modelio.api.modelio.diagram.tools

Interface IDiagramTool

All Known Subinterfaces:

IAttachedBoxTool, IBoxTool, ILinkTool, IMultiLinkTool

All Known Implementing Classes:

DefaultAttachedBoxTool, DefaultBoxTool, DefaultDiagramTool, DefaultLinkTool, DefaultMultiLinkTool, GenericAttachedBoxTool, GenericBoxTool, GenericLinkTool, GenericMultiLinkTool

public interface IDiagramTool

Basic definition of a command for the diagram palette.
It must provide a label, a tooltip and a bitmap.

Method Summary

Modifier and Type	Method and Description
void	decorate(java.lang.String label, java.lang.String tooltip, ImageDescriptor image)
ImageDescriptor	getBitmap() Get the command's bitmap.
java.lang.String	getLabel() Get the name of the command.
IModule	getModule()
java.util.Map<java.lang.String,java.lang.String>	getParameters()
java.util.List<ElementScope>	getSourceScopes()
java.util.List<ElementScope>	getTargetScopes()
java.lang.String	getTooltip() Gets the tooltip of this command.
void	initialize(java.util.List<ElementScope> sourceScopes, java.util.List<ElementScope> targetScopes, java.util.Map<java.lang.String,java.lang.String> parameters, IModule module)

Method Detail

decorate

void decorate(java.lang.String label,
              java.lang.String tooltip,
              ImageDescriptor image)

initialize

void initialize(java.util.List<ElementScope> sourceScopes,
                java.util.List<ElementScope> targetScopes,
                java.util.Map<java.lang.String,java.lang.String> parameters,
                IModule module)

getBitmap

ImageDescriptor getBitmap()

Get the command's bitmap.

Returns:

the bitmap ImageDescriptor.

getLabel

java.lang.String getLabel()

Get the name of the command.

Returns:

the name of the command.

getParameters

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

getSourceScopes

java.util.List<ElementScope> getSourceScopes()

getTargetScopes

java.util.List<ElementScope> getTargetScopes()

getTooltip

java.lang.String getTooltip()

Gets the tooltip of this command.

Returns:

the text that will be displayed in the command's tooltip.

getModule

IModule getModule()