org.modelio.api.modelio.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.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TOOL_CREATE_DRAWING_ELLIPSE Tool that creates drawing ellipses.
static java.lang.String	TOOL_CREATE_DRAWING_LINE Tool that creates drawing lines.
static java.lang.String	TOOL_CREATE_DRAWING_RECTANGLE Tool that creates drawing rectangles.
static java.lang.String	TOOL_CREATE_DRAWING_TEXT Tool that creates drawing texts.
static java.lang.String	TOOL_POPUPMENU_CREATELINK ID of the link creation tool that shows popup menu to choose the kind of link.

Method Summary

Modifier and Type	Method and Description
IDiagramHandle	getDiagramHandle(AbstractDiagram diagram) Get a diagram handle on 'diagram'. It opens a new diagram editor in Modelio, or select it if already opened.
IModelViewTemplate<AbstractDiagram>	getDiagramTemplate(java.lang.String modelViewTemplateId) Get a Diagram Creator from its id.
PaletteEntry	getRegisteredTool(java.lang.String id) Get the palette tool from the given id.
IStyleHandle	getStyle(java.lang.String name) Get an installed diagram styles from its name.
java.util.List<IStyleHandle>	listStyles() List all diagram styles that are currently installed.
void	registerCustomizedTool(java.lang.String id, MClass metaclass, Stereotype stereotype, java.lang.String dependency, IAttachedBoxTool handler)
void	registerCustomizedTool(java.lang.String id, MClass metaclass, Stereotype stereotype, java.lang.String dependency, IBoxTool handler)
void	registerCustomizedTool(java.lang.String id, MClass metaclass, Stereotype stereotype, java.lang.String dependency, ILinkTool handler)
void	registerCustomizedTool(java.lang.String id, MClass metaclass, Stereotype stereotype, java.lang.String dependency, IMultiLinkTool handler)
void	registerDiagramContributor(ContributorCategory category, IDiagramWizardContributor contributor) Deprecated. use IEditionService.registerDiagramContributor(org.modelio.api.modelio.diagram.ContributorCategory, org.modelio.api.module.contributor.IWizardContributor)
void	registerDiagramCustomization(Stereotype stereotype, MClass baseDiagramClass, IDiagramCustomizer customizer)
IStyleHandle	registerStyle(java.lang.String styleName, java.lang.String baseStyleName, java.io.File styleData) Register a new named style along with its 'data' file.
void	unregisterCustomizedTool(java.lang.String id)
void	unregisterDiagramContributor(ContributorCategory category, IDiagramWizardContributor contributor) Deprecated. use IEditionService.unregisterDiagramContributor(org.modelio.api.modelio.diagram.ContributorCategory, org.modelio.api.module.contributor.IWizardContributor)
void	unregisterDiagramCustomization(Stereotype stereotype, MClass baseDiagramClass, IDiagramCustomizer customizer)

Field Detail

TOOL_CREATE_DRAWING_LINE

static final java.lang.String TOOL_CREATE_DRAWING_LINE

Tool that creates drawing lines.

Since:

3.6

See Also:

Constant Field Values

TOOL_CREATE_DRAWING_TEXT

static final java.lang.String TOOL_CREATE_DRAWING_TEXT

Tool that creates drawing texts.

Since:

3.6

See Also:

Constant Field Values

TOOL_CREATE_DRAWING_ELLIPSE

static final java.lang.String TOOL_CREATE_DRAWING_ELLIPSE

Tool that creates drawing ellipses.

Since:

3.6

See Also:

Constant Field Values

TOOL_CREATE_DRAWING_RECTANGLE

static final java.lang.String TOOL_CREATE_DRAWING_RECTANGLE

Tool that creates drawing rectangles.

Since:

3.6

See Also:

Constant Field Values

TOOL_POPUPMENU_CREATELINK

static final java.lang.String TOOL_POPUPMENU_CREATELINK

ID of the link creation tool that shows popup menu to choose the kind of link.

Since:

3.6

See Also:

Constant Field Values

Method Detail

getStyle

