com.yworks.yfiles.layout.organic

Enum StarSubstructureStyle

java.lang.Object

java.lang.Enum<StarSubstructureStyle>

com.yworks.yfiles.layout.organic.StarSubstructureStyle

All Implemented Interfaces:

Serializable, Comparable<StarSubstructureStyle>

public enum StarSubstructureStyle
extends Enum<StarSubstructureStyle>

See Also:

OrganicLayout.getStarSubstructureStyle()

Enum Constant Summary

Enum Constants

Enum Constant and Description
CIRCULAR Substructure style specifier for stars that leads to a circular layout style for stars where the root is placed in the middle.
NONE Substructure style specifier for stars that indicates that the algorithm does not handle such structures in a special way.
RADIAL Substructure style specifier for stars that leads to a radial layout style for stars where the root is placed in the middle.
SEPARATED_RADIAL Substructure style specifier for stars that leads to a radial layout style for stars where the root is placed on the outside (separated from the nodes with degree one).

Method Summary

Modifier and Type	Method and Description
static StarSubstructureStyle	fromOrdinal(int ordinal)
int	value()
static StarSubstructureStyle	valueOf(String name) Returns the enum constant of this type with the specified name.
static StarSubstructureStyle[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CIRCULAR

public static final StarSubstructureStyle CIRCULAR

Substructure style specifier for stars that leads to a circular layout style for stars where the root is placed in the middle. In contrast to the radial layout style, all nodes (except the root) are placed on a single cycle.

See Also:

OrganicLayout.setStarSubstructureStyle(StarSubstructureStyle)

NONE

public static final StarSubstructureStyle NONE

Substructure style specifier for stars that indicates that the algorithm does not handle such structures in a special way.

See Also:

OrganicLayout.setStarSubstructureStyle(StarSubstructureStyle)

RADIAL

public static final StarSubstructureStyle RADIAL

Substructure style specifier for stars that leads to a radial layout style for stars where the root is placed in the middle.

See Also:

OrganicLayout.setStarSubstructureStyle(StarSubstructureStyle)

SEPARATED_RADIAL

public static final StarSubstructureStyle SEPARATED_RADIAL

Substructure style specifier for stars that leads to a radial layout style for stars where the root is placed on the outside (separated from the nodes with degree one).

If the edges are grouped at the root node (see PortConstraintKeys.SOURCE_GROUP_ID_DPKEY and PortConstraintKeys.TARGET_GROUP_ID_DPKEY), the algorithm uses a grouped routing style.

See Also:

OrganicLayout.setStarSubstructureStyle(StarSubstructureStyle)

Method Detail

fromOrdinal

public static final StarSubstructureStyle fromOrdinal(int ordinal)

value

public int value()

valueOf

public static StarSubstructureStyle valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

values

public static StarSubstructureStyle[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (StarSubstructureStyle c : StarSubstructureStyle.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared