de.cau.cs.kieler.klay.layered.properties
Class Properties

java.lang.Object
  extended by de.cau.cs.kieler.klay.layered.properties.Properties

public final class Properties
extends Object

Container for priority definitions.

Rating red

Field Summary
static Property<Float> ASPECT_RATIO
          the aspect ratio for packing connected components.
static Property<Float> BORDER_SPACING
          spacing to the border of the drawing.
static IProperty<IDebugCanvas> DEBUG_CANVAS
          debug canvas.
static float DEF_ASPECT_RATIO
          default value for aspect ratio.
static float DEF_EDGE_SPACING_FACTOR
          default value for edge spacing factor.
static float DEF_SPACING
          default value for object spacing.
static IProperty<Boolean> DISTRIBUTE_NODES
          whether nodes shall be distributed during layer assignment.
static String DISTRIBUTE_NODES_ID
          option identifier for distribute nodes.
static IProperty<EdgeConstraint> EDGE_CONSTRAINT
          edge constraints for nodes.
static IProperty<EdgeRoutingStrategy> EDGE_ROUTING
          property to choose an edge routing strategy.
static String EDGE_ROUTING_ID
          option identifier for edge routing.
static Property<Float> EDGE_SPACING_FACTOR
          factor for minimal spacing between edges.
static String EDGE_SPACING_FACTOR_ID
          option identifier for edge spacing factor.
static IProperty<Double> EXT_PORT_RATIO_OR_POSITION
          The original position or position-to-node-size ratio of an external port.
static IProperty<PortSide> EXT_PORT_SIDE
          The side of an external port a dummy node was created for.
static IProperty<Set<GraphProperties>> GRAPH_PROPERTIES
          Flags indicating the properties of a graph.
static IProperty<InLayerConstraint> IN_LAYER_CONSTRAINT
          The in-layer constraint placed on a node.
static IProperty<LNode> IN_LAYER_LAYOUT_UNIT
          The layout unit a node belongs to.
static IProperty<LNode> IN_LAYER_SUCCESSOR_CONSTRAINT
          Indicates that a node x may only appear inside a layer before the node y the property is set to.
static IProperty<LayerConstraint> LAYER_CONSTRAINT
          property to set constraints on the node layering.
static String LAYER_CONSTRAINT_ID
          option identifier for layer constraint.
static IProperty<Integer> LINSEG_OFFSET
          offset for nodes in linear segments.
static IProperty<LPort> LONG_EDGE_SOURCE
          the source port of a long edge before it was broken into multiple segments.
static IProperty<LPort> LONG_EDGE_TARGET
          the target port of a long edge before it was broken into multiple segments.
static IProperty<Integer> MIN_EDGE_ANGLE
          defines the minimal angle a short edge may have.
static String MIN_EDGE_ANGLE_ID
          option identifier for minimal angle.
static IProperty<LayeringStrategy> NODE_LAYERING
          property to choose a node layering strategy.
static String NODE_LAYERING_ID
          option identifier for node layering.
static IProperty<NodeType> NODE_TYPE
          node type.
static Property<Float> OBJ_SPACING
          minimal spacing between objects.
static IProperty<Object> ORIGIN
          the original object from which a graph element was created.
static IProperty<KNode> PARENT
          KNode that contained the origin of this node in the KGraph.
static Property<Integer> PRIORITY
          priority of elements.
static IProperty<Random> RANDOM
          random number generator for the algorithm.
static IProperty<LinearSegmentsNodePlacer.Region> REGION
          owning region for node.
static IProperty<Boolean> REVERSED
          flag for reversed edges.
static IProperty<Boolean> SEPARATE_CC
          property for choosing whether connected components are processed separately.
static String SEPARATE_CC_ID
          option identifier for separation of connected components.
static IProperty<Boolean> STRAIGHT_EDGES
          whether edges shall be straightened as much as possible.
static String STRAIGHT_EDGES_ID
          option identifier for straight edges.
static IProperty<Integer> THOROUGHNESS
          property that determines how much effort should be spent.
static String THOROUGHNESS_ID
          option identifier for thoroughness.
 
Method Summary
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ORIGIN

public static final IProperty<Object> ORIGIN
the original object from which a graph element was created.


NODE_TYPE

public static final IProperty<NodeType> NODE_TYPE
node type.


LINSEG_OFFSET

public static final IProperty<Integer> LINSEG_OFFSET
offset for nodes in linear segments.


REGION

public static final IProperty<LinearSegmentsNodePlacer.Region> REGION
owning region for node.


REVERSED

public static final IProperty<Boolean> REVERSED
flag for reversed edges.


DEBUG_CANVAS

public static final IProperty<IDebugCanvas> DEBUG_CANVAS
debug canvas.


RANDOM

public static final IProperty<Random> RANDOM
random number generator for the algorithm.


LONG_EDGE_SOURCE

public static final IProperty<LPort> LONG_EDGE_SOURCE
the source port of a long edge before it was broken into multiple segments.


LONG_EDGE_TARGET

public static final IProperty<LPort> LONG_EDGE_TARGET
the target port of a long edge before it was broken into multiple segments.


EDGE_CONSTRAINT

public static final IProperty<EdgeConstraint> EDGE_CONSTRAINT
edge constraints for nodes.


IN_LAYER_LAYOUT_UNIT

