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 org.vectomatic.dom.svg.impl.SVGFEImageElement;
33  import org.vectomatic.dom.svg.itf.ISVGExternalResourcesRequired;
34  import org.vectomatic.dom.svg.itf.ISVGFilterPrimitiveStandardAttributes;
35  import org.vectomatic.dom.svg.itf.ISVGLangSpace;
36  import org.vectomatic.dom.svg.itf.ISVGURIReference;
37  import org.vectomatic.dom.svg.utils.DOMHelper;
38  import org.vectomatic.dom.svg.utils.SVGConstants;
39  
40  import com.google.gwt.core.client.JavaScriptException;
41  import com.google.gwt.dom.client.TagName;
42  
43  /**
44   * The {@link org.vectomatic.dom.svg.OMSVGFEImageElement} interface corresponds
45   * to the <a href='http://www.w3.org/TR/SVG11/filters.html#feImageElement'
46   * title='feImage element specification'>feImage</a> element.
47   */
48  @TagName("feImage")
49  public class OMSVGFEImageElement extends OMSVGElement implements ISVGURIReference, ISVGLangSpace, ISVGExternalResourcesRequired, ISVGFilterPrimitiveStandardAttributes {
50    public OMSVGFEImageElement() {
51      this((SVGFEImageElement)DOMHelper.createElementNS(DOMHelper.getCurrentDocument(), SVGConstants.SVG_NAMESPACE_URI, SVGConstants.SVG_FE_IMAGE_TAG).cast());
52    }
53  
54    protected OMSVGFEImageElement(SVGFEImageElement ot) {
55      super(ot);
56    }
57  
58    // Implementation of the svg::SVGFEImageElement W3C IDL interface
59    /**
60     * Corresponds to attribute {@link org.vectomatic.dom.svg.OMSVGFEImageElement#getPreserveAspectRatio()}
61     * on the given <a href='http://www.w3.org/TR/SVG11/filters.html#feImageElement'
62     * title='feImage element specification'>feImage</a> element.
63     */
64    public final OMSVGAnimatedPreserveAspectRatio getPreserveAspectRatio() {
65      return ((SVGFEImageElement)ot).getPreserveAspectRatio();
66    }
67  
68    // Implementation of the svg::SVGExternalResourcesRequired W3C IDL interface
69    /**
70     * Corresponds to attribute {@link org.vectomatic.dom.svg.itf.ISVGExternalResourcesRequired#getExternalResourcesRequired()}
71     * on the given element. Note that the SVG DOM defines the attribute {@link
72     * org.vectomatic.dom.svg.itf.ISVGExternalResourcesRequired#getExternalResourcesRequired()}
73     * as being of type {@link org.vectomatic.dom.svg.OMSVGAnimatedBoolean}, whereas
74     * the SVG language definition says that {@link org.vectomatic.dom.svg.itf.ISVGExternalResourcesRequired#getExternalResourcesRequired()}
75     * is not animated. Because the SVG language definition states that {@link
76     * org.vectomatic.dom.svg.itf.ISVGExternalResourcesRequired#getExternalResourcesRequired()}
77     * cannot be animated, the {@link org.vectomatic.dom.svg.OMSVGAnimatedBoolean#getAnimVal()}
78     * will always be the same as the {@link org.vectomatic.dom.svg.OMSVGAnimatedBoolean#getBaseVal()}.
79     */
80    public final OMSVGAnimatedBoolean getExternalResourcesRequired() {
81      return ((SVGFEImageElement)ot).getExternalResourcesRequired();
82    }
83  
84    // Implementation of the svg::SVGFilterPrimitiveStandardAttributes W3C IDL interface
85    /**
86     * Corresponds to attribute {@link org.vectomatic.dom.svg.itf.ISVGFilterPrimitiveStandardAttributes#getX()}
87     * on the given element.
88     */
89    public final OMSVGAnimatedLength getX() {
90      return ((SVGFEImageElement)ot).getX();
91    }
92    /**
93     * Corresponds to attribute {@link org.vectomatic.dom.svg.itf.ISVGFilterPrimitiveStandardAttributes#getY()}
94     * on the given element.
95     */
96    public final OMSVGAnimatedLength getY() {
97      return ((SVGFEImageElement)ot).getY();
98    }
99    /**
100    * Corresponds to attribute {@link org.vectomatic.dom.svg.itf.ISVGFilterPrimitiveStandardAttributes#getWidth()}
101    * on the given element.
102    */
103   public final OMSVGAnimatedLength getWidth() {
104     return ((SVGFEImageElement)ot).getWidth();
105   }
106   /**
107    * Corresponds to attribute {@link org.vectomatic.dom.svg.itf.ISVGFilterPrimitiveStandardAttributes#getHeight()}
108    * on the given element.
109    */
110   public final OMSVGAnimatedLength getHeight() {
111     return ((SVGFEImageElement)ot).getHeight();
112   }
113   /**
114    * Corresponds to attribute {@link org.vectomatic.dom.svg.itf.ISVGFilterPrimitiveStandardAttributes#getResult()}
115    * on the given element.
116    */
117   public final OMSVGAnimatedString getResult() {
118     return ((SVGFEImageElement)ot).getResult();
119   }
120 
121   // Implementation of the svg::SVGLangSpace W3C IDL interface
122   /**
123    * Corresponds to attribute <code>xml:lang</code> on the given element.
124    */
125   public final String getXmllang() {
126     return ((SVGFEImageElement)ot).getXmllang();
127   }
128   /**
129    * Corresponds to attribute <code>xml:lang</code> on the given element.
130    * @throws DOMException(NO_MODIFICATION_ALLOWED_ERR) Raised on an   attempt
131    * to change the value of a <a href="svgdom.html#ReadOnlyNodes">read only
132    * attribute</a>.
133    */
134   public final void setXmllang(java.lang.String value) throws JavaScriptException {
135     ((SVGFEImageElement)ot).setXmllang(value);
136   }
137   /**
138    * Corresponds to attribute <code>xml:space</code> on the given element.
139    */
140   public final String getXmlspace() {
141     return ((SVGFEImageElement)ot).getXmlspace();
142   }
143   /**
144    * Corresponds to attribute <code>xml:space</code> on the given element.
145    * @throws DOMException(NO_MODIFICATION_ALLOWED_ERR) Raised on an   attempt
146    * to change the value of a <a href="svgdom.html#ReadOnlyNodes">read only
147    * attribute</a>.
148    */
149   public final void setXmlspace(java.lang.String value) throws JavaScriptException {
150     ((SVGFEImageElement)ot).setXmlspace(value);
151   }
152 
153   // Implementation of the svg::SVGURIReference W3C IDL interface
154   /**
155    * Corresponds to attribute <span class='attr-name'>'xlink:href'</span> on
156    * the given element.
157    */
158   public final OMSVGAnimatedString getHref() {
159     return ((SVGFEImageElement)ot).getHref();
160   }
161 
162 }