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