File Doc Category Size Date Package
CSSPrimitiveValue.java API Doc Java SE 5 API 13236 Fri Aug 26 14:58:38 BST 2005 org.w3c.dom.css

CSSPrimitiveValue

public interface CSSPrimitiveValue implements CSSValue

The CSSPrimitiveValue interface represents a single CSS value . This interface may be used to determine the value of a specific style property currently set in a block or to set a specific style property explicitly within the block. An instance of this interface might be obtained from the getPropertyCSSValue method of the CSSStyleDeclaration interface. A CSSPrimitiveValue object only occurs in a context of a CSS property.

Conversions are allowed between absolute values (from millimeters to centimeters, from degrees to radians, and so on) but not between relative values. (For example, a pixel value cannot be converted to a centimeter value.) Percentage values can't be converted since they are relative to the parent value (or another property value). There is one exception for color percentage values: since a color percentage value is relative to the range 0-255, a color percentage value can be converted to a number; (see also the RGBColor interface).

since: DOM Level 2

Fields Summary
public static final short
CSS_UNKNOWN
The value is not a recognized CSS2 value. The value can only be obtained by using the cssText attribute.
public static final short
CSS_NUMBER
The value is a simple number. The value can be obtained by using the getFloatValue method.
public static final short
CSS_PERCENTAGE
The value is a percentage. The value can be obtained by using the getFloatValue method.
public static final short
CSS_EMS
The value is a length (ems). The value can be obtained by using the getFloatValue method.
public static final short
CSS_EXS
The value is a length (exs). The value can be obtained by using the getFloatValue method.
public static final short
CSS_PX
The value is a length (px). The value can be obtained by using the getFloatValue method.
public static final short
CSS_CM
The value is a length (cm). The value can be obtained by using the getFloatValue method.
public static final short
CSS_MM
The value is a length (mm). The value can be obtained by using the getFloatValue method.
public static final short
CSS_IN
The value is a length (in). The value can be obtained by using the getFloatValue method.
public static final short
CSS_PT
The value is a length (pt). The value can be obtained by using the getFloatValue method.
public static final short
CSS_PC
The value is a length (pc). The value can be obtained by using the getFloatValue method.
public static final short
CSS_DEG
The value is an angle (deg). The value can be obtained by using the getFloatValue method.
public static final short
CSS_RAD
The value is an angle (rad). The value can be obtained by using the getFloatValue method.
public static final short
CSS_GRAD
The value is an angle (grad). The value can be obtained by using the getFloatValue method.
public static final short
CSS_MS
The value is a time (ms). The value can be obtained by using the getFloatValue method.
public static final short
CSS_S
The value is a time (s). The value can be obtained by using the getFloatValue method.
public static final short
CSS_HZ
The value is a frequency (Hz). The value can be obtained by using the getFloatValue method.
public static final short
CSS_KHZ
The value is a frequency (kHz). The value can be obtained by using the getFloatValue method.
public static final short
CSS_DIMENSION
The value is a number with an unknown dimension. The value can be obtained by using the getFloatValue method.
public static final short
CSS_STRING
The value is a STRING. The value can be obtained by using the getStringValue method.
public static final short
CSS_URI
The value is a URI. The value can be obtained by using the getStringValue method.
public static final short
CSS_IDENT
The value is an identifier. The value can be obtained by using the getStringValue method.
public static final short
CSS_ATTR
The value is a attribute function. The value can be obtained by using the getStringValue method.
public static final short
CSS_COUNTER
The value is a counter or counters function. The value can be obtained by using the getCounterValue method.
public static final short
CSS_RECT
The value is a rect function. The value can be obtained by using the getRectValue method.
public static final short
CSS_RGBCOLOR
The value is a RGB color. The value can be obtained by using the getRGBColorValue method.
Constructors Summary
Methods Summary
public org.w3c.dom.css.Counter getCounterValue()
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.
return
The Counter value.
exception
DOMException INVALID_ACCESS_ERR: Raised if the CSS value doesn't contain a Counter value (e.g. this is not CSS_COUNTER).
public float getFloatValue(short unitType)
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.
param
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).
return
The float value in the specified unit.
exception
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.
public short getPrimitiveType()
The type of the value as defined by the constants specified above.
public org.w3c.dom.css.RGBColor getRGBColorValue()
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.
return
the RGB color value.
exception
DOMException INVALID_ACCESS_ERR: Raised if the attached property can't return a RGB color value (e.g. this is not CSS_RGBCOLOR).
public org.w3c.dom.css.Rect getRectValue()
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.
return
The Rect value.
exception
DOMException INVALID_ACCESS_ERR: Raised if the CSS value doesn't contain a Rect value. (e.g. this is not CSS_RECT).
public java.lang.String getStringValue()
This method is used to get the string value. If the CSS value doesn't contain a string value, a DOMException is raised. Some properties (like 'font-family' or 'voice-family') convert a whitespace separated list of idents to a string.
return
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 and CSS_ATTR).
exception
DOMException INVALID_ACCESS_ERR: Raised if the CSS value doesn't contain a string value.
public void setFloatValue(short unitType, float floatValue)
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.
param
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).
param
floatValue The new float value.
exception
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.
public void setStringValue(short stringType, java.lang.String stringValue)
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.
param
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).
param
stringValue The new string value.
exception
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.