Enum FlowOrientation
- java.lang.Object
-
- java.lang.Enum<FlowOrientation>
-
- io.guise.framework.component.layout.FlowOrientation
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<FlowOrientation>
public enum FlowOrientation extends java.lang.Enum<FlowOrientation>
The orientation of a particular flow; its axis and direction.- Author:
- Garret Wilson
-
-
Enum Constant Summary
Enum Constants Enum Constant Description BOTTOM_TO_TOP
Flow.Direction.DECREASING
flow on theAxis.Y
axis.LEFT_TO_RIGHT
Flow.Direction.INCREASING
flow on theAxis.X
axis.RIGHT_TO_LEFT
Flow.Direction.DECREASING
flow on theAxis.X
axis.TOP_TO_BOTTOM
Flow.Direction.INCREASING
flow on theAxis.Y
axis.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Axis
getAxis()
CompassPoint
getCompassPoint(Flow.End end)
Retrieves a cardinal compass point indicating the absolute direction based upon the given flow end.Flow.Direction
getDirection()
java.net.URI
getGlyph()
static FlowOrientation
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static FlowOrientation[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
LEFT_TO_RIGHT
public static final FlowOrientation LEFT_TO_RIGHT
Flow.Direction.INCREASING
flow on theAxis.X
axis.
-
RIGHT_TO_LEFT
public static final FlowOrientation RIGHT_TO_LEFT
Flow.Direction.DECREASING
flow on theAxis.X
axis.
-
TOP_TO_BOTTOM
public static final FlowOrientation TOP_TO_BOTTOM
Flow.Direction.INCREASING
flow on theAxis.Y
axis.
-
BOTTOM_TO_TOP
public static final FlowOrientation BOTTOM_TO_TOP
Flow.Direction.DECREASING
flow on theAxis.Y
axis.
-
-
Method Detail
-
values
public static FlowOrientation[] 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 (FlowOrientation c : FlowOrientation.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static FlowOrientation 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 namejava.lang.NullPointerException
- if the argument is null
-
getGlyph
public java.net.URI getGlyph()
- Returns:
- The resource reference for the glyph, using the session's default orientation.
-
getAxis
public Axis getAxis()
- Returns:
- The axis of the flow.
-
getDirection
public Flow.Direction getDirection()
- Returns:
- The direction of the flow on the axis.
-
getCompassPoint
public CompassPoint getCompassPoint(Flow.End end)
Retrieves a cardinal compass point indicating the absolute direction based upon the given flow end.- Parameters:
end
- The end of the flow.- Returns:
- The cardinal compass point indicating the absolute direction of the given end.
- Throws:
java.lang.NullPointerException
- if the given end isnull
.- See Also:
CompassPoint.NORTH
,CompassPoint.EAST
,CompassPoint.SOUTH
,CompassPoint.WEST
-
-