IStyleHandle getStyle(java.lang.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

java.util.List<IStyleHandle> listStyles()

List all diagram styles that are currently installed.

Returns:

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

registerStyle

IStyleHandle registerStyle(java.lang.String styleName,
                           java.lang.String baseStyleName,
                           java.io.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.

getDiagramHandle

IDiagramHandle getDiagramHandle(AbstractDiagram diagram)

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

Parameters:

diagram - the AbstractDiagram to open.

Returns:

a diagram handle representing this diagram.

getRegisteredTool

PaletteEntry getRegisteredTool(java.lang.String id)

Get the palette tool from the given id.

Parameters:

id - An id.

Returns:

the found palette tool or null if none found.

registerCustomizedTool

void registerCustomizedTool(java.lang.String id,
                            MClass metaclass,
                            Stereotype stereotype,
                            java.lang.String dependency,
                            IBoxTool handler)

registerCustomizedTool

void registerCustomizedTool(java.lang.String id,
                            MClass metaclass,
                            Stereotype stereotype,
                            java.lang.String dependency,
                            IAttachedBoxTool handler)

registerCustomizedTool

void registerCustomizedTool(java.lang.String id,
                            MClass metaclass,
                            Stereotype stereotype,
                            java.lang.String dependency,
                            ILinkTool handler)

registerCustomizedTool

void registerCustomizedTool(java.lang.String id,
                            MClass metaclass,
                            Stereotype stereotype,
                            java.lang.String dependency,
                            IMultiLinkTool handler)

registerDiagramCustomization

void registerDiagramCustomization(Stereotype stereotype,
                                  MClass baseDiagramClass,
                                  IDiagramCustomizer customizer)

unregisterDiagramCustomization

void unregisterDiagramCustomization(Stereotype stereotype,
                                    MClass baseDiagramClass,
                                    IDiagramCustomizer customizer)

unregisterCustomizedTool

void unregisterCustomizedTool(java.lang.String id)

registerDiagramContributor

@Deprecated
void registerDiagramContributor(ContributorCategory category,
                                            IDiagramWizardContributor contributor)

Deprecated. use IEditionService.registerDiagramContributor(org.modelio.api.modelio.diagram.ContributorCategory, org.modelio.api.module.contributor.IWizardContributor)

Register diagram contributor

Parameters:

category - of the diagram contributor

contributor - the diagram contributor

unregisterDiagramContributor

@Deprecated
void unregisterDiagramContributor(ContributorCategory category,
                                              IDiagramWizardContributor contributor)

Deprecated. use IEditionService.unregisterDiagramContributor(org.modelio.api.modelio.diagram.ContributorCategory, org.modelio.api.module.contributor.IWizardContributor)

Unregister diagram contributor

Parameters:

category - of the diagram contributor

contributor - the diagram contributor

getDiagramTemplate

IModelViewTemplate<AbstractDiagram> getDiagramTemplate(java.lang.String modelViewTemplateId)

Get a Diagram Creator from its id. Supported values are:

Creator identifier	Description
"ClassArchitectureDiagramTemplate"	A Class Architecture diagram shows how a class is made, what it consists of, what it is in terms of inheritance and its place in the project. For a class, it includes: The class itself in the center. Its public attributes. The parent classes/interfaces if any. The child classes/interfaces if any. The classes it is having an association to. The classes having any kind of association towards it.
"ClassStructureDiagramTemplate"	A Class Structure diagram shows how a class is made, what it consists of, what it is in terms of inheritance. For a class, it includes: The class itself in the center. Its public attributes. The parent classes/interfaces if any. The classes it is having an association to. The classes having a composition or aggregation towards it.
"CompositionNavigationDiagramTemplate"	A Composition diagram shows owned elements of a ModelTree. For a ModelTree, it includes: The owned ModelTrees layouted on a grid.
"DependencyDiagramTemplate"	A Dependency diagram shows incoming and outgoing dependencies of a NameSpace. For a NameSpace, it includes: The NameSpace itself in a central position. All elements having a dependency towards the NameSpace on the left. All elements having the NameSpace depends on on the right.
"InheritanceDiagramTemplate"	A Class Inheritance diagram shows where a Classifier is in its inheritance graph. For a Classifier, it includes: The Classifier itself in the center. The parent classes/interfaces if any. The parent sub-classes if any.
"PackageContentStructureDiagramTemplate"	A SubPackage Structure diagram shows the internal structure of a package, and the links between them. For a package, it includes: Its sub-classes/interfaces. The associations and inheritance relationships between them.
"SubPackageStructureDiagramTemplate"	A SubPackage Structure diagram shows the internal structure of a package in terms of packages, and the dependencies between them. For a package, it includes: Its sub-packages. The blue links (impact links) between those sub-packages.
"UseCaseFocusDiagramTemplate"	A 'Use Case close up' diagram shows for a UseCase: The use case itself. The actors associated to the use case The associations between actors and usecase

Parameters:

modelViewTemplateId - identifier of the diagram template.

Returns:

a new Diagram Creator. Might be null if the id is not found.

Since:

4.1