org.modelio.api.modelio.diagram

Interface IDiagramGraphicFactory

public interface IDiagramGraphicFactory

Factory to create or unmask graphic objects.

Since:

3.1

Method Summary

Modifier and Type	Method and Description
IDiagramNode	createDrawingEllipse(IDiagramDrawingsLayer layer, String drawingIdentifier, int x, int y, int w, int h) Creates a drawing ellipse.
IDiagramLink	createDrawingLine(IDiagramDrawingsLayer layer, String drawingIdentifier, int x, int y, int x2, int y2) Creates a drawing line
IDiagramNode	createDrawingRectangle(IDiagramDrawingsLayer layer, String drawingIdentifier, int x, int y, int w, int h) Creates a drawing rectangle.
IDiagramNode	createDrawingText(IDiagramDrawingsLayer layer, String drawingIdentifier, String label, int x, int y, int w, int h) Creates a drawing rectangle.
List<IDiagramGraphic>	unmask(MObject element, int x, int y) Unmask a model element in a diagram.

Method Detail

createDrawingRectangle

IDiagramNode createDrawingRectangle(IDiagramDrawingsLayer layer,
                                    String drawingIdentifier,
                                    int x,
                                    int y,
                                    int w,
                                    int h)

Creates a drawing rectangle.

Parameters:

layer - the layer to use

drawingIdentifier - An identifier unique in the diagram, to be able to look for the graphic later. If null, an identifier will be automatically generated.

x - the x coordinates of the top left corner.

y - the y coordinates of the top left corner.

w - the node width

h - the node height

Returns:

the created graphic node.

createDrawingEllipse

IDiagramNode createDrawingEllipse(IDiagramDrawingsLayer layer,
                                  String drawingIdentifier,
                                  int x,
                                  int y,
                                  int w,
                                  int h)

Creates a drawing ellipse.

Parameters:

layer - the layer to use

drawingIdentifier - An identifier unique in the diagram, to be able to look for the graphic later. If null, an identifier will be automatically generated.

x - the x coordinates of the graphic position.

y - the y coordinates of the graphic position.

w - the node width

h - the node height

Returns:

the created graphic node.

createDrawingText

IDiagramNode createDrawingText(IDiagramDrawingsLayer layer,
                               String drawingIdentifier,
                               String label,
                               int x,
                               int y,
                               int w,
                               int h)

Creates a drawing rectangle.

Parameters:

layer - the layer to use

drawingIdentifier - An identifier unique in the diagram, to be able to look for the graphic later. If null, an identifier will be automatically generated.

label - the text label

x - the x coordinates of the graphic position.

y - the y coordinates of the graphic position.

w - the node width

h - the node height

Returns:

the created graphic node.

createDrawingLine

IDiagramLink createDrawingLine(IDiagramDrawingsLayer layer,
                               String drawingIdentifier,
                               int x,
                               int y,
                               int x2,
                               int y2)

Creates a drawing line

Parameters:

layer - the layer to use

drawingIdentifier - An identifier unique in the diagram, to be able to look for the graphic later. If null, an identifier will be automatically generated.

x - the x coordinates of the first point.

y - the y coordinates of the first point.

x2 - the x coordinates of the second point.

y2 - the y coordinates of the second point.

Returns:

the created line.

unmask

List<IDiagramGraphic> unmask(MObject element,
                             int x,
                             int y)

Unmask a model element in a diagram.

The model element is unmasked at the given position.

Parameters:

element - the model element to unmask.

x - the x coordinates of the unmasking position.

y - the y coordinates of the unmasking position.

Returns:

a list of all the new diagram graphics. Might be empty, but not null.