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 com.google.gwt.core.client.JavaScriptException;
33  
34    /**
35     * The {@link org.vectomatic.dom.svg.itf.ISVGZoomAndPan} interface defines
36     * attribute {@link org.vectomatic.dom.svg.itf.ISVGZoomAndPan#getZoomAndPan()}
37     * and associated constants.
38     */
39  public interface ISVGZoomAndPan {
40    /**
41     * The enumeration was set to a value that is not one of predefined types.
42     * It is invalid to attempt to define a new value of this type or to attempt
43     * to switch an existing value to this type.
44     */
45    public static final short SVG_ZOOMANDPAN_UNKNOWN = 0;
46    /**
47     * Corresponds to value <span class='attr-value'>'disable'</span>.
48     */
49    public static final short SVG_ZOOMANDPAN_DISABLE = 1;
50    /**
51     * Corresponds to value <span class='attr-value'>'magnify'</span>.
52     */
53    public static final short SVG_ZOOMANDPAN_MAGNIFY = 2;
54    /**
55     * Corresponds to attribute {@link org.vectomatic.dom.svg.itf.ISVGZoomAndPan#getZoomAndPan()}
56     * on the given element. The value must be one of the SVG_ZOOMANDPAN_ constants
57     * defined on this interface.
58     */
59    public short getZoomAndPan();
60    /**
61     * Corresponds to attribute {@link org.vectomatic.dom.svg.itf.ISVGZoomAndPan#getZoomAndPan()}
62     * on the given element. The value must be one of the SVG_ZOOMANDPAN_ constants
63     * defined on this interface.
64     * @throws DOMException(NO_MODIFICATION_ALLOWED_ERR) Raised on an   attempt
65     * to change the value of a <a href="svgdom.html#ReadOnlyNodes">read only
66     * attribute</a>.
67     */
68    public void setZoomAndPan(short value) throws JavaScriptException;
69  }