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