public static final IProperty<LNode> IN_LAYER_LAYOUT_UNIT
The layout unit a node belongs to. This property only makes sense for nodes. A layout unit is a set of nodes between which no nodes belonging to other layout units may be placed. Nodes not belonging to any layout unit may be placed arbitrarily between nodes of a layout unit. Layer layout units are identified through one of their nodes.


IN_LAYER_CONSTRAINT

public static final IProperty<InLayerConstraint> IN_LAYER_CONSTRAINT
The in-layer constraint placed on a node. This indicates whether this node should be handled like any other node, or if it must be placed at the top or bottom of a layer. This is important for external port dummy nodes. Crossing minimizers are not required to respect this constraint. If they don't, however, they must include a dependency on InLayerConstraintProcessor.


IN_LAYER_SUCCESSOR_CONSTRAINT

public static final IProperty<LNode> IN_LAYER_SUCCESSOR_CONSTRAINT
Indicates that a node x may only appear inside a layer before the node y the property is set to. That is, having x appear after y would violate this constraint. This property only makes sense for nodes.


GRAPH_PROPERTIES

public static final IProperty<Set<GraphProperties>> GRAPH_PROPERTIES
Flags indicating the properties of a graph.


EXT_PORT_SIDE

public static final IProperty<PortSide> EXT_PORT_SIDE
The side of an external port a dummy node was created for.


EXT_PORT_RATIO_OR_POSITION

public static final IProperty<Double> EXT_PORT_RATIO_OR_POSITION
The original position or position-to-node-size ratio of an external port. This is a property usually used for external port dummy nodes. There is only one coordinate since the side of the port determines the other coordinate. (for eastern and western ports, the x coordinate is determined automatically; for northern and southern ports, the y coordinate is determined automatically)


PARENT

public static final IProperty<KNode> PARENT
KNode that contained the origin of this node in the KGraph.


DEF_SPACING

public static final float DEF_SPACING
default value for object spacing.

See Also:
Constant Field Values

OBJ_SPACING

public static final Property<Float> OBJ_SPACING
minimal spacing between objects.


BORDER_SPACING

public static final Property<Float> BORDER_SPACING
spacing to the border of the drawing.


EDGE_SPACING_FACTOR_ID

public static final String EDGE_SPACING_FACTOR_ID
option identifier for edge spacing factor.

See Also:
Constant Field Values

DEF_EDGE_SPACING_FACTOR

public static final float DEF_EDGE_SPACING_FACTOR
default value for edge spacing factor.

See Also:
Constant Field Values

EDGE_SPACING_FACTOR

public static final Property<Float> EDGE_SPACING_FACTOR
factor for minimal spacing between edges.


PRIORITY

public static final Property<Integer> PRIORITY
priority of elements.


DEF_ASPECT_RATIO

public static final float DEF_ASPECT_RATIO
default value for aspect ratio.

See Also:
Constant Field Values

ASPECT_RATIO

public static final Property<Float> ASPECT_RATIO
the aspect ratio for packing connected components.


MIN_EDGE_ANGLE_ID

public static final String MIN_EDGE_ANGLE_ID
option identifier for minimal angle.

See Also:
Constant Field Values

MIN_EDGE_ANGLE

public static final IProperty<Integer> MIN_EDGE_ANGLE
defines the minimal angle a short edge may have.


STRAIGHT_EDGES_ID

public static final String STRAIGHT_EDGES_ID
option identifier for straight edges.

See Also:
Constant Field Values

STRAIGHT_EDGES

public static final IProperty<Boolean> STRAIGHT_EDGES
whether edges shall be straightened as much as possible.


DISTRIBUTE_NODES_ID

public static final String DISTRIBUTE_NODES_ID
option identifier for distribute nodes.

See Also:
Constant Field Values

DISTRIBUTE_NODES

public static final IProperty<Boolean> DISTRIBUTE_NODES
whether nodes shall be distributed during layer assignment.


EDGE_ROUTING_ID

public static final String EDGE_ROUTING_ID
option identifier for edge routing.

See Also:
Constant Field Values

EDGE_ROUTING

public static final IProperty<EdgeRoutingStrategy> EDGE_ROUTING
property to choose an edge routing strategy.


NODE_LAYERING_ID

public static final String NODE_LAYERING_ID
option identifier for node layering.

See Also:
Constant Field Values

NODE_LAYERING

public static final IProperty<LayeringStrategy> NODE_LAYERING
property to choose a node layering strategy.


THOROUGHNESS_ID

public static final String THOROUGHNESS_ID
option identifier for thoroughness.

See Also:
Constant Field Values

THOROUGHNESS

public static final IProperty<Integer> THOROUGHNESS
property that determines how much effort should be spent.


LAYER_CONSTRAINT_ID

public static final String LAYER_CONSTRAINT_ID
option identifier for layer constraint.

See Also:
Constant Field Values

LAYER_CONSTRAINT

public static final IProperty<LayerConstraint> LAYER_CONSTRAINT
property to set constraints on the node layering.


SEPARATE_CC_ID

public static final String SEPARATE_CC_ID
option identifier for separation of connected components.

See Also:
Constant Field Values

SEPARATE_CC

public static final IProperty<Boolean> SEPARATE_CC
property for choosing whether connected components are processed separately.