org.gwtopenmaps.openlayers.client.event.EventObject Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gwt-openlayers-client Show documentation

There is a newer version: 1.1.0

Show newest version

package org.gwtopenmaps.openlayers.client.event;

import org.gwtopenmaps.openlayers.client.util.JSObject;
import org.gwtopenmaps.openlayers.client.util.JSObjectWrapper;

/**
 * Base class for event objects.
 *
 * Caveat: In Openlayers 2.x event handling is not yet implemented uniformly in OpenLayers. This should be fixed in version 3.x and higher.
 * 
 * In OpenLayers, an event object is an argument that gets passed to the listener when it is called.
 * In GWT OpenLayers, this event object gets passed to the onHandle method of the EventHandler {@link EventHandler} when
 * the onHandle method is called. An event object class extending this base class can wrap this event object.
 * 
 * 
 * Depending on which event is fired, and from which source the event is fired
 * (e.g. Map, Layer, etc.), the event object may differ. Therefore, the
 * addXxxListener methods (see also {@link EventHandler}) that abstract from event registration details,
 * wrap the event object passed to onHandle in a way that is specific to the event.
 * 
 *
 * @author Edwin Commandeur - Atlis EJS
 *
 */
public class EventObject extends JSObjectWrapper {

	protected EventObject(JSObject eventObject){
		super(eventObject);
	}


	public static EventObject narrowToEventObject(JSObject object){
		return (object!=null)? new EventObject(object):null;
	}

	/**
	 *
	 * @return Element as an opaque JSObject
	 */
	public JSObject getElement(){
		return EventObjectImpl.getElement(getJSObject());
	}

	/**
	 * Type is a string like "addlayer" or "move" denoting the type of event.
	 *
	 * @return A string denoting the type of event, or null if there is no type property.
	 */
	public String getType(){
		String type = EventObjectImpl.getType(getJSObject());
		return type;
	}

	/**
	 * @return JSObject - source object that fired the event
	 */
	public JSObject getSourceJSObject(){
		JSObject object = EventObjectImpl.getObject(getJSObject());
		return object;
	}

}