lib/classpath/external/w3c_dom/org/w3c/dom/css/CSSValueList.java

   1 /*
   2  * Copyright (c) 2000 World Wide Web Consortium,
   3  * (Massachusetts Institute of Technology, Institut National de
   4  * Recherche en Informatique et en Automatique, Keio University). All
   5  * Rights Reserved. This program is distributed under the W3C's Software
   6  * Intellectual Property License. This program is distributed in the
   7  * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
   8  * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
   9  * PURPOSE.
  10  * See W3C License http://www.w3.org/Consortium/Legal/ for more details.
  11  */
  12
  13 package org.w3c.dom.css;
  14
  15 /**
  16  * The <code>CSSValueList</code> interface provides the abstraction of an
  17  * ordered collection of CSS values.
  18  * <p> Some properties allow an empty list into their syntax. In that case,
  19  * these properties take the <code>none</code> identifier. So, an empty list
  20  * means that the property has the value <code>none</code>.
  21  * <p> The items in the <code>CSSValueList</code> are accessible via an
  22  * integral index, starting from 0.
  23  * <p>See also the <a href='http://www.w3.org/TR/2000/REC-DOM-Level-2-Style-20001113'>Document Object Model (DOM) Level 2 Style Specification</a>.
  24  * @since DOM Level 2
  25  */
  26 public interface CSSValueList extends CSSValue {
  27     /**
  28      * The number of <code>CSSValues</code> in the list. The range of valid
  29      * values of the indices is <code>0</code> to <code>length-1</code>
  30      * inclusive.
  31      */
  32     public int getLength();
  33
  34     /**
  35      * Used to retrieve a <code>CSSValue</code> by ordinal index. The order in
  36      * this collection represents the order of the values in the CSS style
  37      * property. If index is greater than or equal to the number of values
  38      * in the list, this returns <code>null</code>.
  39      * @param index Index into the collection.
  40      * @return The <code>CSSValue</code> at the <code>index</code> position
  41      *   in the <code>CSSValueList</code>, or <code>null</code> if that is
  42      *   not a valid index.
  43      */
  44     public CSSValue item(int index);
  45
  46 }