org.w3c.dom.css
Interface CSS2Azimuth

All Superinterfaces:
CSSValue

public interface CSS2Azimuth
extends CSSValue

The CSS2Azimuth interface represents the azimuth CSS Level 2 property.

For this extension of the CSSValue interface, the valueType attribute of the underlying CSSValue interface shall be CSS_CUSTOM .

See also the Document Object Model (DOM) Level 2 Specification.

Since:
DOM Level 2

Fields inherited from interface org.w3c.dom.css.CSSValue
CSS_CUSTOM, CSS_INHERIT, CSS_PRIMITIVE_VALUE, CSS_VALUE_LIST
 
Method Summary
 float getAngleValue(short uType)
          Used to retrieved the float value of the azimuth property.
 short getAzimuthType()
          A code defining the type of the value as defined in CSSValue .
 boolean getBehind()
          behind indicates whether the behind identifier has been set.
 java.lang.String getIdentifier()
          If azimuthType is CSS_IDENT , identifier contains one of left-side, far-left, left, center-left, center, center-right, right, far-right, right-side, leftwards, rightwards.
 void setAngleValue(short uType, float fValue)
          A method to set the angle value with a specified unit.
 void setIdentifier(java.lang.String ident, boolean b)
          Setting the identifier for the azimuth property will unset any previously set angle value.
 
Methods inherited from interface org.w3c.dom.css.CSSValue
getCssText, getCssValueType, setCssText
 

Method Detail

getAzimuthType

public short getAzimuthType()
A code defining the type of the value as defined in CSSValue . It would be one of CSS_DEG , CSS_RAD , CSS_GRAD or CSS_IDENT .

getIdentifier

public java.lang.String getIdentifier()
If azimuthType is CSS_IDENT , identifier contains one of left-side, far-left, left, center-left, center, center-right, right, far-right, right-side, leftwards, rightwards. The empty string if none is set.

getBehind

public boolean getBehind()
behind indicates whether the behind identifier has been set.

setAngleValue

public void setAngleValue(short uType,
                          float fValue)
                   throws DOMException
A method to set the angle value with a specified unit. This method will unset any previously set identifier value.
Parameters:
uType - The unitType could only be one of CSS_DEG , CSS_RAD or CSS_GRAD ).
fValue - The new float value of the angle.
Throws:
DOMException - INVALID_ACCESS_ERR: Raised if the unit type is invalid.
NO_MODIFICATION_ALLOWED_ERR: Raised if this property is readonly.

getAngleValue

public float getAngleValue(short uType)
                    throws DOMException
Used to retrieved the float value of the azimuth property.
Parameters:
uType - The unit type can be only an angle unit type ( CSS_DEG , CSS_RAD or CSS_GRAD ).
Returns:
The float value.
Throws:
DOMException - INVALID_ACCESS_ERR: Raised if the unit type is invalid.

setIdentifier

public void setIdentifier(java.lang.String ident,
                          boolean b)
                   throws DOMException
Setting the identifier for the azimuth property will unset any previously set angle value. The value of azimuthType is set to CSS_IDENT
Parameters:
ident - The new identifier. If the identifier is "leftwards" or "rightward", the behind attribute is ignored.
b - The new value for behind.
Throws:
DOMException - SYNTAX_ERR: Raised if the specified identifier has a syntax error and is unparsable.
NO_MODIFICATION_ALLOWED_ERR: Raised if this property is readonly.

Source code is GPL'd at http://xmlconf.sourceforge.net.