org.vectomatic.dom.svg.events.RepeatEvent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of lib-gwt-svg Show documentation
A GWT library to access the SVG functionalities of web browsers
There is a newer version: 0.5.15
/**********************************************
 * Copyright (C) 2010 Lukas Laag
 * This file is part of lib-gwt-svg.
 * 
 * libgwtsvg is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * libgwtsvg is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with libgwtsvg.  If not, see http://www.gnu.org/licenses/
 **********************************************/
/*
 * Copyright (c) 2004 World Wide Web Consortium,
 *
 * (Massachusetts Institute of Technology, European Research Consortium for
 * Informatics and Mathematics, Keio University). All Rights Reserved. This
 * work is distributed under the W3C(r) Software License [1] in the hope that
 * it will be useful, but WITHOUT ANY WARRANTY; without even the implied
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 *
 * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
 */
package org.vectomatic.dom.svg.events;

import com.google.gwt.event.dom.client.DomEvent;

/**
 * This event is raised when an element local timeline repeats. 
 * It will be raised each time the element repeats, after the first iteration.
 * The event provides a numerical indication of which repeat iteration 
 * is beginning. The value is a 0-based integer, but the repeat event is 
 * not raised for the first iteration and so the observed values of the
 * detail attribute will be >= 1. 
 * @author laaglu
 *
 */
public class RepeatEvent extends TimeEvent {
	private static final Type TYPE = new Type(
			"repeat", new RepeatEvent());
	/**
	 * Necessary hack. DomEvent.fireNativeEvent uses NativeEvent.getType
	 * to retrieve the type flyweight. However, for SMIL events, the
	 * event type name is not the same as the event attribute name
	 * (onrepeat/repeatEvent vs onmousedown/mousedown for example !)
	 */
	private static final Type TYPE_ = new Type(
			"repeatEvent", new RepeatEvent());

	/**
	 * Protected constructor, use
	 * {@link DomEvent#fireNativeEvent(com.google.gwt.dom.client.NativeEvent, com.google.gwt.event.shared.HasHandlers)}
	 * to fire mouse out events.
	 */
	protected RepeatEvent() {
	}

	/**
	 * @return the handler type
	 */
	public Type getAssociatedType() {
		return TYPE;
	}

	/**
	 * @return the handler type
	 */
	public static Type getType() {
		return TYPE;
	}

	@Override
	protected void dispatch(RepeatHandler handler) {
		handler.onRepeat(this);
	}

}