Module io.sf.carte.css4j

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

Class ColorValue

java.lang.Object

io.sf.carte.doc.style.css.property.StyleValue

io.sf.carte.doc.style.css.property.PrimitiveValue

io.sf.carte.doc.style.css.property.ColorValue

All Implemented Interfaces:

CSSPrimitiveValue2, ExtendedCSSPrimitiveValue, ExtendedCSSValue, Cloneable, CSSPrimitiveValue, CSSValue

public class ColorValue
extends PrimitiveValue

Color-specific CSSPrimitiveValue.

Field Summary

Fields

Modifier and Type	Field	Description
static final NumberValue	opaqueAlpha

Fields inherited from interface org.w3c.dom.css.CSSPrimitiveValue

CSS_ATTR, CSS_CM, CSS_COUNTER, CSS_DEG, CSS_DIMENSION, CSS_EMS, CSS_EXS, CSS_GRAD, CSS_HZ, CSS_IDENT, CSS_IN, CSS_KHZ, CSS_MM, CSS_MS, CSS_NUMBER, CSS_PC, CSS_PERCENTAGE, CSS_PT, CSS_PX, CSS_RAD, CSS_RECT, CSS_RGBCOLOR, CSS_S, CSS_STRING, CSS_UNKNOWN, CSS_URI

Fields inherited from interface io.sf.carte.doc.style.css.CSSPrimitiveValue2

CSS_CAP, CSS_CH, CSS_COUNTERS, CSS_CUSTOM_PROPERTY, CSS_DPCM, CSS_DPI, CSS_DPPX, CSS_ELEMENT_REFERENCE, CSS_ENV_VAR, CSS_EXPRESSION, CSS_FR, CSS_FUNCTION, CSS_GRADIENT, CSS_IC, CSS_LH, CSS_QUARTER_MM, CSS_RATIO, CSS_REM, CSS_RLH, CSS_TURN, CSS_UNICODE_CHARACTER, CSS_UNICODE_RANGE, CSS_UNICODE_WILDCARD, CSS_VB, CSS_VH, CSS_VI, CSS_VMAX, CSS_VMIN, CSS_VW

Fields inherited from interface org.w3c.dom.css.CSSValue

CSS_CUSTOM, CSS_INHERIT, CSS_PRIMITIVE_VALUE, CSS_VALUE_LIST

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ColorValue(ColorValue copied)

Method Summary

Modifier and Type	Method	Description
ColorValue	clone()	Creates and returns a copy of this object.
boolean	equals(Object obj)
RGBAColor.ColorSpace	getColorSpace()
String	getCssText()	Get a string representation of the current value.
String	getMinifiedCssText(String propertyValue)	Gives a minified version of the css text of the property, for the given property name.
RGBAColor	getRGBColorValue()	Get the RGBA color.
String	getStringValue()
int	hashCode()
boolean	isSystemDefault()	Is this value a wildcard for a system-dependent default?
void	setCssText(String cssText)	Attempts to change this value to match the supplied css text.
void	setSystemDefault()
void	writeCssText(SimpleWriter wri)	Serialize this value to a SimpleWriter.

Methods inherited from class io.sf.carte.doc.style.css.property.PrimitiveValue

getCounterValue, getFloatValue, getPrimitiveType, getRectValue, isCalculatedNumber, isNegativeNumber, isNumberZero, isSubproperty, setExpectInteger, setFloatValue, setStringValue, setSubproperty

Methods inherited from class io.sf.carte.doc.style.css.property.StyleValue

getCssValueType, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.w3c.dom.css.CSSValue

getCssValueType

Field Details

opaqueAlpha

public static final NumberValue opaqueAlpha

Constructor Details

ColorValue

protected ColorValue(ColorValue copied)

Method Details

setSystemDefault

public void setSystemDefault()

isSystemDefault

public boolean isSystemDefault()

Description copied from class: StyleValue

Is this value a wildcard for a system-dependent default?

If that is the case, it cannot be used to compute values.

Overrides:

isSystemDefault in class StyleValue

Returns:

true if this is a placeholder for a system-dependent default, false otherwise.

setCssText

public void setCssText(String cssText)
                throws DOMException

Description copied from class: StyleValue

Attempts to change this value to match the supplied css text.

In css4j, it is not recommended to set property values using this method.

Specified by:

setCssText in interface CSSValue

Overrides:

setCssText in class StyleValue

Throws:

DOMException - SYNTAX_ERR: Raised if the specified CSS string value has a syntax error (according to the attached property) or is unparsable.
INVALID_MODIFICATION_ERR: Raised if the specified CSS string value represents a different type of values than the values allowed by the CSS property.
NO_MODIFICATION_ALLOWED_ERR: Raised if this value is read-only.

getColorSpace

public RGBAColor.ColorSpace getColorSpace()

getCssText

public String getCssText()

Description copied from class: StyleValue

Get a string representation of the current value.

Specified by:

getCssText in interface CSSValue

Returns:

the css text representing the value of this property.

getMinifiedCssText

public String getMinifiedCssText(String propertyValue)

Description copied from interface: ExtendedCSSValue

Gives a minified version of the css text of the property, for the given property name.

Specified by:

getMinifiedCssText in interface ExtendedCSSValue

Overrides:

getMinifiedCssText in class StyleValue

Parameters:

propertyValue - the property name.

Returns:

the minified css text.

writeCssText

public void writeCssText(SimpleWriter wri)
                  throws IOException

Description copied from interface: ExtendedCSSValue

Serialize this value to a SimpleWriter.

Specified by:

writeCssText in interface ExtendedCSSValue

Parameters:

wri - the SimpleWriter.

Throws:

IOException - if an error happened while writing.

getStringValue

public String getStringValue()
                      throws DOMException

Specified by:

getStringValue in interface CSSPrimitiveValue

Overrides:

getStringValue in class PrimitiveValue

Throws:

DOMException

getRGBColorValue

public RGBAColor getRGBColorValue()
                           throws DOMException

Description copied from interface: CSSPrimitiveValue2

Get the RGBA color. If this CSS value doesn't contain a RGB color value, a DOMException is raised.

Specified by:

getRGBColorValue in interface CSSPrimitiveValue

Specified by:

getRGBColorValue in interface CSSPrimitiveValue2

Overrides:

getRGBColorValue in class PrimitiveValue

Returns:

the RGBA color value.

Throws:

DOMException - INVALID_ACCESS_ERR: Raised if the attached property can't return a RGB color value (e.g. this is not CSS_RGBCOLOR).

hashCode

public int hashCode()

Overrides:

hashCode in class PrimitiveValue

equals

public boolean equals(Object obj)

Overrides:

equals in class PrimitiveValue

clone

public ColorValue clone()

Description copied from class: PrimitiveValue

Creates and returns a copy of this object.

The object will be the same except for the subproperty flag, that will be disabled in the clone object.

Specified by:

clone in interface ExtendedCSSValue

Specified by:

clone in class PrimitiveValue

Returns:

a copy of this object.