org.writersforge.catalan.layout
Class Relation.Above

java.lang.Object
  |
  +--org.writersforge.catalan.layout.Relation
        |
        +--org.writersforge.catalan.layout.Relation.Above

Enclosing class:

Relation

public static class Relation.Above

extends Relation

Convenience class to constrain an area that must remain vertically above the previous area in the layout.

Nested Class Summary

Nested classes inherited from class org.writersforge.catalan.layout.Relation

Relation.Above, Relation.Below, Relation.Indent

Field Summary

Fields inherited from class org.writersforge.catalan.layout.Relation

ABOVE_AT_MASK, ABOVE_MASK, ABOVE_MAX_MASK, ABOVE_MIN_MASK, BELOW_AT_MASK, BELOW_MASK, BELOW_MAX_MASK, BELOW_MIN_MASK, EQUAL_MASK, GREATER_THAN_EQUAL_MASK, GREATER_THAN_MASK, HEAVY_WEIGHT, HORIZONTAL_MASK, INDENT_MASK, LEADING_ATTRACTOR_EDGE_MASK, LEADING_SATELLITE_EDGE_MASK, LESS_THAN_EQUAL_MASK, LESS_THAN_MASK, LIGHT_WEIGHT, MANDATORY_WEIGHT, MEDIUM_WEIGHT, MINIMAL_WEIGHT, NOT_EQUAL_MASK, TRAILING_ATTRACTOR_EDGE_MASK, TRAILING_SATELLITE_EDGE_MASK, VERTICAL_MASK

Constructor Summary

Relation.Above(LayoutArea target, int weight, int distance)
Creates a new instance of Above, essentially a convenience wrapper around the base Relation class with simpler parameters and distinct type (for easier checking with instanceof).

Relation.Above(LayoutArea target, int compareMask, int weight, int distance)
Creates a new instance of Above, essentially a convenience wrapper around the base Relation class with simpler parameters and distinct type (for easier checking with instanceof).

Methods inherited from class org.writersforge.catalan.layout.Relation

getDistance, getTarget, getWeight, isEqual, isGreaterThan, isLeadingAttractorEdge, isLeadingSatelliteEdge, isLessThan, isVertical, setDistance, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Relation.Above

public Relation.Above(LayoutArea target,
                      int weight,
                      int distance)

Creates a new instance of Above, essentially a convenience wrapper around the base Relation class with simpler parameters and distinct type (for easier checking with instanceof). This Above relationship uses a comparator of EQUAL_MASK.

Parameters:

target - the area to constrain

weight - the Relation weight

distance - the distance above the attractor area to compare against

Relation.Above

public Relation.Above(LayoutArea target,
                      int compareMask,
                      int weight,
                      int distance)

Creates a new instance of Above, essentially a convenience wrapper around the base Relation class with simpler parameters and distinct type (for easier checking with instanceof). Accepts the comparison operator in the compareMask paramter, which can be EQUAL_MASK, GREATER_THAN_MASK, etc.

Parameters:

target - the area to constrain

compareMask - the bitmask for the comparison operator

weight - the Relation weight

distance - the distance above the attractor area to compare against