Package com.steadystate.css.dom
Class CSSValueImpl
- java.lang.Object
-
- com.steadystate.css.dom.CSSValueImpl
-
- All Implemented Interfaces:
java.io.Serializable
,CSSPrimitiveValue
,CSSValue
,CSSValueList
public class CSSValueImpl extends java.lang.Object implements CSSPrimitiveValue, CSSValueList, java.io.Serializable
TheCSSValueImpl
class can represent either aCSSPrimitiveValue
or aCSSValueList
so that the type can successfully change when usingsetCssText
. TO DO: Float unit conversions, A means of checking valid primitive types for properties- Version:
- $Release$
- Author:
- David Schweinsberg
- See Also:
- Serialized Form
-
-
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 org.w3c.dom.css.CSSValue
CSS_CUSTOM, CSS_INHERIT, CSS_PRIMITIVE_VALUE, CSS_VALUE_LIST
-
-
Constructor Summary
Constructors Constructor Description CSSValueImpl(LexicalUnit value)
CSSValueImpl(LexicalUnit value, boolean forcePrimitive)
Constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Counter
getCounterValue()
This method is used to get the Counter value.java.lang.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()
The number ofCSSValues
in the list.short
getPrimitiveType()
The type of the value as defined by the constants specified above.Rect
getRectValue()
This method is used to get the Rect value.RGBColor
getRGBColorValue()
This method is used to get the RGB color.java.lang.String
getStringValue()
TODO: return a value for a list typeCSSValue
item(int index)
Used to retrieve aCSSValue
by ordinal index.void
setCssText(java.lang.String cssText)
void
setFloatValue(short unitType, float floatValue)
A method to set the float value with a specified unit.void
setStringValue(short stringType, java.lang.String stringValue)
A method to set the string value with the specified unit.java.lang.String
toString()
-
-
-
Constructor Detail
-
CSSValueImpl
public CSSValueImpl(LexicalUnit value, boolean forcePrimitive)
Constructor
-
CSSValueImpl
public CSSValueImpl(LexicalUnit value)
-
-
Method Detail
-
getCssText
public java.lang.String getCssText()
Description copied from interface:CSSValue
A string representation of the current value.- Specified by:
getCssText
in interfaceCSSValue
-
setCssText
public void setCssText(java.lang.String cssText) throws org.w3c.dom.DOMException
- Specified by:
setCssText
in interfaceCSSValue
- Throws:
org.w3c.dom.DOMException
-
getCssValueType
public short getCssValueType()
Description copied from interface:CSSValue
A code defining the type of the value as defined above.- Specified by:
getCssValueType
in interfaceCSSValue
-
getPrimitiveType
public short getPrimitiveType()
Description copied from interface:CSSPrimitiveValue
The type of the value as defined by the constants specified above.- Specified by:
getPrimitiveType
in interfaceCSSPrimitiveValue
-
setFloatValue
public void setFloatValue(short unitType, float floatValue) throws org.w3c.dom.DOMException
Description copied from interface:CSSPrimitiveValue
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 aDOMException
will be raised.- Specified by:
setFloatValue
in interfaceCSSPrimitiveValue
- 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.- Throws:
org.w3c.dom.DOMException
- INVALID_ACCESS_ERR: Raised if the attached property doesn't support the float value or the unit type.
NO_MODIFICATION_ALLOWED_ERR: Raised if this property is readonly.
-
getFloatValue
public float getFloatValue(short unitType) throws org.w3c.dom.DOMException
Description copied from interface:CSSPrimitiveValue
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, aDOMException
is raised.- Specified by:
getFloatValue
in interfaceCSSPrimitiveValue
- 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.
- Throws:
org.w3c.dom.DOMException
- INVALID_ACCESS_ERR: Raised if the CSS value doesn't contain a float value or if the float value can't be converted into the specified unit.
-
setStringValue
public void setStringValue(short stringType, java.lang.String stringValue) throws org.w3c.dom.DOMException
Description copied from interface:CSSPrimitiveValue
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 aDOMException
will be raised.- Specified by:
setStringValue
in interfaceCSSPrimitiveValue
- 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
, andCSS_ATTR
).stringValue
- The new string value.- Throws:
org.w3c.dom.DOMException
- INVALID_ACCESS_ERR: Raised if the CSS value doesn't contain a string value or if the string value can't be converted into the specified unit.
NO_MODIFICATION_ALLOWED_ERR: Raised if this property is readonly.
-
getStringValue
public java.lang.String getStringValue() throws org.w3c.dom.DOMException
TODO: return a value for a list type- Specified by:
getStringValue
in interfaceCSSPrimitiveValue
- Returns:
- The string value in the current unit. The current
primitiveType
can only be a string unit type (i.e.CSS_STRING
,CSS_URI
,CSS_IDENT
andCSS_ATTR
). - Throws:
org.w3c.dom.DOMException
- INVALID_ACCESS_ERR: Raised if the CSS value doesn't contain a string value.
-
getCounterValue
public Counter getCounterValue() throws org.w3c.dom.DOMException
Description copied from interface:CSSPrimitiveValue
This method is used to get the Counter value. If this CSS value doesn't contain a counter value, aDOMException
is raised. Modification to the corresponding style property can be achieved using theCounter
interface.- Specified by:
getCounterValue
in interfaceCSSPrimitiveValue
- Returns:
- The Counter value.
- Throws:
org.w3c.dom.DOMException
- INVALID_ACCESS_ERR: Raised if the CSS value doesn't contain a Counter value (e.g. this is notCSS_COUNTER
).
-
getRectValue
public Rect getRectValue() throws org.w3c.dom.DOMException
Description copied from interface:CSSPrimitiveValue
This method is used to get the Rect value. If this CSS value doesn't contain a rect value, aDOMException
is raised. Modification to the corresponding style property can be achieved using theRect
interface.- Specified by:
getRectValue
in interfaceCSSPrimitiveValue
- Returns:
- The Rect value.
- Throws:
org.w3c.dom.DOMException
- INVALID_ACCESS_ERR: Raised if the CSS value doesn't contain a Rect value. (e.g. this is notCSS_RECT
).
-
getRGBColorValue
public RGBColor getRGBColorValue() throws org.w3c.dom.DOMException
Description copied from interface:CSSPrimitiveValue
This method is used to get the RGB color. If this CSS value doesn't contain a RGB color value, aDOMException
is raised. Modification to the corresponding style property can be achieved using theRGBColor
interface.- Specified by:
getRGBColorValue
in interfaceCSSPrimitiveValue
- Returns:
- the RGB color value.
- Throws:
org.w3c.dom.DOMException
- INVALID_ACCESS_ERR: Raised if the attached property can't return a RGB color value (e.g. this is notCSS_RGBCOLOR
).
-
getLength
public int getLength()
Description copied from interface:CSSValueList
The number ofCSSValues
in the list. The range of valid values of the indices is0
tolength-1
inclusive.- Specified by:
getLength
in interfaceCSSValueList
-
item
public CSSValue item(int index)
Description copied from interface:CSSValueList
Used to retrieve aCSSValue
by ordinal index. The order in this collection represents the order of the values in the CSS style property. If index is greater than or equal to the number of values in the list, this returnsnull
.- Specified by:
item
in interfaceCSSValueList
- Returns:
- The
CSSValue
at theindex
position in theCSSValueList
, ornull
if that is not a valid index.
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-