Package org.wicketstuff.gmap.api

Class GOverlay

java.lang.Object

org.wicketstuff.gmap.api.GOverlay

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

GCircle, GGroundOverlay, GInfoWindow, GMarker, GPolygon, GPolyline, GRectangle

public abstract class GOverlay
extends Object
implements Serializable

Represents an Google Maps API's GOverlay.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
GOverlay()	Construct.
GOverlay(String id)	Used in stateless environment as session id's are changing continuously without state.

Method Summary

Modifier and Type	Method	Description
GOverlay	addFunctionListener(GEvent event, String jsFunction)	Add a none Ajax Event.
GOverlay	addListener(GEvent event, GEventHandler handler)
GOverlay	clearListeners(GEvent event)	Clear listeners.
Map<GEvent,String>	getFunctionListeners()	Return all registered Listeners.
String	getId()
String	getJS()
abstract String	getJSconstructor()	Implement the needed JavaScript constructor for the corresponding JavaScript object.
String	getJSremove()
Map<GEvent,GEventHandler>	getListeners()	Return all registered Listeners.
protected Page	getPage()
GMap	getParent()
void	onEvent(AjaxRequestTarget target, GEvent overlayEvent)	Called when an Ajax call occurs.
void	setParent(GMap parent)
protected abstract void	updateOnAjaxCall(AjaxRequestTarget target, GEvent overlayEvent)	Implement to handle Ajax calls to your needs.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GOverlay

public GOverlay()

Construct.

GOverlay

public GOverlay(String id)

Used in stateless environment as session id's are changing continuously without state.

Method Detail

getJS

public String getJS()

Returns:

String representing the JavaScript add command for the corresponding JavaScript object.

getJSremove

public String getJSremove()

Returns:

String representing the JavaScript remove command for the corresponding JavaScript object.

getId

public String getId()

Returns:

The session unique id of this object as a String.

getJSconstructor

public abstract String getJSconstructor()

Implement the needed JavaScript constructor for the corresponding JavaScript object.

Returns:

String representing the JavaScript constructor.

getParent

public GMap getParent()

getPage

protected Page getPage()

setParent

public void setParent(GMap parent)

addListener

public GOverlay addListener(GEvent event,
                            GEventHandler handler)

addFunctionListener

public GOverlay addFunctionListener(GEvent event,
                                    String jsFunction)

Add a none Ajax Event.

getListeners

public Map<GEvent,GEventHandler> getListeners()

Return all registered Listeners.

Returns:

registered listeners

getFunctionListeners

public Map<GEvent,String> getFunctionListeners()

Return all registered Listeners.

Returns:

registered listeners

clearListeners

public GOverlay clearListeners(GEvent event)

Clear listeners.

Parameters:

event - event to be cleared.

Returns:

This

onEvent

public void onEvent(AjaxRequestTarget target,
                    GEvent overlayEvent)

Called when an Ajax call occurs.

Parameters:

target -

overlayEvent -

updateOnAjaxCall

protected abstract void updateOnAjaxCall(AjaxRequestTarget target,
                                         GEvent overlayEvent)

Implement to handle Ajax calls to your needs.

Parameters:

target -

overlayEvent -