DispatchStoppedHandler.java

/*
 * This is part of Geomajas, a GIS framework, http://www.geomajas.org/.
 *
 * Copyright 2008-2015 Geosparc nv, http://www.geosparc.com/, Belgium.
 *
 * The program is available in open source according to the GNU Affero
 * General Public License. All contributions in this program are covered
 * by the Geomajas Contributors License Agreement. For full licensing
 * details, see LICENSE.txt in the project root.
 */

package org.geomajas.gwt.client.command.event;

import com.google.gwt.event.shared.EventHandler;
import com.google.gwt.event.shared.GwtEvent;
import org.geomajas.annotation.Api;
import org.geomajas.annotation.UserImplemented;

/**
 * Interface for event handlers that catch {@link DispatchStoppedEvent}s.
 *
 * @author Jan De Moerloose
 * @since 2.0.0
 */
@Api(allMethods = true)
@UserImplemented
public interface DispatchStoppedHandler extends EventHandler {

	/**
	 * Type for the events.
	 *
	 * @since 2.0.0
	 */
	GwtEvent.Type<DispatchStoppedHandler> TYPE = new GwtEvent.Type<DispatchStoppedHandler>();

	/**
	 * The event catching method.
	 *
	 * @param event
	 *            The actual {@link DispatchStoppedEvent}.
	 * @since 2.0.0
	 */
	void onDispatchStopped(DispatchStoppedEvent event);
}