org.modelio.api.modelio.diagram.autodiagram

Interface IDiagramCreator

public interface IDiagramCreator

An IDiagramCreator provides the ability to create, update or get automatic diagrams from a model element.

Since:

2.2

See Also:

IAutoDiagramFactory

Method Summary

Modifier and Type	Method and Description
AbstractDiagram	createDiagram(ModelElement main) Create or update an automatic diagram for the given element.
ModelElement	getAutoDiagramContext(ModelElement main) Get The context of the current auto diagram this creator is managing.
String	getAutoDiagramGroup() Get The name of the current auto diagram this creator is managing.
String	getAutoDiagramName() Get The type of the current auto diagram this creator is managing.
AbstractDiagram	getExistingAutoDiagram(ModelElement main) Get the current auto diagram centered on the given element.
ModelElement	getMainElement(AbstractDiagram autoDiagram) Get the element the auto diagram was created from.

Method Detail

getAutoDiagramName

String getAutoDiagramName()

Get The type of the current auto diagram this creator is managing.

Returns:

the current auto diagram type.

createDiagram

AbstractDiagram createDiagram(ModelElement main)

Create or update an automatic diagram for the given element.

Only one automatic diagram of the current type can be created for an element.

Parameters:

main - The element to center the automatic diagram on.

Returns:

The corresponding automatic diagram.

getExistingAutoDiagram

AbstractDiagram getExistingAutoDiagram(ModelElement main)

Get the current auto diagram centered on the given element.

Parameters:

main - The element to look a diagram for.

Returns:

The corresponding automatic diagram.

getAutoDiagramGroup

String getAutoDiagramGroup()

Get The name of the current auto diagram this creator is managing.

Returns:

the current auto diagram name.

getAutoDiagramContext

ModelElement getAutoDiagramContext(ModelElement main)

Get The context of the current auto diagram this creator is managing.

Returns:

the current auto diagram context.

getMainElement

ModelElement getMainElement(AbstractDiagram autoDiagram)

Get the element the auto diagram was created from.

Parameters:

main - An automatic diagram.

Returns:

The element the auto diagram was created from.