org.modelio.api.modelio.diagram

Interface IDGDynamicDecorator.IOverwrittenProperties

Enclosing interface:

IDGDynamicDecorator

public static interface IDGDynamicDecorator.IOverwrittenProperties

This is a context for the decorator, grouping the currently edited element and its overwritten graphical properties.

For performance issues, no IDiagramGraphic is instantiated at first, but calling getDG(IDiagramHandle) creates one.

Some setters need a String as property value to specify a font or a color. The passed value must then conform to the format used by org.eclipse.jface.resource.StringConverter.

Method Summary

Modifier and Type	Method and Description
IDiagramGraphic	getDG(IDiagramHandle diagram) Instantiate an IDiagramGraphic associated with the current element.
AbstractDiagram	getDiagram()
MObject	getElement()
void	setDrawLineBridges(boolean value) Indicates whereas bridge are drawn on vertical line segments that cross an horizontal one.
void	setFillColor(java.lang.String value) Modify the current fill color.
void	setFillMode(int value) Modify the current fill mode.
void	setFont(java.lang.String value) Modify the current font.
void	setLineColor(java.lang.String value) Modify the current line color.
void	setLinePattern(int value) Modify the current line pattern. - 0 : Line drawing style for solid lines - 1 : Line drawing style for dashed lines - 2 : Line drawing style for dotted lines - 3 : Line drawing style for alternating dash-dot lines - 4 : Line drawing style for dash-dot-dot lines
void	setLineRadius(int value) Modify the current line radius.
void	setLineWidth(int value) Modify the current line width.
void	setProperty(java.lang.String property, java.lang.String value) Sets the local property value of this graphic element for 'property'.
void	setTextColor(java.lang.String value) Modify the current text color.

Method Detail

getDG

IDiagramGraphic getDG(IDiagramHandle diagram)

Instantiate an IDiagramGraphic associated with the current element.

The caller needs to open an IDiagramHandle first, in order to handle the lifecycle of the graphical element.

Parameters:

diagram - an opened handle to instantiate the graphical model.

Returns:

an IDiagramGraphic.

getElement

MObject getElement()

Returns:

the element graphical properties are being overwritten for.

setProperty

void setProperty(java.lang.String property,
                 java.lang.String value)

Sets the local property value of this graphic element for 'property'.

Parameters:

property - The property name

value - The property value

setDrawLineBridges

void setDrawLineBridges(boolean value)

Indicates whereas bridge are drawn on vertical line segments that cross an horizontal one.

Parameters:

value - The new value of the draw line bridge property.

setFont

void setFont(java.lang.String value)
      throws DataFormatException

Modify the current font.

This method fails if the value does not represent font data.

A valid font data representation is a string of the form "fontname-style-height" where :

• fontname is the name of a font,
• style is a font style (one of "regular", "bold", "italic", or "bold italic")
• and height is an integer representing the font height.

Example: "Times New Roman-bold-36".

You may use StringConverter.asString(FontData) if you have a Font or a FontData.

Parameters:

value - The new font.

Throws:

DataFormatException - if the given value does not represent a font data

setLineColor

void setLineColor(java.lang.String value)

Modify the current line color.

You may use {@link org.eclipse.jface.resource.StringConverter#asString(org.eclipse.swt.graphics.RGB) to get a color specification with the needed format.

Parameters:

value - The new line color.

setLinePattern

void setLinePattern(int value)

Modify the current line pattern.
- 0 : Line drawing style for solid lines
- 1 : Line drawing style for dashed lines
- 2 : Line drawing style for dotted lines
- 3 : Line drawing style for alternating dash-dot lines
- 4 : Line drawing style for dash-dot-dot lines

Parameters:

value - The new line pattern.

setLineRadius

void setLineRadius(int value)

Modify the current line radius.

Parameters:

value - The new line radius.

setLineWidth

void setLineWidth(int value)

Modify the current line width.

Parameters:

value - The new line width.

setTextColor

void setTextColor(java.lang.String value)

Modify the current text color.

You may use {@link org.eclipse.jface.resource.StringConverter#asString(org.eclipse.swt.graphics.RGB) to get a color specification with the needed format.

Parameters:

value - The new text color.

setFillColor

void setFillColor(java.lang.String value)

Modify the current fill color.

You may use {@link org.eclipse.jface.resource.StringConverter#asString(org.eclipse.swt.graphics.RGB) to get a color specification with the needed format.

Parameters:

value - The new fill color.

setFillMode

void setFillMode(int value)

Modify the current fill mode. - 0 : The figure must be transparent.
- 1 : The figure is filled with a solid color.
- 2 : The figure is filled with a gradient.

Parameters:

value - The new fill mode.

getDiagram

AbstractDiagram getDiagram()

Returns:

the diagram properties are being overwritten into.