View Javadoc

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  
33  /**
34   * This event is raised when an element local timeline repeats. 
35   * It will be raised each time the element repeats, after the first iteration.
36   * The event provides a numerical indication of which repeat iteration 
37   * is beginning. The value is a 0-based integer, but the repeat event is 
38   * not raised for the first iteration and so the observed values of the
39   * detail attribute will be >= 1. 
40   * @author laaglu
41   *
42   */
43  public class RepeatEvent extends TimeEvent<RepeatHandler> {
44  	private static final Type<RepeatHandler> TYPE = new Type<RepeatHandler>(
45  			"repeat", new RepeatEvent());
46  	/**
47  	 * Necessary hack. DomEvent.fireNativeEvent uses NativeEvent.getType
48  	 * to retrieve the type flyweight. However, for SMIL events, the
49  	 * event type name is not the same as the event attribute name
50  	 * (onrepeat/repeatEvent vs onmousedown/mousedown for example !)
51  	 */
52  	private static final Type<RepeatHandler> TYPE_ = new Type<RepeatHandler>(
53  			"repeatEvent", new RepeatEvent());
54  
55  	/**
56  	 * Protected constructor, use
57  	 * {@link DomEvent#fireNativeEvent(com.google.gwt.dom.client.NativeEvent, com.google.gwt.event.shared.HasHandlers)}
58  	 * to fire mouse out events.
59  	 */
60  	protected RepeatEvent() {
61  	}
62  
63  	/**
64  	 * @return the handler type
65  	 */
66  	public Type<RepeatHandler> getAssociatedType() {
67  		return TYPE;
68  	}
69  
70  	/**
71  	 * @return the handler type
72  	 */
73  	public static Type<RepeatHandler> getType() {
74  		return TYPE;
75  	}
76  
77  	@Override
78  	protected void dispatch(RepeatHandler handler) {
79  		handler.onRepeat(this);
80  	}
81  
82  }