View Javadoc

1   /**********************************************
2    * Copyright (C) 2010-2011 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.events.ActivateEvent;
33  import org.vectomatic.dom.svg.events.ActivateHandler;
34  import org.vectomatic.dom.svg.events.FocusInEvent;
35  import org.vectomatic.dom.svg.events.FocusInHandler;
36  import org.vectomatic.dom.svg.events.FocusOutEvent;
37  import org.vectomatic.dom.svg.events.FocusOutHandler;
38  import org.vectomatic.dom.svg.events.HasGraphicalHandlers;
39  import org.vectomatic.dom.svg.impl.SVGElement;
40  import org.vectomatic.dom.svg.impl.SVGPolygonElement;
41  import org.vectomatic.dom.svg.itf.ISVGAnimatedPoints;
42  import org.vectomatic.dom.svg.itf.ISVGExternalResourcesRequired;
43  import org.vectomatic.dom.svg.itf.ISVGGraphicsElement;
44  import org.vectomatic.dom.svg.itf.ISVGLangSpace;
45  import org.vectomatic.dom.svg.itf.ISVGStylable;
46  import org.vectomatic.dom.svg.itf.ISVGTests;
47  import org.vectomatic.dom.svg.itf.ISVGTransformable;
48  import org.vectomatic.dom.svg.utils.DOMHelper;
49  import org.vectomatic.dom.svg.utils.SVGConstants;
50  
51  import com.google.gwt.core.client.JavaScriptException;
52  import com.google.gwt.dom.client.TagName;
53  import com.google.gwt.event.dom.client.ClickEvent;
54  import com.google.gwt.event.dom.client.ClickHandler;
55  import com.google.gwt.event.dom.client.DragEndEvent;
56  import com.google.gwt.event.dom.client.DragEndHandler;
57  import com.google.gwt.event.dom.client.DragEnterEvent;
58  import com.google.gwt.event.dom.client.DragEnterHandler;
59  import com.google.gwt.event.dom.client.DragEvent;
60  import com.google.gwt.event.dom.client.DragHandler;
61  import com.google.gwt.event.dom.client.DragLeaveEvent;
62  import com.google.gwt.event.dom.client.DragLeaveHandler;
63  import com.google.gwt.event.dom.client.DragOverEvent;
64  import com.google.gwt.event.dom.client.DragOverHandler;
65  import com.google.gwt.event.dom.client.DragStartEvent;
66  import com.google.gwt.event.dom.client.DragStartHandler;
67  import com.google.gwt.event.dom.client.DropEvent;
68  import com.google.gwt.event.dom.client.DropHandler;
69  import com.google.gwt.event.dom.client.LoadEvent;
70  import com.google.gwt.event.dom.client.LoadHandler;
71  import com.google.gwt.event.dom.client.MouseDownEvent;
72  import com.google.gwt.event.dom.client.MouseDownHandler;
73  import com.google.gwt.event.dom.client.MouseMoveEvent;
74  import com.google.gwt.event.dom.client.MouseMoveHandler;
75  import com.google.gwt.event.dom.client.MouseOutEvent;
76  import com.google.gwt.event.dom.client.MouseOutHandler;
77  import com.google.gwt.event.dom.client.MouseOverEvent;
78  import com.google.gwt.event.dom.client.MouseOverHandler;
79  import com.google.gwt.event.dom.client.MouseUpEvent;
80  import com.google.gwt.event.dom.client.MouseUpHandler;
81  import com.google.gwt.event.dom.client.TouchCancelEvent;
82  import com.google.gwt.event.dom.client.TouchCancelHandler;
83  import com.google.gwt.event.dom.client.TouchEndEvent;
84  import com.google.gwt.event.dom.client.TouchEndHandler;
85  import com.google.gwt.event.dom.client.TouchMoveEvent;
86  import com.google.gwt.event.dom.client.TouchMoveHandler;
87  import com.google.gwt.event.dom.client.TouchStartEvent;
88  import com.google.gwt.event.dom.client.TouchStartHandler;
89  import com.google.gwt.event.shared.HandlerRegistration;
90  
91  /**
92   * The {@link org.vectomatic.dom.svg.OMSVGPolygonElement} interface corresponds
93   * to the <a href='http://www.w3.org/TR/SVG11/shapes.html#PolygonElement'
94   * title='polygon element specification'>polygon</a> element.
95   */
96  @TagName("polygon")
97  public class OMSVGPolygonElement extends OMSVGElement implements HasGraphicalHandlers, ISVGTests, ISVGLangSpace, ISVGExternalResourcesRequired, ISVGStylable, ISVGTransformable, ISVGAnimatedPoints, ISVGGraphicsElement {
98    public OMSVGPolygonElement() {
99      this((SVGPolygonElement)DOMHelper.createElementNS(DOMHelper.getCurrentDocument(), SVGConstants.SVG_NAMESPACE_URI, SVGConstants.SVG_POLYGON_TAG).cast());
100   }
101 
102   protected OMSVGPolygonElement(SVGPolygonElement ot) {
103     super(ot);
104   }
105 
106   // Implementation of the svg::SVGPolygonElement W3C IDL interface
107 
108   // Implementation of the svg::SVGAnimatedPoints W3C IDL interface
109   /**
110    * Provides access to the base (i.e., static) contents of the <span class='attr-name'>'points'</span>
111    * attribute.
112    */
113   public final OMSVGPointList getPoints() {
114     return ((SVGPolygonElement)ot).getPoints();
115   }
116   /**
117    * Provides access to the current animated contents of the <span class='attr-name'>'points'</span>
118    * attribute. If the given attribute or property is being animated, contains
119    * the current animated value of the attribute or property. If the given attribute
120    * or property is not currently being animated, contains the same value as
121    * {@link org.vectomatic.dom.svg.itf.ISVGAnimatedPoints#getPoints()}.
122    */
123   public final OMSVGPointList getAnimatedPoints() {
124     return ((SVGPolygonElement)ot).getAnimatedPoints();
125   }
126 
127   // Implementation of the svg::SVGExternalResourcesRequired W3C IDL interface
128   /**
129    * Corresponds to attribute {@link org.vectomatic.dom.svg.itf.ISVGExternalResourcesRequired#getExternalResourcesRequired()}
130    * on the given element. Note that the SVG DOM defines the attribute {@link
131    * org.vectomatic.dom.svg.itf.ISVGExternalResourcesRequired#getExternalResourcesRequired()}
132    * as being of type {@link org.vectomatic.dom.svg.OMSVGAnimatedBoolean}, whereas
133    * the SVG language definition says that {@link org.vectomatic.dom.svg.itf.ISVGExternalResourcesRequired#getExternalResourcesRequired()}
134    * is not animated. Because the SVG language definition states that {@link
135    * org.vectomatic.dom.svg.itf.ISVGExternalResourcesRequired#getExternalResourcesRequired()}
136    * cannot be animated, the {@link org.vectomatic.dom.svg.OMSVGAnimatedBoolean#getAnimVal()}
137    * will always be the same as the {@link org.vectomatic.dom.svg.OMSVGAnimatedBoolean#getBaseVal()}.
138    */
139   public final OMSVGAnimatedBoolean getExternalResourcesRequired() {
140     return ((SVGPolygonElement)ot).getExternalResourcesRequired();
141   }
142 
143   // Implementation of the svg::SVGLangSpace W3C IDL interface
144   /**
145    * Corresponds to attribute <code>xml:lang</code> on the given element.
146    */
147   public final String getXmllang() {
148     return ((SVGPolygonElement)ot).getXmllang();
149   }
150   /**
151    * Corresponds to attribute <code>xml:lang</code> on the given element.
152    * @throws DOMException(NO_MODIFICATION_ALLOWED_ERR) Raised on an   attempt
153    * to change the value of a <a href="svgdom.html#ReadOnlyNodes">read only
154    * attribute</a>.
155    */
156   public final void setXmllang(java.lang.String value) throws JavaScriptException {
157     ((SVGPolygonElement)ot).setXmllang(value);
158   }
159   /**
160    * Corresponds to attribute <code>xml:space</code> on the given element.
161    */
162   public final String getXmlspace() {
163     return ((SVGPolygonElement)ot).getXmlspace();
164   }
165   /**
166    * Corresponds to attribute <code>xml:space</code> on the given element.
167    * @throws DOMException(NO_MODIFICATION_ALLOWED_ERR) Raised on an   attempt
168    * to change the value of a <a href="svgdom.html#ReadOnlyNodes">read only
169    * attribute</a>.
170    */
171   public final void setXmlspace(java.lang.String value) throws JavaScriptException {
172     ((SVGPolygonElement)ot).setXmlspace(value);
173   }
174 
175   // Implementation of the svg::SVGLocatable W3C IDL interface
176   /**
177    * The element which established the current viewport. Often, the nearest
178    * ancestor <a href='http://www.w3.org/TR/SVG11/struct.html#SVGElement' title='svg
179    * element specification'>svg</a> element. Null if the current element is
180    * the outermost <a href='http://www.w3.org/TR/SVG11/struct.html#SVGElement'
181    * title='svg element specification'>svg</a> element.
182    */
183   public final OMSVGElement getNearestViewportElement() {
184     SVGElement elt = ((SVGPolygonElement)ot).getNearestViewportElement();
185     return elt != null ? (OMSVGElement)convert(elt) : null;
186   }
187   /**
188    * The farthest ancestor <a href='http://www.w3.org/TR/SVG11/struct.html#SVGElement'
189    * title='svg element specification'>svg</a> element. Null if the current
190    * element is the outermost <a href='http://www.w3.org/TR/SVG11/struct.html#SVGElement'
191    * title='svg element specification'>svg</a> element.
192    */
193   public final OMSVGElement getFarthestViewportElement() {
194     SVGElement elt = ((SVGPolygonElement)ot).getFarthestViewportElement();
195     return elt != null ? (OMSVGElement)convert(elt) : null;
196   }
197   /**
198    * Returns the tight bounding box in current user space (i.e., after application
199    * of the <code>transform</code> attribute, if any) on the geometry of all
200    * contained graphics elements, exclusive of stroking, clipping, masking and
201    * filter effects). Note that getBBox must return the actual bounding box
202    * at the time the method was called, even in case the element has not yet
203    * been rendered.
204    * @return An {@link org.vectomatic.dom.svg.OMSVGRect} object that defines
205    * the bounding box.
206    */
207   public final OMSVGRect getBBox() {
208     return ((SVGPolygonElement)ot).getBBox();
209   }
210   /**
211    * Returns the transformation matrix from current user units (i.e., after
212    * application of the <code>transform</code> attribute, if any) to the viewport
213    * coordinate system for the {@link org.vectomatic.dom.svg.itf.ISVGLocatable#getNearestViewportElement()}.
214    * @return An {@link org.vectomatic.dom.svg.OMSVGMatrix} object that defines
215    * the CTM.
216    */
217   public final OMSVGMatrix getCTM() {
218     return ((SVGPolygonElement)ot).getCTM();
219   }
220   /**
221    * Returns the transformation matrix from current user units (i.e., after
222    * application of the <code>transform</code> attribute, if any) to the parent
223    * user agent's notice of a "pixel". For display devices, ideally this represents
224    * a physical screen pixel. For other devices or environments where physical
225    * pixel sizes are not known, then an algorithm similar to the CSS2 definition
226    * of a "pixel" can be used instead.  Note that null is returned if this element
227    * is not hooked into the document tree. This method would have been more
228    * aptly named as <code>getClientCTM</code>, but the name <code>getScreenCTM</code>
229    * is kept for historical reasons.
230    * @return An {@link org.vectomatic.dom.svg.OMSVGMatrix} object that defines
231    * the given   transformation matrix.
232    */
233   public final OMSVGMatrix getScreenCTM() {
234     return ((SVGPolygonElement)ot).getScreenCTM();
235   }
236   /**
237    * Returns the transformation matrix from the user coordinate system on the
238    * current element (after application of the <code>transform</code> attribute,
239    * if any) to the user coordinate system on parameter <var>element</var> (after
240    * application of its <code>transform</code> attribute, if any).
241    * @param element The target element.
242    * @return An {@link org.vectomatic.dom.svg.OMSVGMatrix} object that defines
243    * the transformation.
244    * @throws SVGException(SVG_MATRIX_NOT_INVERTABLE) Raised if the currently
245    * defined transformation matrices make it impossible to compute the   given
246    * matrix (e.g., because one of the transformations is singular).
247    */
248   public final OMSVGMatrix getTransformToElement(OMSVGElement element) throws JavaScriptException {
249     return ((SVGPolygonElement)ot).getTransformToElement(((SVGElement)element.ot));
250   }
251 
252   // Implementation of the svg::SVGTests W3C IDL interface
253   /**
254    * Corresponds to attribute {@link org.vectomatic.dom.svg.itf.ISVGTests#getRequiredFeatures()}
255    * on the given element.
256    */
257   public final OMSVGStringList getRequiredFeatures() {
258     return ((SVGPolygonElement)ot).getRequiredFeatures();
259   }
260   /**
261    * Corresponds to attribute {@link org.vectomatic.dom.svg.itf.ISVGTests#getRequiredExtensions()}
262    * on the given element.
263    */
264   public final OMSVGStringList getRequiredExtensions() {
265     return ((SVGPolygonElement)ot).getRequiredExtensions();
266   }
267   /**
268    * Corresponds to attribute {@link org.vectomatic.dom.svg.itf.ISVGTests#getSystemLanguage()}
269    * on the given element.
270    */
271   public final OMSVGStringList getSystemLanguage() {
272     return ((SVGPolygonElement)ot).getSystemLanguage();
273   }
274   /**
275    * Returns true if the user agent supports the given extension, specified
276    * by a URI.
277    * @param extension The name of the extension, expressed as a URI.
278    * @return True or false, depending on whether the given extension is   supported.
279    */
280   public final boolean hasExtension(String extension) {
281     return ((SVGPolygonElement)ot).hasExtension(extension);
282   }
283 
284   // Implementation of the svg::SVGTransformable W3C IDL interface
285   /**
286    * Corresponds to attribute {@link org.vectomatic.dom.svg.itf.ISVGTransformable#getTransform()}
287    * on the given element.
288    */
289   public final OMSVGAnimatedTransformList getTransform() {
290     return ((SVGPolygonElement)ot).getTransform();
291   }
292 
293   @Override
294   public final HandlerRegistration addClickHandler(ClickHandler handler) {
295     return addDomHandler(handler, ClickEvent.getType());
296   }
297   @Override
298   public final HandlerRegistration addDragEndHandler(DragEndHandler handler) {
299     return addDomHandler(handler, DragEndEvent.getType());
300   }
301   @Override
302   public final HandlerRegistration addDragEnterHandler(DragEnterHandler handler) {
303     return addDomHandler(handler, DragEnterEvent.getType());
304   }
305   @Override
306   public final HandlerRegistration addDragHandler(DragHandler handler) {
307     return addDomHandler(handler, DragEvent.getType());
308   }
309   @Override
310   public final HandlerRegistration addDragLeaveHandler(DragLeaveHandler handler) {
311     return addDomHandler(handler, DragLeaveEvent.getType());
312   }
313   @Override
314   public final HandlerRegistration addDragOverHandler(DragOverHandler handler) {
315     return addDomHandler(handler, DragOverEvent.getType());
316   }
317   @Override
318   public final HandlerRegistration addDragStartHandler(DragStartHandler handler) {
319     return addDomHandler(handler, DragStartEvent.getType());
320   }
321   @Override
322   public final HandlerRegistration addDropHandler(DropHandler handler) {
323     return addDomHandler(handler, DropEvent.getType());
324   }
325   @Override
326   public final HandlerRegistration addLoadHandler(LoadHandler handler) {
327     return addDomHandler(handler, LoadEvent.getType());
328   }
329   @Override
330   public final HandlerRegistration addMouseDownHandler(MouseDownHandler handler) {
331     return addDomHandler(handler, MouseDownEvent.getType());
332   }
333   @Override
334   public final HandlerRegistration addMouseMoveHandler(MouseMoveHandler handler) {
335     return addDomHandler(handler, MouseMoveEvent.getType());
336   }
337   @Override
338   public final HandlerRegistration addMouseOutHandler(MouseOutHandler handler) {
339     return addDomHandler(handler, MouseOutEvent.getType());
340   }
341   @Override
342   public final HandlerRegistration addMouseOverHandler(MouseOverHandler handler) {
343     return addDomHandler(handler, MouseOverEvent.getType());
344   }
345   @Override
346   public final HandlerRegistration addMouseUpHandler(MouseUpHandler handler) {
347     return addDomHandler(handler, MouseUpEvent.getType());
348   }
349   @Override
350   public final HandlerRegistration addTouchCancelHandler(TouchCancelHandler handler) {
351     return addDomHandler(handler, TouchCancelEvent.getType());
352   }
353   @Override
354   public final HandlerRegistration addTouchEndHandler(TouchEndHandler handler) {
355     return addDomHandler(handler, TouchEndEvent.getType());
356   }
357   @Override
358   public final HandlerRegistration addTouchMoveHandler(TouchMoveHandler handler) {
359     return addDomHandler(handler, TouchMoveEvent.getType());
360   }
361   @Override
362   public final HandlerRegistration addTouchStartHandler(TouchStartHandler handler) {
363     return addDomHandler(handler, TouchStartEvent.getType());
364   }
365   @Override
366   public final HandlerRegistration addActivateHandler(ActivateHandler handler) {
367     return addDomHandler(handler, ActivateEvent.getType());
368   }
369   @Override
370   public final HandlerRegistration addFocusInHandler(FocusInHandler handler) {
371     return addDomHandler(handler, FocusInEvent.getType());
372   }
373   @Override
374   public final HandlerRegistration addFocusOutHandler(FocusOutHandler handler) {
375     return addDomHandler(handler, FocusOutEvent.getType());
376   }
377 }