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