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.

Method Summary

Modifier and Type	Method and Description
IAutoDiagramFactory	getAutoDiagramFactory() Get the auto diagram factory.
IDiagramHandle	getDiagramHandle(AbstractDiagram diagram) Get a diagram handle on 'diagram'. It opens a new diagram editor in Modelio, or select it if already opened.
org.eclipse.gef.palette.PaletteEntry	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, MClass metaclass, Stereotype stereotype, String dependency, IAttachedBoxTool handler)
void	registerCustomizedTool(String id, MClass metaclass, Stereotype stereotype, String dependency, IBoxTool handler)
void	registerCustomizedTool(String id, MClass metaclass, Stereotype stereotype, String dependency, ILinkTool handler)
void	registerCustomizedTool(String id, MClass metaclass, Stereotype stereotype, String dependency, IMultiLinkTool handler)
void	registerDiagramContributor(ContributorCategory category, IDiagramWizardContributor contributor) Deprecated. use IEditionService#registerContributor
void	registerDiagramCustomization(Stereotype stereotype, MClass baseDiagramClass, IDiagramCustomizer customizer)
IStyleHandle	registerStyle(String styleName, String baseStyleName, File styleData) Register a new named style along with its 'data' file.
void	unregisterCustomizedTool(String id)
void	unregisterDiagramContributor(ContributorCategory category, IDiagramWizardContributor contributor) Deprecated. use IEditionService#unregisterContributor
void	unregisterDiagramCustomization(Stereotype stereotype, MClass baseDiagramClass, IDiagramCustomizer customizer)

Method Detail

getAutoDiagramFactory

IAutoDiagramFactory getAutoDiagramFactory()

Get the auto diagram factory.

Returns:

The auto diagram factory.

Since:

2.2

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.

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.

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

org.eclipse.gef.palette.PaletteEntry 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.

registerCustomizedTool

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

registerCustomizedTool

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

registerCustomizedTool

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

registerCustomizedTool

void registerCustomizedTool(String id,
                            MClass metaclass,
                            Stereotype stereotype,
                            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(String id)

registerDiagramContributor

@Deprecated
void registerDiagramContributor(ContributorCategory category,
                                            IDiagramWizardContributor contributor)

Deprecated. use IEditionService#registerContributor

Register diagram contributor

Parameters:

contributor -

category - of the diagram contributor

unregisterDiagramContributor

@Deprecated
void unregisterDiagramContributor(ContributorCategory category,
                                              IDiagramWizardContributor contributor)

Deprecated. use IEditionService#unregisterContributor

Unregister diagram contributor

Parameters:

contributor -

category - of the diagram contributor