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 package org.vectomatic.dom.svg.events;
30
31 import com.google.gwt.event.dom.client.DomEvent;
32 import com.google.gwt.event.dom.client.DomEvent.Type;
33
34 /**
35 * This event is raised at the active end of the element.
36 * Note that this event is not raised at the simple end of each repeat.
37 * This event may be raised both in the course of normal (i.e. scheduled
38 * or interactive) timeline play, as well as in the case that the element
39 * was ended with the endElement or endElementAt methods.
40 * Note that if an element is restarted while it is currently playing,
41 * the element will raise an end event and another begin event, as the
42 * element restarts.
43 */
44 public class EndEvent extends TimeEvent<EndHandler> {
45 private static final Type<EndHandler> TYPE = new Type<EndHandler>(
46 "end", new EndEvent());
47 /**
48 * Necessary hack. DomEvent.fireNativeEvent uses NativeEvent.getType
49 * to retrieve the type flyweight. However, for SMIL events, the
50 * event type name is not the same as the event attribute name
51 * (onend/endEvent vs onmousedown/mousedown for example !)
52 */
53 private static final Type<EndHandler> TYPE_ = new Type<EndHandler>(
54 "endEvent", new EndEvent());
55
56 /**
57 * Protected constructor, use
58 * {@link DomEvent#fireNativeEvent(com.google.gwt.dom.client.NativeEvent, com.google.gwt.event.shared.HasHandlers)}
59 * to fire mouse out events.
60 */
61 protected EndEvent() {
62 }
63
64 /**
65 * @return the handler type
66 */
67 public Type<EndHandler> getAssociatedType() {
68 return TYPE;
69 }
70 /**
71 * @return the handler type
72 */
73 public static Type<EndHandler> getType() {
74 return TYPE;
75 }
76
77 @Override
78 protected void dispatch(EndHandler handler) {
79 handler.onEnd(this);
80 }
81
82 }