org.pepstock.charba.client.colors

Enum GradientScope

java.lang.Object

java.lang.Enum<GradientScope>

org.pepstock.charba.client.colors.GradientScope

All Implemented Interfaces:

Serializable, Comparable<GradientScope>, Key

public enum GradientScope
extends Enum<GradientScope>
implements Key

A gradient needs to have coordinates and/or radius to be created.
The dimension to create a gradient are decided by Charba, automatically based on canvas or chart area element.

Author:

Andrea "Stock" Stocchero

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANVAS The dimension to create a gradient is the canvas.
CHART The dimension to create a gradient is the chart area.

Method Summary

Modifier and Type	Method and Description
String	value() Returns the name value of property
static GradientScope	valueOf(String name) Returns the enum constant of this type with the specified name.
static GradientScope[]	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

checkIfValid, compare, create, equals, getKeyByValue, getKeyByValue, hasKeyByValue, isValid

Enum Constant Detail

CHART

public static final GradientScope CHART

The dimension to create a gradient is the chart area.

CANVAS

public static final GradientScope CANVAS

The dimension to create a gradient is the canvas.

Method Detail

values

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

Returns:

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

valueOf

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

value

public String value()

Description copied from interface: Key

Returns the name value of property

Specified by:

value in interface Key

Returns:

the name value of property