org.modelio.api.modelio.diagram.tools

Class DefaultDiagramTool

java.lang.Object

org.modelio.api.modelio.diagram.tools.DefaultDiagramTool

All Implemented Interfaces:

IDiagramTool

Direct Known Subclasses:

DefaultAttachedBoxTool, DefaultBoxTool, DefaultLinkTool, DefaultMultiLinkTool

public abstract class DefaultDiagramTool
extends java.lang.Object
implements IDiagramTool

Base implementation of IDiagramTool.

Constructor Summary

Constructors

Constructor and Description
DefaultDiagramTool()

Method Summary

Modifier and Type	Method and Description
void	decorate(java.lang.String label, java.lang.String tooltip, ImageDescriptor image)
protected Stereotype	findStereotypeFromSpec(MClass metaclass, java.lang.String stereotypeSpec) Find the stereotype from a stereotype specification.
ImageDescriptor	getBitmap() Get the command's bitmap.
java.lang.String	getLabel() Get the name of the command.
IModule	getModule()
java.lang.String	getParameter(java.lang.String key) Convenience to get a parameter value.
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)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultDiagramTool

public DefaultDiagramTool()

Method Detail

getParameter

public java.lang.String getParameter(java.lang.String key)

Convenience to get a parameter value.

Parameters:

key - the parameter

Returns:

the value or null.

decorate

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

Specified by:

decorate in interface IDiagramTool

initialize

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

Specified by:

initialize in interface IDiagramTool

getModule

public IModule getModule()

Specified by:

getModule in interface IDiagramTool

findStereotypeFromSpec

protected final Stereotype findStereotypeFromSpec(MClass metaclass,
                                                  java.lang.String stereotypeSpec)

Find the stereotype from a stereotype specification.

The stereotype specification may have one of the following formats:

• stereotype name
• module name#stereotype name
• module regex#stereotype name
• module regex#stereotype regex

Returns null if the specification is null or the stereotype is not found.

Parameters:

metaclass - the metaclass to look from

stereotypeSpec - the stereotype specification

Returns:

the found stereotype or null.

getParameters

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

Specified by:

getParameters in interface IDiagramTool

getTooltip

public java.lang.String getTooltip()

Description copied from interface: IDiagramTool

Gets the tooltip of this command.

Specified by:

getTooltip in interface IDiagramTool

Returns:

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

getLabel

public java.lang.String getLabel()

Description copied from interface: IDiagramTool

Get the name of the command.

Specified by:

getLabel in interface IDiagramTool

Returns:

the name of the command.

getSourceScopes

public java.util.List<ElementScope> getSourceScopes()

Specified by:

getSourceScopes in interface IDiagramTool

getTargetScopes

public java.util.List<ElementScope> getTargetScopes()

Specified by:

getTargetScopes in interface IDiagramTool

getBitmap

public ImageDescriptor getBitmap()

Description copied from interface: IDiagramTool

Get the command's bitmap.

Specified by:

getBitmap in interface IDiagramTool

Returns:

the bitmap ImageDescriptor.