com.yworks.yfiles.layout.organic

Enum HorizontalOverlapCriterion

java.lang.Object

java.lang.Enum<HorizontalOverlapCriterion>

com.yworks.yfiles.layout.organic.HorizontalOverlapCriterion

All Implemented Interfaces:

Serializable, Comparable<HorizontalOverlapCriterion>

public enum HorizontalOverlapCriterion
extends Enum<HorizontalOverlapCriterion>

Enum constants that specify the Horizontal overlap criterion for the ShuffleLayout.

See Also:

ShuffleLayout.getHorizontalOverlapCriterion()

Enum Constant Summary

Enum Constants

Enum Constant and Description
INTERSECTION_BOX Horizontal overlap criterion defining an overlap as horizontal if the overlapping area is greater in height than in width.
LESS_MOVEMENT Horizontal overlap criterion categorizing an overlap as horizontal if the required movement for solving the overlap is shorter in horizontal direction than in vertical direction.
NODE_CENTER Horizontal overlap criterion categorizing an overlap as horizontal if the center-to-center difference between the overlapping nodes is greater in horizontal direction (x-coordinates) than in vertical direction (y-coordinates).

Method Summary

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

INTERSECTION_BOX

public static final HorizontalOverlapCriterion INTERSECTION_BOX

Horizontal overlap criterion defining an overlap as horizontal if the overlapping area is greater in height than in width.

Otherwise, if the overlap area's width is greater than or equal to its height, an overlap will be categorized as vertical.

The area of an overlap is defined as the rectangle where two nodes intersect with each other.

If there are no overlaps where a node contains a whole other node then this criterion is equal to LESS_MOVEMENT.

See Also:

ShuffleLayout.setHorizontalOverlapCriterion(HorizontalOverlapCriterion)

LESS_MOVEMENT

public static final HorizontalOverlapCriterion LESS_MOVEMENT

Horizontal overlap criterion categorizing an overlap as horizontal if the required movement for solving the overlap is shorter in horizontal direction than in vertical direction.

Otherwise, an overlap will be categorized as vertical.

This criterion tries to avoid moving nodes too much because the direction for resolving overlaps will be chosen such that the shorter movement is preferred.

If there are no overlaps where a node contains a whole other node then this criterion is equal to INTERSECTION_BOX.

See Also:

ShuffleLayout.setHorizontalOverlapCriterion(HorizontalOverlapCriterion)

NODE_CENTER

public static final HorizontalOverlapCriterion NODE_CENTER

Horizontal overlap criterion categorizing an overlap as horizontal if the center-to-center difference between the overlapping nodes is greater in horizontal direction (x-coordinates) than in vertical direction (y-coordinates).

Otherwise, if the center-to-center difference between two overlapping nodes is greater in vertical direction (y-coordinates), the corresponding overlap is categorized as vertical. The same applies if the differences in vertical and horizontal direction are equal.

See Also:

ShuffleLayout.setHorizontalOverlapCriterion(HorizontalOverlapCriterion)

Method Detail

fromOrdinal

public static final HorizontalOverlapCriterion fromOrdinal(int ordinal)

value

public int value()

valueOf

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

Returns:

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