Module io.sf.carte.css4j

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

Interface CSSPrimitiveValue

All Superinterfaces:

Cloneable, CSSValue

All Known Subinterfaces:

CSSColorMixFunction, CSSColorValue, CSSCountersValue, CSSCounterValue, CSSEnvVariableValue, CSSExpressionValue, CSSFunctionValue, CSSGradientValue, CSSLexicalValue, CSSMathFunctionValue, CSSMathValue, CSSNumberValue, CSSRatioValue, CSSTransformFunction, CSSTypedValue, CSSUnicodeRangeValue, CSSUnicodeRangeValue.CSSUnicodeValue, CSSVarValue, HSLColorValue, HWBColorValue, LABColorValue, LCHColorValue

All Known Implementing Classes:

CalcValue, ColorValue, EnvVariableValue, ExpressionValue, FunctionValue, GradientValue, HSLColorValue, HWBColorValue, IdentifierValue, LABColorValue, LCHColorValue, LexicalValue, MathFunctionValue, NumberValue, PercentageValue, PrimitiveValue, ProxyValue, RatioValue, RectValue, RGBColorValue, StringValue, SystemDefaultValue, TransformFunction, TypedValue, UnicodeRangeValue, UnicodeValue, UnicodeWildcardValue, UnknownValue, URIValue, URIValueWrapper

public interface CSSPrimitiveValue
extends CSSValue

A CSS primitive value.

Primitive values include two categories: TYPED and PROXY values.

Nested Class Summary

Nested classes/interfaces inherited from interface io.sf.carte.doc.style.css.CSSValue

CSSValue.CssType, CSSValue.Type

Method Summary

Modifier and Type	Method	Description
default short	getUnitType()	If this is a NUMERIC value, get its unit type.
default boolean	isNegativeNumber()	Test whether this is a numeric value that is less than zero.
default boolean	isPrimitiveValue()	Check whether this value is primitive, that is, either a TYPED or PROXY value.
void	setExpectInteger()	This value is expected to contain an integer.

Methods inherited from interface io.sf.carte.doc.style.css.CSSValue

clone, getCssText, getCssValueType, getMinifiedCssText, getMinifiedCssText, getPrecedingComments, getPrimitiveType, getTrailingComments, matches, setCssText, writeCssText

Method Details

setExpectInteger

void setExpectInteger()
               throws DOMException

This value is expected to contain an integer.

If this value is a non-integer number, an exception will be thrown immediately.

If this value is a calc() that ever produces a non-integer number, the value shall be rounded to the nearest integer.

If the value is a proxy that ever produces other than an integer number (without calc() involvement), an exception should be thrown later.

Throws:

DOMException - TYPE_MISMATCH_ERR if the value is a constant number and not an integer.

isNegativeNumber

default boolean isNegativeNumber()

Test whether this is a numeric value that is less than zero.

Returns:

true if this is a numeric value and its value is negative.

isPrimitiveValue

default boolean isPrimitiveValue()

Check whether this value is primitive, that is, either a TYPED or PROXY value.

Specified by:

isPrimitiveValue in interface CSSValue

Returns:

true if the value is TYPED or PROXY.

getUnitType

default short getUnitType()

If this is a NUMERIC value, get its unit type.

You can also find the unit types of mathematical functions and calc() expressions, although this may be computationally expensive:

• For calc() expressions please use CSSMathValue.computeUnitType().
• For mathematical functions use CSSMathFunctionValue.computeUnitType().

Returns:

the unit type as in CSSUnit, or CSS_INVALID if the type is not numeric or the unit is not valid.