com.nomagic.magicdraw.core.options

Class HierarchicLayouterOptionsGroup

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

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

ActivityLayouterOptionsGroup, ClassDiagramLayouterOptionsGroup, CompositeLayouterOptionsGroup, StateMachineLayouterOptionsGroup

@OpenApiAll
public class HierarchicLayouterOptionsGroup
extends AbstractDiagramLayouterOptionsGroup

Hierarchic Layouter options group.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.List	EDGE_ROUTINGS
static java.lang.String	ID
static java.lang.String	OBLIQUE
static java.lang.String	ORTHOGONAL

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
HierarchicLayouterOptionsGroup()
HierarchicLayouterOptionsGroup(java.lang.String id) Construct HierarchicLayouterOptionsGroup

Method Summary

Modifier and Type	Method and Description
void	addProperty(Property property) Adds property to this group.
protected void	afterLoad(com.nomagic.magicdraw.lic.MDVersion version, boolean pluginsLoaded)
boolean	getBackloopRouting() Get Back Loop Routing property value in order to enabled all paths that do not point in the main layout direction will be routed as backloops.
boolean	getConsiderLayoutTemplates()
java.lang.String	getEdgeRouting() Get string representation route to oblique style with a certain number of bends.
java.lang.String	getLayoutLabelConsideration() Get label consideration mode
boolean	getLayoutOnlyTopLevel() Gets the Layout only top level value.
boolean	getMakeSubTrees() Get Make Sub trees property value.
int	getMinimalFirstSegmentLength() Get the minimal length of the first and last segments for orthogonal path routing, i.e.
int	getMinimalLayerDistance() Get the minimal distance between shapes that reside in adjacent layers.
int	getMinimalLinkDistance() Get the distance between adjacent pairs of horizontal path segments and between horizontal path segments and shapes.
int	getMinimalShapeDistance() Get the minimal distance between borders of two adjacent shapes on a common circle.
java.lang.String	getOrientation() Get main layout orientation.
boolean	getRemoveFalseCrossings() Get Remove False Crossings property value in order to enable a post-processing step tries to eliminate all false path crossings.
java.lang.String	getSequencer()
java.lang.String	getShapeAlignmentWithinLayer() Get Shape position within a layer.
boolean	getUseGlobalSequencing() Get Use Global Sequencing property value.
boolean	getUseTransposition() Get the transposition property value determines a post-processing further reduces the number of path crossings.
boolean	isLayoutOnlyTopLevel() Check Layout Only Top Level property value.
void	setBackloopRouting(boolean b) Set Back Loop Routing property value in order to enabled all paths that do not point in the main layout direction will be routed as backloops.
void	setConsiderLayoutTemplates(boolean b) If set to true, leaves the elements that have layout templates unchanged.
void	setDefaultValues() Sets default values for the properties contained in this group.
void	setEdgeRouting(java.lang.String s) Set string representation route to oblique style with a certain number of bends.
void	setLayoutLabelConsideration(java.lang.String value) Set label consideration mode
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	setMakeSubTrees(boolean b) Set Make Sub trees property value to set the inheritance paths are joined into inheritance arcs.
void	setMinimalFirstSegmentLength(int d) Set the minimal length of the first and last segments for orthogonal path routing, i.e.
void	setMinimalLayerDistance(int d) Set the minimal distance between shapes that reside in adjacent layers.
void	setMinimalLinkDistance(int d) Set the distance between adjacent pairs of horizontal path segments and between horizontal path segments and shapes.
void	setMinimalShapeDistance(int d) Set the minimal distance between borders of two adjacent shapes on a common circle.
void	setOrientation(java.lang.String s) Set main layout orientation.
void	setRemoveFalseCrossings(boolean b) Set Remove False Crossings property value determines a post-processing step tries to eliminate all false path crossings.
void	setSequencer(java.lang.String s)
void	setShapeAlignmentWithinLayer(java.lang.String value) Set Shape alignment within a layer.
void	setUseGlobalSequencing(boolean b) Set Use Global Sequencing property value.
void	setUseTransposition(boolean b) Set the transposition property value in order to enable a post-processing further reduces the number of path crossings.

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

OBLIQUE

public static final java.lang.String OBLIQUE

See Also:

Constant Field Values

ORTHOGONAL

public static final java.lang.String ORTHOGONAL

See Also:

Constant Field Values

EDGE_ROUTINGS

public static final java.util.List EDGE_ROUTINGS

Constructor Detail

HierarchicLayouterOptionsGroup

public HierarchicLayouterOptionsGroup(java.lang.String id)

Construct HierarchicLayouterOptionsGroup

HierarchicLayouterOptionsGroup

public HierarchicLayouterOptionsGroup()

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

getMinimalLayerDistance

public int getMinimalLayerDistance()

Get the minimal distance between shapes that reside in adjacent layers.

Returns:

int value.

setMinimalLayerDistance

public void setMinimalLayerDistance(int d)

Set the minimal distance between shapes that reside in adjacent layers.

Parameters:

d - int value.

getMinimalShapeDistance

public int getMinimalShapeDistance()

