com.nomagic.magicdraw.core.options

Class OrthogonalLayouterOptionsGroup

java.lang.Object

com.nomagic.magicdraw.core.options.OptionsGroup

com.nomagic.magicdraw.core.options.AbstractPropertyOptionsGroup

com.nomagic.magicdraw.core.options.AbstractDiagramLayouterOptionsGroup

com.nomagic.magicdraw.core.options.OrthogonalLayouterOptionsGroup

All Implemented Interfaces:

java.lang.Cloneable

@OpenApiAll
public class OrthogonalLayouterOptionsGroup
extends AbstractDiagramLayouterOptionsGroup

Organic Layouter options group.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ID
static java.lang.String	LAYOUT_STYLE_NORMAL
static java.lang.String	LAYOUT_STYLE_NORMAL_TREE

Fields inherited from class com.nomagic.magicdraw.core.options.AbstractDiagramLayouterOptionsGroup

ALIGNMENT_BOTTOM, ALIGNMENT_CENTER, ALIGNMENT_TOP, MAX_INT_VALUE, SHAPE_ALIGNMENT

Constructor Summary

Constructors

Constructor and Description
OrthogonalLayouterOptionsGroup()

Method Summary

Modifier and Type	Method and Description
void	addProperty(Property property) Adds property to this group.
boolean	getCrossingPostprocessing() Get Crossing Post precessing property value.
int	getGrid() Get Grid property value.
double	getGroupLayoutQuality() Get the desired layout quality.
java.lang.String	getLayoutStyle() Get String representation of layout style.
boolean	getLinkLengthReduction() Get Link Length Reduction Property value.
boolean	getUseExistingDrawingAsSketch() Get Use Existing Drawing As Sketch property value..
boolean	getUseRandomization() Get use Randomization property value.
boolean	isLayoutOnlyTopLevel() Check Layout Only Top Level property value.
void	setCrossingPostprocessing(boolean b) Set Crossing Post precessing property value.
void	setDefaultValues() Sets default values for the properties contained in this group.
void	setGrid(int d) Set Grid property value.
void	setGroupLayoutQuality(double d) Set the desired layout quality.
void	setLayoutOnlyTopLevel(boolean b) Set Layout Only Top Level property value in order to keeps the relative position of symbols inside packages and performs the top level layout.
void	setLayoutStyle(java.lang.String style) Set Layout stylel
void	setLinkLengthReduction(boolean b) Set Link Length Reduction Property value.
void	setUseExistingDrawingAsSketch(boolean b) Set Use Existing Drawing As Sketch property value..
void	setUseRandomization(boolean b) Set use Randomization property value.

Methods inherited from class com.nomagic.magicdraw.core.options.AbstractDiagramLayouterOptionsGroup

getMakePreferredLayoutSize, isMoveToFreeSpace, setMakePreferredLayoutSize, setMoveToFreeSpace

Methods inherited from class com.nomagic.magicdraw.core.options.AbstractPropertyOptionsGroup

addInvisibleProperty, addProperty, addProperty, getOptions, getProperty, getVisibleOptions, removeProperty, setOptions, setPropertiesInvisible, setPropertyInvisible

Methods inherited from class com.nomagic.magicdraw.core.options.OptionsGroup

getGroupIcon, getIcon, getName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ID

public static final java.lang.String ID

See Also:

Constant Field Values

LAYOUT_STYLE_NORMAL

public static final java.lang.String LAYOUT_STYLE_NORMAL

See Also:

Constant Field Values

LAYOUT_STYLE_NORMAL_TREE

public static final java.lang.String LAYOUT_STYLE_NORMAL_TREE

See Also:

Constant Field Values

Constructor Detail

OrthogonalLayouterOptionsGroup

public OrthogonalLayouterOptionsGroup()

Method Detail

setDefaultValues

public void setDefaultValues()

Description copied from class: AbstractPropertyOptionsGroup

Sets default values for the properties contained in this group. Overriding classes should set default values to the properties.

Overrides:

setDefaultValues in class AbstractPropertyOptionsGroup

getLayoutStyle

public java.lang.String getLayoutStyle()

Get String representation of layout style.

Returns:

string.

setLayoutStyle

public void setLayoutStyle(java.lang.String style)

Set Layout stylel

Parameters:

style - the given layout style.

setLinkLengthReduction

public void setLinkLengthReduction(boolean b)

Set Link Length Reduction Property value. If true the overall path lengths will be reduced. The cost for the reduction is an increased execution time of the layouter.

Parameters:

b - boolean

getLinkLengthReduction

public boolean getLinkLengthReduction()

Get Link Length Reduction Property value. If true the overall path lengths will be reduced. The cost for the reduction is an increased execution time of the layouter.

Returns:

boolean

setUseExistingDrawingAsSketch

public void setUseExistingDrawingAsSketch(boolean b)

Set Use Existing Drawing As Sketch property value.. The layouter tries to "orthogonalize" the given sketch by interpreting it and without making too many modifications in respect to the original drawing.

Parameters:

b -

getUseExistingDrawingAsSketch

public boolean getUseExistingDrawingAsSketch()

Get Use Existing Drawing As Sketch property value.. The layouter tries to "orthogonalize" the given sketch by interpreting it and without making too many modifications in respect to the original drawing.

Returns:

boolean

setCrossingPostprocessing

public void setCrossingPostprocessing(boolean b)

Set Crossing Post precessing property value. If true the overall number of path crossings will be reduced. The cost for the reduction is increased execution time of the layouter.

Parameters:

b - boolean

getCrossingPostprocessing

public boolean getCrossingPostprocessing()

Get Crossing Post precessing property value. If true the overall number of path crossings will be reduced. The cost for the reduction is increased execution time of the layouter.

Returns:

setUseRandomization

public void setUseRandomization(boolean b)

Set use Randomization property value. If enabled the overall layout quality will increase with high probability. The cost for this layout optimization is increased execution time and non-deterministic behavior of the layouter.

Parameters:

b -

getUseRandomization

public boolean getUseRandomization()

Get use Randomization property value. If enabled the overall layout quality will increase with high probability. The cost for this layout optimization is increased execution time and non-deterministic behavior of the layouter.

Returns:

getGroupLayoutQuality

public double getGroupLayoutQuality()

Get the desired layout quality. Higher values result in less connection crossings and smaller layout area, but also increased computation time.

Returns:

setGroupLayoutQuality

public void setGroupLayoutQuality(double d)

Set the desired layout quality. Higher values result in less connection crossings and smaller layout area, but also increased computation time.

Parameters:

d - double.

setLayoutOnlyTopLevel

public void setLayoutOnlyTopLevel(boolean b)

Set Layout Only Top Level property value in order to keeps the relative position of symbols inside packages and performs the top level layout.

Parameters:

b - boolean.

isLayoutOnlyTopLevel

public boolean isLayoutOnlyTopLevel()

Check Layout Only Top Level property value. It indicates position of symbols inside packages is on the top level layout.

Returns:

boolean

addProperty

public void addProperty(Property property)

Description copied from class: AbstractPropertyOptionsGroup

Adds property to this group. DescriptionID will be reset. To add property with description use AbstractPropertyOptionsGroup.addProperty(Property, String) method.

Overrides:

addProperty in class AbstractPropertyOptionsGroup

Parameters:

property - property to be added.

getGrid

public int getGrid()

Get Grid property value. This property defines the virtual grid spacing used by the layouter. Each shape center point lies on a grid point.

Returns:

int

setGrid

public void setGrid(int d)

Set Grid property value. This property defines the virtual grid spacing used by the layouter. Each shape center point lies on a grid point.

Parameters:

d - int