org.modelio.api.modelio.diagram.dg

Interface IDiagramDG

All Superinterfaces:

IDiagramGraphic, IDiagramNode

public interface IDiagramDG
extends IDiagramNode

This class represents a diagram graphic for the diagram itself.

A IDiagramDG id a IDiagramNode, root nodes can be retrieved using IDiagramNode.getNodes().

Since Modelio 3.1 a diagram contains layers containing either elements graphics or drawing, graphics ordered from background to foreground:

• a IDiagramDrawingsLayer.BACKGROUND drawing layer. It can contain only drawings
• a IDiagramElementsLayer.MAIN elements graphic layer. It can contain only model graphics.
• a IDiagramDrawingsLayer.TOP drawing layer. It can contain only drawings

In future versions, a diagram will be able to contain more layers.

Nested Class Summary

Nested classes/interfaces inherited from interface org.modelio.api.modelio.diagram.IDiagramNode

IDiagramNode.Role

Method Summary

Modifier and Type	Method and Description
IDiagramDrawingsLayer	getDrawingsLayer(java.lang.String layerIdentifier) Get the diagram drawings layer identified by the provided string.
IDiagramElementsLayer	getElementsLayer(java.lang.String layerIdentifier) Get the diagram elements layer identified by the provided string.
IDiagramLayer	getLayer(java.lang.String layerIdentifier) Get the diagram layer identified by the provided string.
java.util.List<IDiagramLayer>	getLayers() Get all diagram layers.
java.util.List<IDiagramLink>	getLinks() Return the list of children links of this diagram.

Methods inherited from interface org.modelio.api.modelio.diagram.IDiagramNode

fitToContent, getBounds, getElement, getFillColor, getFillMode, getFirstNode, getFont, getLineColor, getLineWidth, getNodes, getNodes, getOverallBounds, getParent, getRepresentationMode, getTextColor, isPrimarySelected, isSelected, mask, setBounds, setFillColor, setFillMode, setFont, setLineColor, setLineWidth, setLocation, setRepresentationMode, setSize, setTextColor

Methods inherited from interface org.modelio.api.modelio.diagram.IDiagramGraphic

getFromLinks, getHyperLink, getLayer, getLocalPropertyNames, getName, getProperty, getStyle, getToLinks, moveToLayer, normalizeLocalProperties, resetLocalProperties, setHyperLink, setProperty, setStyle

Method Detail

getLinks

java.util.List<IDiagramLink> getLinks()

Return the list of children links of this diagram.

Returns:

A list of links in any case, possibly an empty one. Never returns null

getLayers

java.util.List<IDiagramLayer> getLayers()

Get all diagram layers.

The returned list is ordered from the background layer to the top layer.

Returns:

A list of diagram layer .

Since:

3.1

getLayer

IDiagramLayer getLayer(java.lang.String layerIdentifier)

Get the diagram layer identified by the provided string.

Identifier constants are provided in IDiagramDrawingsLayer and IDiagramElementsLayer.

Parameters:

layerIdentifier - the layer identifier.

Returns:

the matching diagram layer or null.

Since:

3.1

getDrawingsLayer

IDiagramDrawingsLayer getDrawingsLayer(java.lang.String layerIdentifier)

Get the diagram drawings layer identified by the provided string.

Identifier constants are provided in IDiagramDrawingsLayer.

Parameters:

layerIdentifier - the layer identifier.

Returns:

the matching diagram layer or null.

Since:

3.1

getElementsLayer

IDiagramElementsLayer getElementsLayer(java.lang.String layerIdentifier)

Get the diagram elements layer identified by the provided string.

Identifier constants are provided in IDiagramElementsLayer.

Parameters:

layerIdentifier - the layer identifier.

Returns:

the matching diagram layer or null.

Since:

3.1