com.modeliosoft.modelio.api.diagram

Interface IDiagramService

public interface IDiagramService

This interface gives an entry point to manipulate the Modelio diagrams.
It also manages diagram customization and diagram styles.

Structure Diagram

Method Summary

Methods

Modifier and Type	Method and Description
IAutoDiagramFactory	getAutoDiagramFactory() Get the auto diagram factory.
IDiagramHandle	getDiagramHandle(IAbstractDiagram diagram) Get a diagram handle on 'diagram'.
ToolEntry	getRegisteredTool(String id) Get the palette tool from the given id.
IStyleHandle	getStyle(String name) Get an installed diagram styles from its name.
List<IStyleHandle>	listStyles() List all diagram styles that are currently installed.
void	registerCustomizedTool(String id, Class<? extends IElement> metaclass, IStereotype stereotype, String dep, IAttachedBoxCommand handler) Register a new palette 'attached box' Tool.
void	registerCustomizedTool(String id, Class<? extends IElement> metaclass, IStereotype stereotype, String dep, IBoxCommand handler) Register a new palette 'box' Tool.
void	registerCustomizedTool(String id, Class<? extends IElement> metaclass, IStereotype stereotype, String dep, ILinkCommand handler) Register a new palette 'link' Tool.
void	registerCustomizedTool(String id, Class<? extends IElement> metaclass, IStereotype stereotype, String dep, IMultiLinkCommand handler) Register a new palette 'multi link' Tool.
void	registerDiagramCustomization(IStereotype stereotype, Class<? extends IAbstractDiagram> baseDiagramClass, IDiagramCustomizer customizer) Register a customizer for a stereotyped diagram.
IStyleHandle	registerStyle(String styleName, String baseStyleName, File styleData) Register a new named style along with its 'data' file.
void	unregisterDiagramCustomization(IStereotype stereotype, Class<? extends IAbstractDiagram> baseDiagramClass, IDiagramCustomizer customizer) Unregister a customizer for a stereotyped diagram.

Method Detail

getAutoDiagramFactory

IAutoDiagramFactory getAutoDiagramFactory()

Get the auto diagram factory.

Returns:

The auto diagram factory.

Since:

2.2

getDiagramHandle

IDiagramHandle getDiagramHandle(IAbstractDiagram diagram)

Get a diagram handle on 'diagram'.
It opens a new diagram editor in Modelio, or select it if already opened.

Parameters:

diagram - the IAbstractDiagram to open.

Returns:

a diagram handle representing this diagram.

getRegisteredTool

ToolEntry getRegisteredTool(String id)

Get the palette tool from the given id.

Parameters:

id - An id.

Returns:

the found palette tool or null if none found.

getStyle

IStyleHandle getStyle(String name)

Get an installed diagram styles from its name.

Parameters:

name - the name of the style to look for.

Returns:

The style with the given name, or null if it isn't installed.

Since:

2.2

listStyles

List<IStyleHandle> listStyles()

List all diagram styles that are currently installed.

Returns:

A list of styles. Might be empty, but not null.

registerCustomizedTool

void registerCustomizedTool(String id,
                          Class<? extends IElement> metaclass,
                          IStereotype stereotype,
                          String dep,
                          IBoxCommand handler)

Register a new palette 'box' Tool.
The 'metaclass', 'stereotype' and 'dep' parameters are needed for the feedback mechanism when launching the tool interaction. Therefore, they should match as close as possible the created elements in the handler. A metamodel check based on the 'metaclass' to create is done beforehand by Modelio, which might trigger a 'red' feedback and prevent the handler to be called.

Parameters:

id - The new tool id.

metaclass - the metaclass of the element to create.

stereotype - an optional stereotype.

dep - the optional "parent to child" meta dependency used to attach the new element to its owner.

handler - The new 'box' tool behavior.

See Also:

IBoxCommand

registerCustomizedTool

void registerCustomizedTool(String id,
                          Class<? extends IElement> metaclass,
                          IStereotype stereotype,
                          String dep,
                          IAttachedBoxCommand handler)

Register a new palette 'attached box' Tool.
The 'metaclass', 'stereotype' and 'dep' parameters are needed for the feedback mechanism when launching the tool interaction. Therefore, they should match as close as possible the created elements in the handler.
A metamodel check based on the 'metaclass' to create is done beforehand by Modelio, which might trigger a 'red' feedback and prevent the handler to be called.

Parameters:

id - The new tool id.

metaclass - the metaclass of the element to create.

stereotype - an optional stereotype.

dep - the "parent to child" meta dependency used to attach the new element to its owner.

handler - The new 'attached box' tool behavior.

See Also:

IAttachedBoxCommand

registerCustomizedTool

void registerCustomizedTool(String id,
                          Class<? extends IElement> metaclass,
                          IStereotype stereotype,
                          String dep,
                          ILinkCommand handler)

Register a new palette 'link' Tool.
The 'metaclass', 'stereotype' and 'dep' parameters are needed for the feedback mechanism when launching the tool interaction. Therefore, they should match as close as possible the created elements in the handler.
A metamodel check based on the 'metaclass' to create is done beforehand by Modelio, which might trigger a 'red' feedback and prevent the handler to be called.

Parameters:

id - The new tool id.

metaclass - the metaclass of the element to create.

stereotype - an optional stereotype.

dep - the "parent to child" meta dependency used to attach the new element to its owner.

handler - The new 'link' tool behavior.

See Also:

ILinkCommand

registerCustomizedTool

void registerCustomizedTool(String id,
                          Class<? extends IElement> metaclass,
                          IStereotype stereotype,
                          String dep,
                          IMultiLinkCommand handler)

Register a new palette 'multi link' Tool.
The 'metaclass', 'stereotype' and 'dep' parameters are needed for the feedback mechanism when launching the tool interaction. Therefore, they should match as close as possible the created elements in the handler.
A metamodel check based on the 'metaclass' to create is done beforehand by Modelio, which might trigger a 'red' feedback and prevent the handler to be called.

Parameters:

id - The new tool id.

metaclass - the metaclass of the element to create.

stereotype - an optional stereotype.

dep - the "parent to child" meta dependency used to attach the new element to its owner.

handler - The new 'multi link' tool behavior.

See Also:

IMultiLinkCommand

registerDiagramCustomization

void registerDiagramCustomization(IStereotype stereotype,
                                Class<? extends IAbstractDiagram> baseDiagramClass,
                                IDiagramCustomizer customizer)

Register a customizer for a stereotyped diagram.

Parameters:

stereotype - the diagram stereotype which the customizer is intended for

baseDiagramClass - the base diagram editor to customize

customizer - the customizer implementation

registerStyle

IStyleHandle registerStyle(String styleName,
                         String baseStyleName,
                         File styleData)

Register a new named style along with its 'data' file.

Parameters:

styleName - then name of the style to register.

baseStyleName - the cascaded style.

styleData - the list of all properties defined in the style.

Returns:

then newly created IStyleHandle or null if the style could not be created. When the style already exists it is simply returned.

unregisterDiagramCustomization

void unregisterDiagramCustomization(IStereotype stereotype,
                                  Class<? extends IAbstractDiagram> baseDiagramClass,
                                  IDiagramCustomizer customizer)

Unregister a customizer for a stereotyped diagram.

Parameters:

stereotype - the diagram stereotype which the customizer is intended for

baseDiagramClass - the base diagram editor to customize

customizer - the customizer implementation