01: /*
02: * Copyright (c) 2000 World Wide Web Consortium,
03: * (Massachusetts Institute of Technology, Institut National de
04: * Recherche en Informatique et en Automatique, Keio University). All
05: * Rights Reserved. This program is distributed under the W3C's Software
06: * Intellectual Property License. This program is distributed in the
07: * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
08: * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
09: * PURPOSE. See W3C License http://www.w3.org/Consortium/Legal/ for more
10: * details.
11: */
12:
13: package org.w3c.dom.css;
14:
15: import org.w3c.dom.DOMException;
16:
17: /**
18: * The <code>CSS2Azimuth</code> interface represents the azimuth CSS Level 2
19: * property.
20: * <p> For this extension of the <code>CSSValue</code> interface, the
21: * <code>valueType</code> attribute of the underlying <code>CSSValue</code>
22: * interface shall be <code>CSS_CUSTOM</code> .
23: * <p>See also the <a href='http://www.w3.org/TR/2000/CR-DOM-Level-2-20000510'>Document Object Model (DOM) Level 2 Specification</a>.
24: * @since DOM Level 2
25: */
26: public interface CSS2Azimuth extends CSSValue {
27: /**
28: * A code defining the type of the value as defined in
29: * <code>CSSValue</code> . It would be one of <code>CSS_DEG</code> ,
30: * <code>CSS_RAD</code> , <code>CSS_GRAD</code> or <code>CSS_IDENT</code>
31: * .
32: */
33: public short getAzimuthType();
34:
35: /**
36: * If <code>azimuthType</code> is <code>CSS_IDENT</code> ,
37: * <code>identifier</code> contains one of left-side, far-left, left,
38: * center-left, center, center-right, right, far-right, right-side,
39: * leftwards, rightwards. The empty string if none is set.
40: */
41: public String getIdentifier();
42:
43: /**
44: * <code>behind</code> indicates whether the behind identifier has been
45: * set.
46: */
47: public boolean getBehind();
48:
49: /**
50: * A method to set the angle value with a specified unit. This method
51: * will unset any previously set identifier value.
52: * @param uType The unitType could only be one of <code>CSS_DEG</code> ,
53: * <code>CSS_RAD</code> or <code>CSS_GRAD</code> ).
54: * @param fValue The new float value of the angle.
55: * @exception DOMException
56: * INVALID_ACCESS_ERR: Raised if the unit type is invalid.
57: * <br> NO_MODIFICATION_ALLOWED_ERR: Raised if this property is
58: * readonly.
59: */
60: public void setAngleValue(short uType, float fValue)
61: throws DOMException;
62:
63: /**
64: * Used to retrieved the float value of the azimuth property.
65: * @param uType The unit type can be only an angle unit type (
66: * <code>CSS_DEG</code> , <code>CSS_RAD</code> or <code>CSS_GRAD</code>
67: * ).
68: * @return The float value.
69: * @exception DOMException
70: * INVALID_ACCESS_ERR: Raised if the unit type is invalid.
71: */
72: public float getAngleValue(short uType) throws DOMException;
73:
74: /**
75: * Setting the identifier for the azimuth property will unset any
76: * previously set angle value. The value of <code>azimuthType</code> is
77: * set to <code>CSS_IDENT</code>
78: * @param ident The new identifier. If the identifier is "leftwards" or
79: * "rightward", the behind attribute is ignored.
80: * @param b The new value for behind.
81: * @exception DOMException
82: * SYNTAX_ERR: Raised if the specified <code>identifier</code> has a
83: * syntax error and is unparsable.
84: * <br> NO_MODIFICATION_ALLOWED_ERR: Raised if this property is
85: * readonly.
86: */
87: public void setIdentifier(String ident, boolean b)
88: throws DOMException;
89:
90: }
|