Package com.jbstrap.ui.components.charts.params.enums

Enum Class ColorTemplate

java.lang.Object

java.lang.Enum<ColorTemplate>

com.jbstrap.ui.components.charts.params.enums.ColorTemplate

All Implemented Interfaces:

Serializable, Comparable<ColorTemplate>, Constable

public enum ColorTemplate
extends Enum<ColorTemplate>

Color templates to be used for a GaugeChart.

Since:

4.0

Author:

JBStrap

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DARK_TO_LIGHT	The lower slice of the gauge chart is the theme’s dark color, the upper slice is the theme’s light color.
GREEN_TO_RED	The lower slice of the gauge chart is green, the upper slice is red.
LIGHT_TO_DARK	The lower slice of the gauge chart is the theme’s light color, the upper slice is the theme’s dark color.
RED_TO_GREEN	The lower slice of the gauge chart is red, the upper slice is green.

Method Summary

Modifier and Type	Method	Description
static ColorTemplate	fromName(String name)	Determines the color scheme by the specified name.
String	toString()
static ColorTemplate	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ColorTemplate[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

RED_TO_GREEN

public static final ColorTemplate RED_TO_GREEN

The lower slice of the gauge chart is red, the upper slice is green. The colors of the slices in between are automatically determined based on their positions so that a color gradient is created between red and green.

GREEN_TO_RED

public static final ColorTemplate GREEN_TO_RED

The lower slice of the gauge chart is green, the upper slice is red. The colors of the slices in between are automatically determined based on their positions so that a color gradient is created between green and red.

LIGHT_TO_DARK

public static final ColorTemplate LIGHT_TO_DARK

The lower slice of the gauge chart is the theme’s light color, the upper slice is the theme’s dark color. The colors of the slices in between are automatically determined based on their positions so that a color gradient is created between the theme’s light and dark colors.

DARK_TO_LIGHT

public static final ColorTemplate DARK_TO_LIGHT

The lower slice of the gauge chart is the theme’s dark color, the upper slice is the theme’s light color. The colors of the slices in between are automatically determined based on their positions so that a color gradient is created between the theme’s dark and light colors.

Method Details

values

public static ColorTemplate[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ColorTemplate valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<ColorTemplate>

fromName

public static ColorTemplate fromName(String name)

Determines the color scheme by the specified name.

Parameters:

name - Color scheme name

Returns:

Color template name or null, if there is no color template by the specified name