public Interface CSSPrimitiveValue

The value is a attribute function. The value can be obtained by using the getStringValue method.

The value is a length (cm). The value can be obtained by using the getFloatValue method.

The value is a counter or counters function. The value can be obtained by using the getCounterValue method.

The value is an angle (deg). The value can be obtained by using the getFloatValue method.

The value is a number with an unknown dimension. The value can be obtained by using the getFloatValue method.

The value is a length (ems). The value can be obtained by using the getFloatValue method.

The value is a length (exs). The value can be obtained by using the getFloatValue method.

The value is an angle (grad). The value can be obtained by using the getFloatValue method.

The value is a frequency (Hz). The value can be obtained by using the getFloatValue method.

The value is an identifier. The value can be obtained by using the getStringValue method.

The value is a length (in). The value can be obtained by using the getFloatValue method.

The value is a frequency (kHz). The value can be obtained by using the getFloatValue method.

The value is a length (mm). The value can be obtained by using the getFloatValue method.

The value is a time (ms). The value can be obtained by using the getFloatValue method.

The value is a simple number. The value can be obtained by using the getFloatValue method.

The value is a length (pc). The value can be obtained by using the getFloatValue method.

The value is a percentage. The value can be obtained by using the getFloatValue method.

The value is a length (pt). The value can be obtained by using the getFloatValue method.

The value is a length (px). The value can be obtained by using the getFloatValue method.

The value is an angle (rad). The value can be obtained by using the getFloatValue method.

The value is a rect function. The value can be obtained by using the getRectValue method.

The value is a RGB color. The value can be obtained by using the getRGBColorValue method.

The value is a time (s). The value can be obtained by using the getFloatValue method.

The value is a STRING. The value can be obtained by using the getStringValue method.

The value is not a recognized CSS2 value. The value can only be obtained by using the cssText attribute.

The value is a URI. The value can be obtained by using the getStringValue method.

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.

Returns:Counter

The Counter value.

Exceptions

DOMException:

INVALID_ACCESS_ERR: Raised if the CSS value doesn't contain a Counter value (e.g. this is not CSS_COUNTER).

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.

Parameters

unitType:short

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:float

The float value in the specified unit.

Exceptions

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.

The type of the value as defined by the constants specified above.

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.

Returns:Rect

The Rect value.

Exceptions

DOMException:

INVALID_ACCESS_ERR: Raised if the CSS value doesn't contain a Rect value. (e.g. this is not CSS_RECT).

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.

Returns:RGBColor

the RGB color value.

Exceptions

DOMException:

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

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.

Returns:String

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

Exceptions

DOMException:

INVALID_ACCESS_ERR: Raised if the CSS value doesn't contain a string value.

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.

Parameters

unitType:short

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:float

The new float value.

Exceptions

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.

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.

Parameters

stringType:short

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:String

The new string value.

Exceptions

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.