org.pepstock.charba.client.impl.plugins.enums

Enum GwtMaterialScheme

java.lang.Object

java.lang.Enum<GwtMaterialScheme>

org.pepstock.charba.client.impl.plugins.enums.GwtMaterialScheme

All Implemented Interfaces:

Serializable, Comparable<GwtMaterialScheme>

public enum GwtMaterialScheme
extends Enum<GwtMaterialScheme>

Contains all scheme definitions to map the GWT material schemes.
To configure ColorSchemes.ID plugin, where category is "gwtmaterial".
Every color scheme has a number at the end of its name, which indicates the number of that colors included in the scheme. If the number of the datasets is larger than it, the same colors will appear repeatedly. A color is not modified if it is specified by dataset options.

Author:

Andrea "Stock" Stocchero

Enum Constant Summary

Enum Constants

Enum Constant and Description
AMBER Color scheme name "AMBER" -
BLUE Color scheme name "BLUE" -
BROWN Color scheme name "BROWN" -
CYAN Color scheme name "CYAN" -
GREEN Color scheme name "GREEN" -
GREY Color scheme name "GREY" -
INDIGO Color scheme name "INDIGO" -
LIME Color scheme name "LIME" -
ORANGE Color scheme name "ORANGE" -
PINK Color scheme name "PINK" -
PURPLE Color scheme name "PURPLE" -
RED Color scheme name "RED" -
TEAL Color scheme name "TEAL" -
YELLOW Color scheme name "YELLOW" -

Method Summary

Modifier and Type	Method and Description
default String	category() Returns the color scheme category.
default List<IsColor>	getColors() Returns a list of colors which are composing a color scheme.
ColorScheme	getScheme() Returns the internal enumerated scheme instance.
void	loadGradient(Gradient gradient) Loads a gradient with the scheme of colors, setting the offset proportionally.
default String	value() Returns the name value of property
static GwtMaterialScheme	valueOf(String name) Returns the enum constant of this type with the specified name.
static GwtMaterialScheme[]	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.impl.plugins.ColorScheme

isValid

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

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

Enum Constant Detail

BLUE

public static final GwtMaterialScheme BLUE

Color scheme name "BLUE" -

PURPLE

public static final GwtMaterialScheme PURPLE

Color scheme name "PURPLE" -

GREEN

public static final GwtMaterialScheme GREEN

Color scheme name "GREEN" -

INDIGO

public static final GwtMaterialScheme INDIGO

Color scheme name "INDIGO" -

RED

public static final GwtMaterialScheme RED

Color scheme name "RED" -

PINK

public static final GwtMaterialScheme PINK

Color scheme name "PINK" -

AMBER

public static final GwtMaterialScheme AMBER

Color scheme name "AMBER" -

LIME

public static final GwtMaterialScheme LIME

Color scheme name "LIME" -

TEAL

public static final GwtMaterialScheme TEAL

Color scheme name "TEAL" -

YELLOW

public static final GwtMaterialScheme YELLOW

Color scheme name "YELLOW" -

CYAN

public static final GwtMaterialScheme CYAN

Color scheme name "CYAN" -

BROWN

public static final GwtMaterialScheme BROWN

Color scheme name "BROWN" -

GREY

public static final GwtMaterialScheme GREY

Color scheme name "GREY" -

ORANGE

public static final GwtMaterialScheme ORANGE

Color scheme name "ORANGE" -

Method Detail

values

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

Returns:

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

valueOf

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

getScheme

public ColorScheme getScheme()

Returns the internal enumerated scheme instance.

Returns:

the internal enumerated scheme instance

loadGradient

public void loadGradient(Gradient gradient)

Loads a gradient with the scheme of colors, setting the offset proportionally.

Parameters:

gradient - gradient instance to be loaded with colors

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

category

public String category()

Description copied from interface: ColorScheme

Returns the color scheme category. If not implemented, the default is ColorSchemesOptions.DEFAULT_SCHEME_CATEGORY.

Specified by:

category in interface ColorScheme

Returns:

the color scheme category. If not implemented, the default is ColorSchemesOptions.DEFAULT_SCHEME_CATEGORY

getColors

public List<IsColor> getColors()

Description copied from interface: ColorScheme

Returns a list of colors which are composing a color scheme.

Specified by:

getColors in interface ColorScheme

Returns:

a list of colors which are composing a color scheme