org.geomajas.gwt2.client.event.NavigationStartHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of geomajas-client-gwt2-api Show documentation

Geomajas GWT2 client: Main - API

The newest version!

/*
 * 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.gwt2.client.event;

import org.geomajas.annotation.Api;
import org.geomajas.annotation.UserImplemented;

import com.google.gwt.event.shared.EventHandler;
import com.google.web.bindery.event.shared.Event.Type;

/**
 * Event handler for catching animation start events from the {@link org.geomajas.puregwt.client.map.ViewPort}. It means
 * that an animated navigation sequence is about to begin.
 * 
 * @author Pieter De Graef
 * @since 2.0.0
 */
@Api(allMethods = true)
@UserImplemented
public interface NavigationStartHandler extends EventHandler {

	/** Event handler type definition. */
	Type TYPE = new Type();

	/**
	 * Catches events where the {@link org.geomajas.puregwt.client.map.ViewPort} is about to start a navigation
	 * animation.
	 * 
	 * @param event
	 *            The actual {@link org.geomajas.gwt2.client.event.puregwt.client.event.NavigationStartEvent}.
	 */
	void onNavigationStarted(NavigationStartEvent event);
}