de.cau.cs.kieler.klay.layered.properties
Enum InLayerConstraint

java.lang.Object
  extended by java.lang.Enum<InLayerConstraint>
      extended by de.cau.cs.kieler.klay.layered.properties.InLayerConstraint
All Implemented Interfaces:
Comparable<InLayerConstraint>

public enum InLayerConstraint
extends Enum<InLayerConstraint>

Enumeration of in-layer constraint types. In-layer constraints divide a layer into three parts: the normal part, a top part and a bottom part. This constraint can be set on nodes to define in which part they may appear.

See Also:
InLayerConstraintProcessor
Rating red

Enum Constant Summary
BOTTOM
          float node to the bottom of the layer, along with other nodes posessing this constraint.
NONE
          no constraint on in-layer placement.
TOP
          float node to the top of the layer, along with other nodes posessing this constraint.
 
Method Summary
static InLayerConstraint valueOf(String name)
          Returns the enum constant of this type with the specified name.
static InLayerConstraint[] 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

NONE

public static final InLayerConstraint NONE
no constraint on in-layer placement.


TOP

public static final InLayerConstraint TOP
float node to the top of the layer, along with other nodes posessing this constraint.


BOTTOM

public static final InLayerConstraint BOTTOM
float node to the bottom of the layer, along with other nodes posessing this constraint.

Method Detail

values

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

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

valueOf

public static InLayerConstraint 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.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null