com.steadystate.css.dom

Class CSSValueImpl

Implemented Interfaces:
CSSPrimitiveValue, CSSValue, CSSValueList, Serializable

public class CSSValueImpl
extends java.lang.Object
implements CSSPrimitiveValue, CSSValueList, Serializable

The CSSValueImpl class can represent either a CSSPrimitiveValue or a CSSValueList so that the type can successfully change when using setCssText. TO DO: Float unit conversions, A means of checking valid primitive types for properties
Version:
$Release$
Author:
David Schweinsberg

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 org.w3c.dom.css.CSSValue

CSS_CUSTOM, CSS_INHERIT, CSS_PRIMITIVE_VALUE, CSS_VALUE_LIST

Constructor Summary

CSSValueImpl(LexicalUnit value)
CSSValueImpl(LexicalUnit value, boolean forcePrimitive)
Constructor

Method Summary

Counter
getCounterValue()
This method is used to get the Counter value.
String
getCssText()
A string representation of the current value.
short
getCssValueType()
A code defining the type of the value as defined above.
float
getFloatValue(short unitType)
This method is used to get a float value in a specified unit.
int
getLength()
short
getPrimitiveType()
The type of the value as defined by the constants specified above.
RGBColor
getRGBColorValue()
This method is used to get the RGB color.
Rect
getRectValue()
This method is used to get the Rect value.
String
getStringValue()
TODO: return a value for a list type
CSSValue
item(int index)
void
setCssText(String cssText)
void
setFloatValue(short unitType, float floatValue)
A method to set the float value with a specified unit.
void
setStringValue(short stringType, String stringValue)
A method to set the string value with the specified unit.
String
toString()

Constructor Details

CSSValueImpl

public CSSValueImpl(LexicalUnit value)

CSSValueImpl

public CSSValueImpl(LexicalUnit value,
                    boolean forcePrimitive)
Constructor

Method Details

getCounterValue

public Counter getCounterValue()
            throws DOMException
This method is used to get the Counter value. If this CSS value doesn't contain a counter value, a DOMException is raised. Modification to the corresponding style property can be achieved using the Counter interface.
Specified by:
getCounterValue in interface CSSPrimitiveValue
Returns:
The Counter value.

getCssText

public String getCssText()
A string representation of the current value.
Specified by:
getCssText in interface CSSValue

getCssValueType

public short getCssValueType()
A code defining the type of the value as defined above.
Specified by:
getCssValueType in interface CSSValue

getFloatValue

public float getFloatValue(short unitType)
            throws DOMException
This method is used to get a float value in a specified unit. If this CSS value doesn't contain a float value or can't be converted into the specified unit, a DOMException is raised.
Specified by:
getFloatValue in interface CSSPrimitiveValue
Parameters:
unitType - A unit code to get the float value. The unit code can only be a float unit type (i.e. CSS_NUMBER, CSS_PERCENTAGE, CSS_EMS, CSS_EXS, CSS_PX, CSS_CM, CSS_MM, CSS_IN, CSS_PT, CSS_PC, CSS_DEG, CSS_RAD, CSS_GRAD, CSS_MS, CSS_S, CSS_HZ, CSS_KHZ, CSS_DIMENSION).
Returns:
The float value in the specified unit.

getLength

public int getLength()
Specified by:
getLength in interface CSSValueList

getPrimitiveType

public short getPrimitiveType()
The type of the value as defined by the constants specified above.
Specified by:
getPrimitiveType in interface CSSPrimitiveValue

getRGBColorValue

public RGBColor getRGBColorValue()
            throws DOMException
This method is used to get the RGB color. If this CSS value doesn't contain a RGB color value, a DOMException is raised. Modification to the corresponding style property can be achieved using the RGBColor interface.
Specified by:
getRGBColorValue in interface CSSPrimitiveValue
Returns:
the RGB color value.

getRectValue

public Rect getRectValue()
            throws DOMException
This method is used to get the Rect value. If this CSS value doesn't contain a rect value, a DOMException is raised. Modification to the corresponding style property can be achieved using the Rect interface.
Specified by:
getRectValue in interface CSSPrimitiveValue
Returns:
The Rect value.

getStringValue

public String getStringValue()
            throws DOMException
TODO: return a value for a list type
Specified by:
getStringValue in interface CSSPrimitiveValue

item

public CSSValue item(int index)
Specified by:
item in interface CSSValueList

setCssText

public void setCssText(String cssText)
            throws DOMException
Specified by:
setCssText in interface CSSValue

setFloatValue

public void setFloatValue(short unitType,
                          float floatValue)
            throws DOMException
A method to set the float value with a specified unit. If the property attached with this value can not accept the specified unit or the float value, the value will be unchanged and a DOMException will be raised.
Specified by:
setFloatValue in interface CSSPrimitiveValue
Parameters:
unitType - A unit code as defined above. The unit code can only be a float unit type (i.e. CSS_NUMBER, CSS_PERCENTAGE, CSS_EMS, CSS_EXS, CSS_PX, CSS_CM, CSS_MM, CSS_IN, CSS_PT, CSS_PC, CSS_DEG, CSS_RAD, CSS_GRAD, CSS_MS, CSS_S, CSS_HZ, CSS_KHZ, CSS_DIMENSION).
floatValue - The new float value.

setStringValue

public void setStringValue(short stringType,
                           String stringValue)
            throws DOMException
A method to set the string value with the specified unit. If the property attached to this value can't accept the specified unit or the string value, the value will be unchanged and a DOMException will be raised.
Specified by:
setStringValue in interface CSSPrimitiveValue
Parameters:
stringType - A string code as defined above. The string code can only be a string unit type (i.e. CSS_STRING, CSS_URI, CSS_IDENT, and CSS_ATTR).
stringValue - The new string value.

toString

public String toString()