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.itf;
31  
32  import org.vectomatic.dom.svg.OMSVGPointList;
33  
34    /**
35     * <p>The {@link org.vectomatic.dom.svg.itf.ISVGAnimatedPoints} interface
36     * supports elements which have a <span class='attr-name'>'points'</span>
37     * attribute which holds a list of coordinate values and which support the
38     * ability to animate that attribute.</p> <p>Additionally, the <span class='attr-name'>'points'</span>
39     * attribute on the original element accessed via the XML DOM (e.g., using
40     * the <code>getAttribute()</code> method call) will reflect any changes made
41     * to {@link org.vectomatic.dom.svg.itf.ISVGAnimatedPoints#getPoints()}.</p>
42     */
43  public interface ISVGAnimatedPoints {
44    /**
45     * Provides access to the base (i.e., static) contents of the <span class='attr-name'>'points'</span>
46     * attribute.
47     */
48    public OMSVGPointList getPoints();
49    /**
50     * Provides access to the current animated contents of the <span class='attr-name'>'points'</span>
51     * attribute. If the given attribute or property is being animated, contains
52     * the current animated value of the attribute or property. If the given attribute
53     * or property is not currently being animated, contains the same value as
54     * {@link org.vectomatic.dom.svg.itf.ISVGAnimatedPoints#getPoints()}.
55     */
56    public OMSVGPointList getAnimatedPoints();
57  }