Module io.sf.carte.css4j

Package io.sf.carte.doc.style.css

Enum Class CSSValue.Type

java.lang.Object

java.lang.Enum<CSSValue.Type>

io.sf.carte.doc.style.css.CSSValue.Type

All Implemented Interfaces:

Serializable, Comparable<CSSValue.Type>, java.lang.constant.Constable

Enclosing interface:

CSSValue

public static enum CSSValue.Type
extends Enum<CSSValue.Type>

The type of value. For keywords, it is the keyword.

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
CIRCLE	circle() function (see CSS Shapes Level 1).
COLOR	Color.
COLOR_MIX	Color-Mix function.
COUNTER	CSS counter() function.
COUNTERS	CSS counters() function.
CUBIC_BEZIER	cubic-bezier() easing function.
ELEMENT_REFERENCE	Element reference.
ELLIPSE	ellipse() function (see CSS Shapes Level 1).
ENV	Environment variable.
EXPRESSION	An expression with algebraic syntax (i.e.
FUNCTION	Function.
GRADIENT	Gradient function.
IDENT	Identifier.
IMAGE_SET	image-set()
INHERIT	inherit keyword.
INITIAL	initial keyword.
INSET	inset() function (see CSS Shapes Level 1).
INTERNAL	For this library's internal use.
INVALID	Invalid (non-primitive and non-keyword) value.
LEXICAL	Lexical value.
LINEAR	linear() easing function.
MATH_FUNCTION	Mathematical function (as defined by CSS Values and Units).
NUMERIC	Numeric type (excludes calc() which is an EXPRESSION).
PATH	path() function (see CSS Shapes Level 1).
POLYGON	polygon() function (see CSS Shapes Level 1).
RATIO	Ratio value.
RECT	rect() function.
REVERT	revert keyword.
SHAPE	shape() function (see CSS Shapes Level 2).
SRC	src() function.
STEPS	steps() easing function.
STRING	String.
TRANSFORM_FUNCTION	Transform function (see CSS Transforms Module Level 1).
UNICODE_CHARACTER	Unicode character.
UNICODE_RANGE	Unicode range.
UNICODE_WILDCARD	Unicode wildcard.
UNKNOWN	Unknown type, probably a system default or a compat value.
UNSET	unset keyword.
URI	URI (url()).
XYWH	xywh() function (see CSS Shapes Level 1).

Method Summary

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

UNKNOWN

public static final CSSValue.Type UNKNOWN

Unknown type, probably a system default or a compat value.

INHERIT

public static final CSSValue.Type INHERIT

inherit keyword.

INITIAL

public static final CSSValue.Type INITIAL

initial keyword.

UNSET

public static final CSSValue.Type UNSET

unset keyword.

REVERT

public static final CSSValue.Type REVERT

revert keyword.

NUMERIC

public static final CSSValue.Type NUMERIC

Numeric type (excludes calc() which is an EXPRESSION).

Cast to CSSNumberValue, although CSSTypedValue or TypedValue may give you what you need (like the numeric value via getFloatValue). If neither do, please look at NumberValue.

STRING

public static final CSSValue.Type STRING

String.

Casting to CSSTypedValue or TypedValue will give you access to the string value via getStringValue().

IDENT

public static final CSSValue.Type IDENT

Identifier.

Casting to CSSTypedValue or TypedValue will give you access to the identifier value via getStringValue().

COLOR

public static final CSSValue.Type COLOR

Color.

Casting to CSSColorValue or ColorValue provides methods like getColorModel() or getColor() (the latter provides the actual color as a CSSColor).

Once you retrieve the color, you can then use the indexed component access in CSSColor.item(int), or cast it to a model sub-interface (like RGBAColor) according to the result of getColorModel(). See ColorModel for details.

COLOR_MIX

public static final CSSValue.Type COLOR_MIX

Color-Mix function.

Cast to CSSColorMixFunction.

getColor() provides the interpolated color as a CSSColor.

Once you retrieve the color, you can then use the indexed component access in CSSColor.item(int), or cast it to a model sub-interface (like RGBAColor) according to the result of getColorModel(). See ColorModel for details.

URI

public static final CSSValue.Type URI

URI (url()).

Casting to CSSTypedValue or TypedValue will give you access to the URL value as a string, via getStringValue() and is probably all that you need.

You could also cast to URIValue, which gives you a couple of convenience methods like isEquivalent or getURLValue().

SRC

public static final CSSValue.Type SRC

src() function.

Cast to CSSFunctionValue or FunctionValue.

RECT

public static final CSSValue.Type RECT

rect() function.

Cast to CSSRectValue or RectValue.

EXPRESSION

public static final CSSValue.Type EXPRESSION

An expression with algebraic syntax (i.e. calc()).

See CSSExpressionValue.

GRADIENT

public static final CSSValue.Type GRADIENT

Gradient function.

Cast to CSSGradientValue.

COUNTER

public static final CSSValue.Type COUNTER

CSS counter() function.

See CSSCounterValue.

COUNTERS

public static final CSSValue.Type COUNTERS

CSS counters() function.

See CSSCountersValue.

CUBIC_BEZIER

public static final CSSValue.Type CUBIC_BEZIER

cubic-bezier() easing function.

Cast to CSSFunctionValue.

LINEAR

public static final CSSValue.Type LINEAR

linear() easing function.

Cast to CSSFunctionValue.

STEPS

public static final CSSValue.Type STEPS

steps() easing function.

Cast to CSSFunctionValue.

FUNCTION

public static final CSSValue.Type FUNCTION

Function.

Cast to CSSFunctionValue or FunctionValue.

Note: on functions, CSSTypedValue.getStringValue() must return the function name.

MATH_FUNCTION

public static final CSSValue.Type MATH_FUNCTION

Mathematical function (as defined by CSS Values and Units).

Cast to CSSMathFunctionValue.

Note: on functions, CSSTypedValue.getStringValue() must return the function name.

CIRCLE

public static final CSSValue.Type CIRCLE

circle() function (see CSS Shapes Level 1).

Cast to CSSFunctionValue.

ELLIPSE

public static final CSSValue.Type ELLIPSE

ellipse() function (see CSS Shapes Level 1).

Cast to CSSFunctionValue.

INSET

public static final CSSValue.Type INSET

inset() function (see CSS Shapes Level 1).

Cast to CSSFunctionValue.

PATH

public static final CSSValue.Type PATH

path() function (see CSS Shapes Level 1).

Cast to CSSPathValue.

POLYGON

public static final CSSValue.Type POLYGON

polygon() function (see CSS Shapes Level 1).

Cast to CSSFunctionValue.

SHAPE

public static final CSSValue.Type SHAPE

shape() function (see CSS Shapes Level 2).

Cast to CSSFunctionValue.

XYWH

public static final CSSValue.Type XYWH

xywh() function (see CSS Shapes Level 1).

Cast to CSSFunctionValue.

TRANSFORM_FUNCTION

public static final CSSValue.Type TRANSFORM_FUNCTION

Transform function (see CSS Transforms Module Level 1).

Cast to CSSTransformFunction.

UNICODE_RANGE

public static final CSSValue.Type UNICODE_RANGE

Unicode range. See CSSUnicodeRangeValue.

UNICODE_CHARACTER

public static final CSSValue.Type UNICODE_CHARACTER

Unicode character. See CSSUnicodeRangeValue.CSSUnicodeValue.

UNICODE_WILDCARD

public static final CSSValue.Type UNICODE_WILDCARD

Unicode wildcard. See CSSUnicodeRangeValue.

IMAGE_SET

public static final CSSValue.Type IMAGE_SET

image-set()

Cast to CSSFunctionValue.

ELEMENT_REFERENCE

public static final CSSValue.Type ELEMENT_REFERENCE

Element reference.

Casting to CSSTypedValue or TypedValue will give you access to the reference value via CSSTypedValue.getStringValue().

RATIO

public static final CSSValue.Type RATIO

Ratio value.

Cast to CSSRatioValue or RatioValue.

ENV

public static final CSSValue.Type ENV

Environment variable. See CSSEnvVariableValue.

LEXICAL

public static final CSSValue.Type LEXICAL

Lexical value.

Cast to CSSLexicalValue or LexicalValue.

INTERNAL

public static final CSSValue.Type INTERNAL

For this library's internal use.

INVALID

public static final CSSValue.Type INVALID

Invalid (non-primitive and non-keyword) value.

The value is either a list or a shorthand.

Method Details

values

public static CSSValue.Type[] 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 CSSValue.Type 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