| org.w3c.dom.css.CSSPrimitiveValue
| CSSPrimitiveValue | | public interface CSSPrimitiveValue extends CSSValue(Code) | | 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).
See also the Document Object Model (DOM) Level 2 Style Specification.
since:
DOM Level 2 |
| Field Summary | |
| final public static short | CSS_ATTR
The value is a attribute function. | | final public static short | CSS_CM
The value is a length (cm). | | final public static short | CSS_COUNTER
The value is a counter or counters function. | | final public static short | CSS_DEG
The value is an angle (deg). | | final public static short | CSS_DIMENSION
The value is a number with an unknown dimension. | | final public static short | CSS_EMS
The value is a length (ems). | | final public static short | CSS_EXS
The value is a length (exs). | | final public static short | CSS_GRAD
The value is an angle (grad). | | final public static short | CSS_HZ
The value is a frequency (Hz). | | final public static short | CSS_IDENT
The value is an identifier. | | final public static short | CSS_IN
The value is a length (in). | | final public static short | CSS_KHZ
The value is a frequency (kHz). | | final public static short | CSS_MM
The value is a length (mm). | | final public static short | CSS_MS
The value is a time (ms). | | final public static short | CSS_NUMBER
The value is a simple number. | | final public static short | CSS_PC
The value is a length (pc). | | final public static short | CSS_PERCENTAGE
The value is a percentage. | | final public static short | CSS_PT
The value is a length (pt). | | final public static short | CSS_PX
The value is a length (px). | | final public static short | CSS_RAD
The value is an angle (rad). | | final public static short | CSS_RECT
The value is a rect function. | | final public static short | CSS_RGBCOLOR
The value is a RGB color. | | final public static short | CSS_S
The value is a time (s). | | final public static short | CSS_STRING
The value is a STRING. | | final public static short | CSS_UNKNOWN
The value is not a recognized CSS2 value. | | final public static short | CSS_URI
The value is a URI. |
| Method Summary | |
| public Counter | getCounterValue()
This method is used to get the Counter value. | | public float | getFloatValue(short unitType)
This method is used to get a float value in a specified unit. | | public short | getPrimitiveType()
The type of the value as defined by the constants specified above. | | public RGBColor | getRGBColorValue()
This method is used to get the RGB color. | | public Rect | getRectValue()
This method is used to get the Rect value. | | public String | getStringValue()
This method is used to get the string value. | | public void | setFloatValue(short unitType, float floatValue)
A method to set the float value with a specified unit. | | public void | setStringValue(short stringType, String stringValue)
A method to set the string value with the specified unit. |
| CSS_ATTR | | final public static short CSS_ATTR(Code) | | The value is a attribute function. The value can be obtained by using
the getStringValue method.
|
| CSS_CM | | final public static short CSS_CM(Code) | | The value is a length (cm). The value can be obtained by using the
getFloatValue method.
|
| CSS_COUNTER | | final public static short CSS_COUNTER(Code) | | The value is a counter or counters function. The value can be obtained
by using the getCounterValue method.
|
| CSS_DEG | | final public static short CSS_DEG(Code) | | The value is an angle (deg). The value can be obtained by using the
getFloatValue method.
|
| CSS_DIMENSION | | final public static short CSS_DIMENSION(Code) | | The value is a number with an unknown dimension. The value can be
obtained by using the getFloatValue method.
|
| CSS_EMS | | final public static short CSS_EMS(Code) | | The value is a length (ems). The value can be obtained by using the
getFloatValue method.
|
| CSS_EXS | | final public static short CSS_EXS(Code) | | The value is a length (exs). The value can be obtained by using the
getFloatValue method.
|
| CSS_GRAD | | final public static short CSS_GRAD(Code) | | The value is an angle (grad). The value can be obtained by using the
getFloatValue method.
|
| CSS_HZ | | final public static short CSS_HZ(Code) | | The value is a frequency (Hz). The value can be obtained by using the
getFloatValue method.
|
| CSS_IDENT | | final public static short CSS_IDENT(Code) | | The value is an identifier. The value can be obtained by using the
getStringValue method.
|
| CSS_IN | | final public static short CSS_IN(Code) | | The value is a length (in). The value can be obtained by using the
getFloatValue method.
|
| CSS_KHZ | | final public static short CSS_KHZ(Code) | | The value is a frequency (kHz). The value can be obtained by using the
getFloatValue method.
|
| CSS_MM | | final public static short CSS_MM(Code) | | The value is a length (mm). The value can be obtained by using the
getFloatValue method.
|
| CSS_MS | | final public static short CSS_MS(Code) | | The value is a time (ms). The value can be obtained by using the
getFloatValue method.
|
| CSS_NUMBER | | final public static short CSS_NUMBER(Code) | | The value is a simple number. The value can be obtained by using the
getFloatValue method.
|
| CSS_PC | | final public static short CSS_PC(Code) | | The value is a length (pc). The value can be obtained by using the
getFloatValue method.
|
| CSS_PERCENTAGE | | final public static short CSS_PERCENTAGE(Code) | | The value is a percentage. The value can be obtained by using the
getFloatValue method.
|
| CSS_PT | | final public static short CSS_PT(Code) | | The value is a length (pt). The value can be obtained by using the
getFloatValue method.
|
| CSS_PX | | final public static short CSS_PX(Code) | | The value is a length (px). The value can be obtained by using the
getFloatValue method.
|
| CSS_RAD | | final public static short CSS_RAD(Code) | | The value is an angle (rad). The value can be obtained by using the
getFloatValue method.
|
| CSS_RECT | | final public static short CSS_RECT(Code) | | The value is a rect function. The value can be obtained by using the
getRectValue method.
|
| CSS_RGBCOLOR | | final public static short CSS_RGBCOLOR(Code) | | The value is a RGB color. The value can be obtained by using the
getRGBColorValue method.
|
| CSS_S | | final public static short CSS_S(Code) | | The value is a time (s). The value can be obtained by using the
getFloatValue method.
|
| CSS_STRING | | final public static short CSS_STRING(Code) | | The value is a STRING. The value can be obtained by using the
getStringValue method.
|
| CSS_UNKNOWN | | final public static short CSS_UNKNOWN(Code) | | The value is not a recognized CSS2 value. The value can only be
obtained by using the cssText attribute.
|
| CSS_URI | | final public static short CSS_URI(Code) | | The value is a URI. The value can be obtained by using the
getStringValue method.
|
| getCounterValue | | public Counter getCounterValue() throws DOMException(Code) | | 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.
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). |
| getFloatValue | | public float getFloatValue(short unitType) throws DOMException(Code) | | 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 - 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). 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. |
| getPrimitiveType | | public short getPrimitiveType()(Code) | | The type of the value as defined by the constants specified above.
|
| getRGBColorValue | | public RGBColor getRGBColorValue() throws DOMException(Code) | | 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.
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). |
| getRectValue | | public Rect getRectValue() throws DOMException(Code) | | 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.
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). |
| getStringValue | | public String getStringValue() throws DOMException(Code) | | 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.
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. |
| setFloatValue | | public void setFloatValue(short unitType, float floatValue) throws DOMException(Code) | | 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 - 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).
Parameters:
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. |
| setStringValue | | public void setStringValue(short stringType, String stringValue) throws DOMException(Code) | | 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 - 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).
Parameters:
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. |
|
|