de.cau.cs.kieler.kiml.graphviz.dot.transform
Enum OverlapMode

java.lang.Object
  extended by java.lang.Enum<OverlapMode>
      extended by de.cau.cs.kieler.kiml.graphviz.dot.transform.OverlapMode
All Implemented Interfaces:
Comparable<OverlapMode>

public enum OverlapMode
extends Enum<OverlapMode>

Definition of overlap removal modes.

Rating red

Enum Constant Summary
COMPRESS
          the layout will be scaled down as much as possible without introducing any overlaps.
NONE
          overlaps are retained ("true" in the Graphviz options).
PRISM
          Prism, a proximity graph-based algorithm, is used to remove node overlaps.
SCALE
          overlaps are removed by uniformly scaling in x and y.
SCALEXY
          x and y are separately scaled to remove overlaps.
 
Method Summary
 String literal()
          Return the literal value as understood by Graphviz.
static OverlapMode parse(String string)
          Parse the given string into an overlap mode, ignoring case.
static OverlapMode valueOf(String name)
          Returns the enum constant of this type with the specified name.
static OverlapMode[] 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 OverlapMode NONE
overlaps are retained ("true" in the Graphviz options).


SCALE

public static final OverlapMode SCALE
overlaps are removed by uniformly scaling in x and y.


SCALEXY

public static final OverlapMode SCALEXY
x and y are separately scaled to remove overlaps.


PRISM

public static final OverlapMode PRISM
Prism, a proximity graph-based algorithm, is used to remove node overlaps.


COMPRESS

public static final OverlapMode COMPRESS
the layout will be scaled down as much as possible without introducing any overlaps.

Method Detail

values

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

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

valueOf

public static OverlapMode 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

parse

public static OverlapMode parse(String string)
Parse the given string into an overlap mode, ignoring case.

Parameters:
string - a string
Returns:
the corresponding mode

literal

public String literal()
Return the literal value as understood by Graphviz.

Returns:
the literal value