Package com.nomagic.magicdraw.core.options

Class AbstractDiagramLayouterOptionsGroup

java.lang.Object

com.nomagic.magicdraw.core.options.OptionsGroup

com.nomagic.magicdraw.core.options.AbstractPropertyOptionsGroup

com.nomagic.magicdraw.core.options.AbstractDiagramLayouterOptionsGroup

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

CircularLayouterOptionsGroup, HierarchicLayouterOptionsGroup, OrganicLayouterOptionsGroup, OrganicRouterOptionsGroup, OrthogonalLayouterOptionsGroup, OrthogonalRouterOptionsGroup, TreeLayouterOptionsGroup

@OpenApiAll
public abstract class AbstractDiagramLayouterOptionsGroup
extends AbstractPropertyOptionsGroup

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ALIGNMENT_BOTTOM	Aligns layouted shapes according their bottom y coordinate.
static java.lang.String	ALIGNMENT_CENTER	Aligns layouted shapes according their centers.
static java.lang.String	ALIGNMENT_TOP	Aligns layouted shapes according their top y coordinate.
protected static java.util.List	LAYOUT_LABEL_CONSIDERATION	Label consideration modes
static java.lang.String	LAYOUT_LABEL_CONSIDERATION_FULL	Full label consideration mode.
static java.lang.String	LAYOUT_LABEL_CONSIDERATION_NONE	A mode where labels are not considered.
static java.lang.String	LAYOUT_LABEL_CONSIDERATION_PARTIAL	Partial label consideration mode.
protected static int	MAX_INT_VALUE	The maximum allowed value for integer fields(e.g minimal node distance, minimal edge distance)
protected static java.util.List	SHAPE_ALIGNMENT	Different ways of aligning shapes after layout.

Constructor Summary

Constructors

Constructor	Description
AbstractDiagramLayouterOptionsGroup(java.lang.String id, PropertyManager options, boolean visible)

Method Summary

Modifier and Type	Method	Description
AbstractDiagramLayouterOptionsGroup	getCopy()
boolean	getMakePreferredLayoutSize()	Get reset shape size property value
boolean	getOptimizeLabelOrientations()	Get value if label orientations should be optimized
protected void	initCommonDefaultValues()
boolean	isMoveToFreeSpace()	Checks Is Move to free space?
void	setDefaultValues()	Sets default values for the properties contained in this group.
void	setMakePreferredLayoutSize(boolean b)	Set reset shape size property value
void	setMoveToFreeSpace(boolean b)	Sets status move to free space
void	setOptimizeLabelOrientations(boolean value)	Set reset shape size property value

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

addInvisibleProperty, addProperty, 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

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

Field Detail

ALIGNMENT_TOP

public static final java.lang.String ALIGNMENT_TOP

Aligns layouted shapes according their top y coordinate.

See Also:

Constant Field Values

ALIGNMENT_CENTER

public static final java.lang.String ALIGNMENT_CENTER

Aligns layouted shapes according their centers.

See Also:

Constant Field Values

ALIGNMENT_BOTTOM

public static final java.lang.String ALIGNMENT_BOTTOM

Aligns layouted shapes according their bottom y coordinate.

See Also:

Constant Field Values

SHAPE_ALIGNMENT

protected static final java.util.List SHAPE_ALIGNMENT

Different ways of aligning shapes after layout.

LAYOUT_LABEL_CONSIDERATION_NONE

public static final java.lang.String LAYOUT_LABEL_CONSIDERATION_NONE

A mode where labels are not considered.

See Also:

Constant Field Values

LAYOUT_LABEL_CONSIDERATION_PARTIAL

public static final java.lang.String LAYOUT_LABEL_CONSIDERATION_PARTIAL

Partial label consideration mode.

See Also:

Constant Field Values

LAYOUT_LABEL_CONSIDERATION_FULL

public static final java.lang.String LAYOUT_LABEL_CONSIDERATION_FULL

Full label consideration mode.

See Also:

Constant Field Values

LAYOUT_LABEL_CONSIDERATION

protected static final java.util.List LAYOUT_LABEL_CONSIDERATION

Label consideration modes

MAX_INT_VALUE

protected static final int MAX_INT_VALUE

The maximum allowed value for integer fields(e.g minimal node distance, minimal edge distance)

See Also:

Constant Field Values

Constructor Detail

AbstractDiagramLayouterOptionsGroup

public AbstractDiagramLayouterOptionsGroup(java.lang.String id,
                                           @CheckForNull
                                           PropertyManager options,
                                           boolean visible)

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

initCommonDefaultValues

protected void initCommonDefaultValues()

setMoveToFreeSpace

public void setMoveToFreeSpace(boolean b)

Sets status move to free space

Parameters:

b - new value

isMoveToFreeSpace

public boolean isMoveToFreeSpace()

Checks Is Move to free space?

Returns:

boolean

getMakePreferredLayoutSize

public boolean getMakePreferredLayoutSize()

Get reset shape size property value

Returns:

b

setMakePreferredLayoutSize

public void setMakePreferredLayoutSize(boolean b)

Set reset shape size property value

Parameters:

b - new value

getOptimizeLabelOrientations

public boolean getOptimizeLabelOrientations()

Get value if label orientations should be optimized

Returns:

b

setOptimizeLabelOrientations

public void setOptimizeLabelOrientations(boolean value)

Set reset shape size property value

Parameters:

value - new value

getCopy

public AbstractDiagramLayouterOptionsGroup getCopy()