com.nomagic.magicdraw.core.options

Class OrthogonalRouterOptionsGroup

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.OrthogonalRouterOptionsGroup

All Implemented Interfaces:

java.lang.Cloneable

@OpenApiAll
public class OrthogonalRouterOptionsGroup
extends AbstractDiagramLayouterOptionsGroup

Organic Layouter options group.

Field Summary

Fields

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

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

ALIGNMENT_BOTTOM, ALIGNMENT_CENTER, ALIGNMENT_TOP, LAYOUT_LABEL_CONSIDERATION, LAYOUT_LABEL_CONSIDERATION_FULL, LAYOUT_LABEL_CONSIDERATION_NONE, LAYOUT_LABEL_CONSIDERATION_PARTIAL, MAX_INT_VALUE, SHAPE_ALIGNMENT

Constructor Summary

Constructors

Constructor and Description
OrthogonalRouterOptionsGroup()

Method Summary

Modifier and Type	Method and Description
void	addProperty(Property property) Adds property to this group.
int	getMinimalFirstSegmentLength() Get the minimal length of the first and last segments for orthogonal path routings, i.e.
int	getMinimalPathToPathDistance() Gets the distance between two paths.
int	getMinimalShapeToPathDistance() Gets the minimal distance between paths and shapes.
boolean	getRouteOnGrid() Get Route On Grid property value.
protected void	initCommonDefaultValues()
void	setDefaultValues() Sets default values for the properties contained in this group.
void	setMinimalFirstSegmentLength(int d) Set the minimal length of the first and last segments for orthogonal path routings, i.e.
void	setMinimalPathToPathDistance(int d) Determines the distance between two paths.
void	setMinimalShapeToPathDistance(int d) Determines the minimal distance between paths and shapes.
void	setRouteOnGrid(boolean b) Set Route On Grid property value.

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

getMakePreferredLayoutSize, getOptimizeLabelOrientations, isMoveToFreeSpace, setMakePreferredLayoutSize, setMoveToFreeSpace, setOptimizeLabelOrientations

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

Constructor Detail

OrthogonalRouterOptionsGroup

public OrthogonalRouterOptionsGroup()

Method Detail

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.

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 AbstractDiagramLayouterOptionsGroup

initCommonDefaultValues

protected void initCommonDefaultValues()

Overrides:

initCommonDefaultValues in class AbstractDiagramLayouterOptionsGroup

getMinimalFirstSegmentLength

public int getMinimalFirstSegmentLength()

Get the minimal length of the first and last segments for orthogonal path routings, i.e. the length from the intersection points to the first or last bend point respectively.

Returns:

int value.

setMinimalFirstSegmentLength

public void setMinimalFirstSegmentLength(int d)

Set the minimal length of the first and last segments for orthogonal path routings, i.e. the length from the intersection points to the first or last bend point respectively.

Parameters:

d - the new minimal first segment length value

getMinimalShapeToPathDistance

public int getMinimalShapeToPathDistance()

Gets the minimal distance between paths and shapes.

Returns:

int value.

setMinimalShapeToPathDistance

public void setMinimalShapeToPathDistance(int d)

Determines the minimal distance between paths and shapes.

Parameters:

d - the new minimal shape to path distance value

getMinimalPathToPathDistance

public int getMinimalPathToPathDistance()

Gets the distance between two paths.

Returns:

int value.

setMinimalPathToPathDistance

public void setMinimalPathToPathDistance(int d)

Determines the distance between two paths.

Parameters:

d - the new minimal path to path distance value

setRouteOnGrid

public void setRouteOnGrid(boolean b)

Set Route On Grid property value. If True, all paths are routed on grid lines from the predefined grid.

Parameters:

b - boolean.

getRouteOnGrid

public boolean getRouteOnGrid()

Get Route On Grid property value.

Returns:

trueif all paths are to be routed on grid lines from the predefined grid.