Get the minimal distance between borders of two adjacent shapes on a common circle. The smaller the distance, the more compact resulting layout.

Returns:

int value.

setMinimalShapeDistance

public void setMinimalShapeDistance(int d)

Set the minimal distance between borders of two adjacent shapes on a common circle. The smaller the distance, the more compact resulting layout.

Parameters:

d - value.

getMinimalLinkDistance

public int getMinimalLinkDistance()

Get the distance between adjacent pairs of horizontal path segments and between horizontal path segments and shapes.

Returns:

int value.

setMinimalLinkDistance

public void setMinimalLinkDistance(int d)

Set the distance between adjacent pairs of horizontal path segments and between horizontal path segments and shapes.

Parameters:

d - new distance

getMinimalFirstSegmentLength

public int getMinimalFirstSegmentLength()

Get the minimal length of the first and last segments for orthogonal path routing, 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 routing, i.e. the length from the intersection points to the first or last bend point respectively.

Parameters:

d - new length

getOrientation

public java.lang.String getOrientation()

Get main layout orientation.

Returns:

value.

setOrientation

public void setOrientation(java.lang.String s)

Set main layout orientation.

Parameters:

s - value.

getSequencer

public java.lang.String getSequencer()

setSequencer

public void setSequencer(java.lang.String s)

getEdgeRouting

public java.lang.String getEdgeRouting()

Get string representation route to oblique style with a certain number of bends.

Returns:

string.

setEdgeRouting

public void setEdgeRouting(java.lang.String s)

Set string representation route to oblique style with a certain number of bends.

Parameters:

s - string value.

setBackloopRouting

public void setBackloopRouting(boolean b)

Set Back Loop Routing property value in order to enabled all paths that do not point in the main layout direction will be routed as backloops.

Parameters:

b - boolean.

getBackloopRouting

public boolean getBackloopRouting()

Get Back Loop Routing property value in order to enabled all paths that do not point in the main layout direction will be routed as backloops.

Returns:

true if backloop routing is enabled, false otherwise

setShapeAlignmentWithinLayer

public void setShapeAlignmentWithinLayer(java.lang.String value)

Set Shape alignment within a layer.

getShapeAlignmentWithinLayer

public java.lang.String getShapeAlignmentWithinLayer()

Get Shape position within a layer.

Returns:

string.

setUseTransposition

public void setUseTransposition(boolean b)

Set the transposition property value in order to enable a post-processing further reduces the number of path crossings. The post-processing step can be rather time consuming.

Parameters:

b - boolean value.

getUseTransposition

public boolean getUseTransposition()

Get the transposition property value determines a post-processing further reduces the number of path crossings. The post-processing step can be rather time consuming.

Returns:

value.

setRemoveFalseCrossings

public void setRemoveFalseCrossings(boolean b)

Set Remove False Crossings property value determines a post-processing step tries to eliminate all false path crossings. A false path crossing is a path crossing between two paths that attached to the same shape.

Parameters:

b - boolean value.

getRemoveFalseCrossings

public boolean getRemoveFalseCrossings()

Get Remove False Crossings property value in order to enable a post-processing step tries to eliminate all false path crossings. A false path crossing is a path crossing between two paths that attached to the same shape.

Returns:

true if should remove false crossings

setUseGlobalSequencing

public void setUseGlobalSequencing(boolean b)

Set Use Global Sequencing property value. It can be used to activate an alternative sequencing algorithm that calculates the shapes order. This algorithm tends to give better results for complex shape nesting but may produce more crossings locally than the default algorithm.

Parameters:

b - boolean

getUseGlobalSequencing

public boolean getUseGlobalSequencing()

Get Use Global Sequencing property value. It can be used to activate an alternative sequencing algorithm that calculates the shapes order. This algorithm tends to give better results for complex shape nesting but may produce more crossings locally than the default algorithm.

Returns:

boolean

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.

getLayoutOnlyTopLevel

public boolean getLayoutOnlyTopLevel()

Gets the Layout only top level value. It allows the inside of group nodes not to be layouted.

Returns:

true if only outer nodes should be layouter, false if all nodes should be layouted

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:

true if should layout only the top level, but not inner group node structure

setMakeSubTrees

public void setMakeSubTrees(boolean b)

Set Make Sub trees property value to set the inheritance paths are joined into inheritance arcs.

Parameters:

b - true to make trees

getMakeSubTrees

public boolean getMakeSubTrees()

Get Make Sub trees property value.

Returns:

boolean

setLayoutLabelConsideration

public void setLayoutLabelConsideration(java.lang.String value)

Set label consideration mode

getLayoutLabelConsideration

public java.lang.String getLayoutLabelConsideration()

Get label consideration mode

Returns:

string.

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.

afterLoad

protected void afterLoad(com.nomagic.magicdraw.lic.MDVersion version,
                         boolean pluginsLoaded)

Overrides:

afterLoad in class AbstractPropertyOptionsGroup

setConsiderLayoutTemplates

public void setConsiderLayoutTemplates(boolean b)

If set to true, leaves the elements that have layout templates unchanged.

getConsiderLayoutTemplates

public boolean getConsiderLayoutTemplates()