com.guiseframework.component.layout
Enum Flow.Direction

java.lang.Object
  java.lang.Enum<Flow.Direction>
      com.guiseframework.component.layout.Flow.Direction

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Flow.Direction>

Enclosing class:

Flow

public static enum Flow.Direction
extends java.lang.Enum<Flow.Direction>

The flow direction for a line or page, relative to the origin in the top, left-hand corner of the area.

Author:

Garret Wilson

See Also:

Flow.End

Enum Constant Summary

DECREASING
Right-to-left lines or bottom-to-top pages.

INCREASING
Left-to-right lines or top-to-bottom pages.

Method Summary

Flow.End	getEnd(Flow.Direction direction) Determines the end at which the given direction would arrive relative to this direction.
static Flow.Direction	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Flow.Direction[]	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

INCREASING

public static final Flow.Direction INCREASING

Left-to-right lines or top-to-bottom pages.

DECREASING

public static final Flow.Direction DECREASING

Right-to-left lines or bottom-to-top pages.

Method Detail

values

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

Returns:

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

valueOf

public static Flow.Direction valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getEnd

public Flow.End getEnd(Flow.Direction direction)

Determines the end at which the given direction would arrive relative to this direction. For example, if this is an increasing direction and a decreasing direction is given, the decreasing direction would arrive at the near end of the flow.

Parameters:

direction - The relative direction or which the end should be returned.

Returns:

The end of the flow at which the given direction would arrive relative to this direction.