com.github.gwtd3.api.svg

Enum Axis.Orientation

java.lang.Object

java.lang.Enum<Axis.Orientation>

com.github.gwtd3.api.svg.Axis.Orientation

All Implemented Interfaces:

Serializable, Comparable<Axis.Orientation>

Enclosing class:

Axis

public static enum Axis.Orientation
extends Enum<Axis.Orientation>

Orientation of the ticks in relation to the axis.

The choice of the tick orientation induce the orientation of the axis.

Author:

Anthony Schiochet

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTTOM Ticks as below the horizontal axis.
LEFT Ticks as on the left of the vertical axis.
RIGHT Ticks as on the right of the vertical axis.
TOP Ticks as above the horizontal axis.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isHorizontalAxis()
boolean	isVerticalAxis()
static Axis.Orientation	valueOf(String name) Returns the enum constant of this type with the specified name.
static Axis.Orientation[]	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

TOP

public static final Axis.Orientation TOP

Ticks as above the horizontal axis.

BOTTOM

public static final Axis.Orientation BOTTOM

Ticks as below the horizontal axis.

LEFT

public static final Axis.Orientation LEFT

Ticks as on the left of the vertical axis.

RIGHT

public static final Axis.Orientation RIGHT

Ticks as on the right of the vertical axis.

Method Detail

values

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

Returns:

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

valueOf

public static Axis.Orientation 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

isVerticalAxis

public boolean isVerticalAxis()

Returns:

true if the Orientation denote a vertical axis

isHorizontalAxis

public boolean isHorizontalAxis()

Returns:

true if the Orientation denote a horizontal axis