org.pepstock.charba.client.colors

Enum GradientOrientation

java.lang.Object

java.lang.Enum<GradientOrientation>

org.pepstock.charba.client.colors.GradientOrientation

All Implemented Interfaces:

Serializable, Comparable<GradientOrientation>, Key

public enum GradientOrientation
extends Enum<GradientOrientation>
implements Key

Represents the gradient orientation for gradient.
Every orientation contains also on which gradient type can be applied.

Author:

Andrea "Stock" Stocchero

Enum Constant Summary

Enum Constants

Enum Constant and Description
bottomLeft From bottom(right) to left(top) (diagonal)
bottomRight From bottom(left) to right(top) (diagonal)
bottomUp From bottom to to (vertical)
inOut From center to the borders (ONLY radial)
leftRight From left to right (horizontal)
outIn From borders to the center (ONLY radial)
rightLeft From right to left (horizontal)
topDown From top to bottom (vertical)
topLeft From top(right) to left(bottom) (diagonal)
topRight From top(left) to right(bottom) (diagonal)

Method Summary

Modifier and Type	Method and Description
static GradientOrientation	getDefaultByType(GradientType type) Returns the default orientation based on gradient type.
GradientType	getType() Returns the supported gradient type.
static GradientOrientation	valueOf(String name) Returns the enum constant of this type with the specified name.
static GradientOrientation[]	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

Methods inherited from interface org.pepstock.charba.client.commons.Key

name

Enum Constant Detail

topDown

public static final GradientOrientation topDown

From top to bottom (vertical)

bottomUp

public static final GradientOrientation bottomUp

From bottom to to (vertical)

leftRight

public static final GradientOrientation leftRight

From left to right (horizontal)

rightLeft

public static final GradientOrientation rightLeft

From right to left (horizontal)

topRight

public static final GradientOrientation topRight

From top(left) to right(bottom) (diagonal)

bottomLeft

public static final GradientOrientation bottomLeft

From bottom(right) to left(top) (diagonal)

topLeft

public static final GradientOrientation topLeft

From top(right) to left(bottom) (diagonal)

bottomRight

public static final GradientOrientation bottomRight

From bottom(left) to right(top) (diagonal)

inOut

public static final GradientOrientation inOut

From center to the borders (ONLY radial)

outIn

public static final GradientOrientation outIn

From borders to the center (ONLY radial)

Method Detail

values

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

Returns:

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

valueOf

public static GradientOrientation 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

getType

public GradientType getType()

Returns the supported gradient type.

Returns:

the supported gradient type

getDefaultByType

public static final GradientOrientation getDefaultByType(GradientType type)

Returns the default orientation based on gradient type.

Parameters:

type - gradient type

Returns:

the default orientation based on gradient type.