com.yworks.yfiles.layout

Enum MultiRowConstraint

java.lang.Object

java.lang.Enum<MultiRowConstraint>

com.yworks.yfiles.layout.MultiRowConstraint

All Implemented Interfaces:

Serializable, Comparable<MultiRowConstraint>

public enum MultiRowConstraint
extends Enum<MultiRowConstraint>

See Also:

LayoutGraphUtilities.arrangeRectangleMultiRows(com.yworks.yfiles.algorithms.Rectangle2D[], com.yworks.yfiles.algorithms.Rectangle2D, double, double, boolean, MultiRowConstraint, RowAlignment)

Enum Constant Summary

Enum Constants

Enum Constant and Description
HEIGHT Constraint specifier for a multi-row rectangle arrangement that constrains the height of the layout.
NONE Constraint specifier for a multi-row rectangle arrangement that is unconstrained.
WIDTH Constraint specifier for a multi-row rectangle arrangement that constrains the width of the layout.

Method Summary

Modifier and Type	Method and Description
static MultiRowConstraint	fromOrdinal(int ordinal)
int	value()
static MultiRowConstraint	valueOf(String name) Returns the enum constant of this type with the specified name.
static MultiRowConstraint[]	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

HEIGHT

public static final MultiRowConstraint HEIGHT

Constraint specifier for a multi-row rectangle arrangement that constrains the height of the layout. Limits the height of the arrangement to the given preferred height value. If some rectangles are higher than allowed, then they are placed nevertheless, but the constraint will still be considered for the rest and not weakened to the height of the higher rectangles. Having one rectangle being higher than the constraint does always result in arrangements consisting only of a single top-level row.

See Also:

LayoutGraphUtilities.arrangeRectangleMultiRows(com.yworks.yfiles.algorithms.Rectangle2D[], com.yworks.yfiles.algorithms.Rectangle2D, double, double, boolean, MultiRowConstraint, com.yworks.yfiles.layout.RowAlignment)

NONE

public static final MultiRowConstraint NONE

Constraint specifier for a multi-row rectangle arrangement that is unconstrained. Both, height and width, are not limited in size. The rectangles will be arranged in a way that the view ratio defined by the preferred height and width will be achieved.

See Also:

LayoutGraphUtilities.arrangeRectangleMultiRows(com.yworks.yfiles.algorithms.Rectangle2D[], com.yworks.yfiles.algorithms.Rectangle2D, double, double, boolean, MultiRowConstraint, com.yworks.yfiles.layout.RowAlignment)

WIDTH

public static final MultiRowConstraint WIDTH

Constraint specifier for a multi-row rectangle arrangement that constrains the width of the layout. Limits the width of the arrangement to the given preferred width value. If a rectangle is wider than allowed, then it will nevertheless be placed (in a row containing the rectangle alone), but the constraint will be still considered for other rows and not weakened.

See Also:

LayoutGraphUtilities.arrangeRectangleMultiRows(com.yworks.yfiles.algorithms.Rectangle2D[], com.yworks.yfiles.algorithms.Rectangle2D, double, double, boolean, MultiRowConstraint, com.yworks.yfiles.layout.RowAlignment)

Method Detail

fromOrdinal

public static final MultiRowConstraint fromOrdinal(int ordinal)

value

public int value()

valueOf

public static MultiRowConstraint 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 MultiRowConstraint[] 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 (MultiRowConstraint c : MultiRowConstraint.values())
    System.out.println(c);

Returns:

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