View Javadoc

1   /**********************************************
2    * Copyright (C) 2010 Lukas Laag
3    * This file is part of lib-gwt-svg.
4    * 
5    * libgwtsvg is free software: you can redistribute it and/or modify
6    * it under the terms of the GNU Lesser General Public License as published by
7    * the Free Software Foundation, either version 3 of the License, or
8    * (at your option) any later version.
9    * 
10   * libgwtsvg is distributed in the hope that it will be useful,
11   * but WITHOUT ANY WARRANTY; without even the implied warranty of
12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13   * GNU Lesser General Public License for more details.
14   * 
15   * You should have received a copy of the GNU Lesser General Public License
16   * along with libgwtsvg.  If not, see http://www.gnu.org/licenses/
17   **********************************************/
18  /*
19   * Copyright (c) 2004 World Wide Web Consortium,
20   *
21   * (Massachusetts Institute of Technology, European Research Consortium for
22   * Informatics and Mathematics, Keio University). All Rights Reserved. This
23   * work is distributed under the W3C(r) Software License [1] in the hope that
24   * it will be useful, but WITHOUT ANY WARRANTY; without even the implied
25   * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
26   *
27   * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
28   */
29  
30  package org.vectomatic.dom.svg;
31  
32  import com.google.gwt.core.client.JavaScriptObject;
33  
34  /**
35   * The {@link org.vectomatic.dom.svg.OMSVGElementInstanceList} interface provides
36   * the abstraction of an ordered collection of {@link org.vectomatic.dom.svg.OMSVGElementInstance}
37   * objects, without defining or constraining how this collection is implemented.
38   */
39  public class OMSVGElementInstanceList extends JavaScriptObject {
40    protected OMSVGElementInstanceList() {
41    }
42  
43    // Implementation of the svg::SVGElementInstanceList W3C IDL interface
44    /**
45     * The number of {@link org.vectomatic.dom.svg.OMSVGElementInstance} objects
46     * in the list. The range of valid child indices is 0 to {@link org.vectomatic.dom.svg.OMSVGElementInstanceList#getLength()}−1
47     * inclusive.
48     */
49    public final native int getLength() /*-{
50      return this.length;
51    }-*/;
52    /**
53     * Returns the <var>index</var>th item in the collection. If <var>index</var>
54     * is greater than or equal to the number of nodes in the list, this returns
55     * null.
56     * @param index Index into the collection.
57     * @return The {@link org.vectomatic.dom.svg.OMSVGElementInstance} object
58     * at the <var>index</var>th   position in the {@link org.vectomatic.dom.svg.OMSVGElementInstanceList},
59     * or null if that is not   a valid index.
60     */
61    public final native OMSVGElementInstance item(int index) /*-{
62      return this.item(index);
63    }-*/;
64  
65  }