Module io.sf.carte.css4j

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

Class EnvVariableValue

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.EnvVariableValue

All Implemented Interfaces:

CSSEnvVariableValue, CSSPrimitiveValue2, ExtendedCSSPrimitiveValue, ExtendedCSSValue, Cloneable, CSSPrimitiveValue, CSSValue

public class EnvVariableValue
extends PrimitiveValue
implements CSSEnvVariableValue

Environment variable (env) CSSPrimitiveValue.

Field Summary

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	EnvVariableValue(EnvVariableValue copied)

Method Summary

Modifier and Type	Method	Description
EnvVariableValue	clone()	Creates and returns a copy of this object.
boolean	equals(Object obj)
String	getCssText()	Get a string representation of the current value.
ExtendedCSSValue	getFallback()	Get the fallback value to be used if the referenced variable name is not known.
String	getMinifiedCssText(String propertyName)	Gives a minified version of the css text of the property, for the given property name.
String	getName()	Get the name of this environment variable.
String	getStringValue()
int	hashCode()
void	setCssText(String cssText)	Attempts to change this value to match the supplied css text.
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, getRGBColorValue, isCalculatedNumber, isNegativeNumber, isNumberZero, isSubproperty, setExpectInteger, setFloatValue, setStringValue, setSubproperty

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

getCssValueType, isSystemDefault, toString

Methods inherited from class java.lang.Object

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

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

getCounterValue, getFloatValue, getPrimitiveType, getRectValue, setFloatValue, setStringValue

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

getRGBColorValue, isCalculatedNumber, isNegativeNumber

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

getCssValueType

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

isNumberZero

Constructor Details

EnvVariableValue

protected EnvVariableValue(EnvVariableValue copied)

Method Details

getCssText

public String getCssText()

Description copied from class: StyleValue

Get a string representation of the current value.

Specified by:

getCssText in interface CSSValue

Specified by:

getCssText in class StyleValue

Returns:

the css text representing the value of this property.

getMinifiedCssText

public String getMinifiedCssText(String propertyName)

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:

propertyName - 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.

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.

hashCode

public int hashCode()

Overrides:

hashCode in class PrimitiveValue

equals

public boolean equals(Object obj)

Overrides:

equals in class PrimitiveValue

getName

public String getName()

Description copied from interface: CSSEnvVariableValue

Get the name of this environment variable.

Specified by:

getName in interface CSSEnvVariableValue

Returns:

the name of this environment variable.

getStringValue

public String getStringValue()

Specified by:

getStringValue in interface CSSPrimitiveValue

Overrides:

getStringValue in class PrimitiveValue

getFallback

public ExtendedCSSValue getFallback()

Description copied from interface: CSSEnvVariableValue

Get the fallback value to be used if the referenced variable name is not known.

Specified by:

getFallback in interface CSSEnvVariableValue

Returns:

the fallback value, or null if there is no fallback value.

clone

public EnvVariableValue 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 CSSEnvVariableValue

Specified by:

clone in interface ExtendedCSSValue

Specified by:

clone in class PrimitiveValue

Returns:

a copy of this object.