Package com.jbstrap.ui.components.form.items.colorpicker

Enum Class ColorFormat

java.lang.Object

java.lang.Enum<ColorFormat>

com.jbstrap.ui.components.form.items.colorpicker.ColorFormat

All Implemented Interfaces:

Serializable, Comparable<ColorFormat>, Constable

public enum ColorFormat
extends Enum<ColorFormat>

Enum containing the color picker formats

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
HEX	The colors will be displayed in a hexadecimal format.
RGB	The colors will be displayed in an RGB format, following the CSS3 standard. Format: rgb(r, g, b)
RGBA	The colors will be displayed in an RGBA format, following the CSS3 standard.

Method Summary

Modifier and Type	Method	Description
static ColorFormat	fromJavaScriptName(String javaScriptName)
String	getJavaScriptName()
static ColorFormat	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ColorFormat[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

HEX

public static final ColorFormat HEX

The colors will be displayed in a hexadecimal format. This is the default format used by the color picker
Format: #rrggbb

RGB

public static final ColorFormat RGB

The colors will be displayed in an RGB format, following the CSS3 standard.
Format: rgb(r, g, b)

RGBA

public static final ColorFormat RGBA

The colors will be displayed in an RGBA format, following the CSS3 standard. The last value is for the opacity. Must be between 0 and 1.
Format: rgba(r, b, g, a)

Method Details

values

public static ColorFormat[] 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 ColorFormat 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

getJavaScriptName

public String getJavaScriptName()

Returns:

The name of the format in JavaScript

fromJavaScriptName

public static ColorFormat fromJavaScriptName(String javaScriptName)

Parameters:

javaScriptName - The JavaScript name

Returns:

The format corresponding to the name or null, if not found