001: /*
002: * Copyright (c) 2000 World Wide Web Consortium,
003: * (Massachusetts Institute of Technology, Institut National de
004: * Recherche en Informatique et en Automatique, Keio University). All
005: * Rights Reserved. This program is distributed under the W3C's Software
006: * Intellectual Property License. This program is distributed in the
007: * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
008: * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
009: * PURPOSE. See W3C License http://www.w3.org/Consortium/Legal/ for more
010: * details.
011: */
012:
013: package org.w3c.dom.css;
014:
015: import org.w3c.dom.DOMException;
016:
017: /**
018: * The <code>CSS2BorderSpacing</code> interface represents the border-spacing
019: * CSS Level 2 property.
020: * <p> For this extension of the <code>CSSValue</code> interface, the
021: * <code>valueType</code> attribute of the underlying <code>CSSValue</code>
022: * interface shall be <code>CSS_CUSTOM</code> .
023: * <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>.
024: * @since DOM Level 2
025: */
026: public interface CSS2BorderSpacing extends CSSValue {
027: /**
028: * The A code defining the type of the value as defined in
029: * <code>CSSValue</code> . It would be one of <code>CSS_EMS</code> ,
030: * <code>CSS_EXS</code> , <code>CSS_PX</code> , <code>CSS_CM</code> ,
031: * <code>CSS_MM</code> , <code>CSS_IN</code> , <code>CSS_PT</code> or
032: * <code>CSS_PC</code> .
033: */
034: public short getHorizontalType();
035:
036: /**
037: * The A code defining the type of the value as defined in
038: * <code>CSSValue</code> . It would be one of <code>CSS_EMS</code> ,
039: * <code>CSS_EXS</code> , <code>CSS_PX</code> , <code>CSS_CM</code> ,
040: * <code>CSS_MM</code> , <code>CSS_IN</code> , <code>CSS_PT</code> ,
041: * <code>CSS_PC</code> or <code>CSS_INHERIT</code> .
042: */
043: public short getVerticalType();
044:
045: /**
046: * This method is used to get the float value in a specified unit if the
047: * <code>horizontalSpacing</code> represents a length. If the float
048: * doesn't contain a float value or can't be converted into the specified
049: * unit, a <code>DOMException</code> is raised.
050: * @param hType The horizontal unit.
051: * @return The float value.
052: * @exception DOMException
053: * INVALID_ACCESS_ERR: Raised if the property doesn't contain a float
054: * or the value can't be converted.
055: */
056: public float getHorizontalSpacing(float hType) throws DOMException;
057:
058: /**
059: * This method is used to get the float value in a specified unit if the
060: * <code>verticalSpacing</code> represents a length. If the float doesn't
061: * contain a float value or can't be converted into the specified unit, a
062: * <code>DOMException</code> is raised. The value is <code>0</code> if
063: * only the horizontal value has been specified.
064: * @param vType The vertical unit.
065: * @return The float value.
066: * @exception DOMException
067: * INVALID_ACCESS_ERR: Raised if the property doesn't contain a float
068: * or the value can't be converted.
069: */
070: public float getVerticalSpacing(float vType) throws DOMException;
071:
072: /**
073: * This method is used to set the horizontal spacing with a specified
074: * unit. If the vertical value is a length, it sets the vertical spacing
075: * to <code>0</code> .
076: * @param hType The horizontal unit.
077: * @param value The new value.
078: * @exception DOMException
079: * INVALID_ACCESS_ERR: Raised if the specified unit is not a length.
080: * <br> NO_MODIFICATION_ALLOWED_ERR: Raised if this property is
081: * readonly.
082: */
083: public void setHorizontalSpacing(short hType, float value)
084: throws DOMException;
085:
086: /**
087: * This method is used to set the vertical spacing with a specified unit.
088: * If the horizontal value is not a length, it sets the vertical spacing
089: * to <code>0</code> .
090: * @param vType The vertical unit.
091: * @param value The new value.
092: * @exception DOMException
093: * INVALID_ACCESS_ERR: Raised if the specified unit is not a length or
094: * a percentage.
095: * <br> NO_MODIFICATION_ALLOWED_ERR: Raised if this property is
096: * readonly.
097: */
098: public void setVerticalSpacing(short vType, float value)
099: throws DOMException;
100:
101: }
|