org.wicketstuff.html5.geolocation

Class AjaxGeolocationBehavior

java.lang.Object

org.apache.wicket.behavior.Behavior

org.apache.wicket.behavior.AbstractAjaxBehavior

org.apache.wicket.ajax.AbstractDefaultAjaxBehavior

org.wicketstuff.html5.geolocation.AjaxGeolocationBehavior

All Implemented Interfaces:

Serializable, org.apache.wicket.behavior.IBehaviorListener, org.apache.wicket.IComponentAwareEventSink, org.apache.wicket.IRequestListener, org.apache.wicket.markup.html.IComponentAwareHeaderContributor, org.apache.wicket.util.io.IClusterable

public abstract class AjaxGeolocationBehavior
extends org.apache.wicket.ajax.AbstractDefaultAjaxBehavior

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.wicket.ajax.AbstractDefaultAjaxBehavior

INDICATOR

Fields inherited from interface org.apache.wicket.behavior.IBehaviorListener

INTERFACE

Constructor Summary

Constructors

Constructor and Description
AjaxGeolocationBehavior()

Method Summary

Methods

Modifier and Type	Method and Description
int	getTimeout() Returns the current timeout in milliseconds.
protected void	onBind()
protected abstract void	onGeoAvailable(org.apache.wicket.ajax.AjaxRequestTarget target, String latitude, String longitude)
protected void	onNotAvailable(org.apache.wicket.ajax.AjaxRequestTarget target, String errorCode, String errorMessage) Override this method if you want to react on the event that no geolocation could be determined.
void	renderHead(org.apache.wicket.Component c, org.apache.wicket.markup.head.IHeaderResponse response)
protected void	respond(org.apache.wicket.ajax.AjaxRequestTarget target)
void	setTimeout(int timeout) Sets the timeout in milliseconds.

Methods inherited from class org.apache.wicket.ajax.AbstractDefaultAjaxBehavior

findIndicatorId, getAttributes, getCallbackFunction, getCallbackFunctionBody, getCallbackScript, getCallbackScript, onRequest, postprocessConfiguration, renderAjaxAttributes, renderAjaxAttributes, updateAjaxAttributes

Methods inherited from class org.apache.wicket.behavior.AbstractAjaxBehavior

afterRender, bind, getCallbackUrl, getComponent, onComponentRendered, onComponentTag, onComponentTag, onUnbind, unbind

Methods inherited from class org.apache.wicket.behavior.Behavior

beforeRender, canCallListenerInterface, detach, getStatelessHint, isEnabled, isTemporary, onConfigure, onEvent, onException, onRemove

Methods inherited from class java.lang.Object

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

Constructor Detail

AjaxGeolocationBehavior

public AjaxGeolocationBehavior()

Method Detail

respond

protected void respond(org.apache.wicket.ajax.AjaxRequestTarget target)

Specified by:

respond in class org.apache.wicket.ajax.AbstractDefaultAjaxBehavior

onGeoAvailable

protected abstract void onGeoAvailable(org.apache.wicket.ajax.AjaxRequestTarget target,
                  String latitude,
                  String longitude)

onNotAvailable

protected void onNotAvailable(org.apache.wicket.ajax.AjaxRequestTarget target,
                  String errorCode,
                  String errorMessage)

Override this method if you want to react on the event that no geolocation could be determined.

Parameters:

target - the AjaxRequestTarget

errorCode - the numeric code for the reason no geolocation could be determined as specified by the W3C (@see http://dev.w3.org/geo/api/spec-source.html#position_error_interface).
"1" indicates a "permission denied"
"2" indicates that the position could not be determined
"3" indicates a timeout

errorMessage - describes the details. Primarily for debugging purposes

onBind

protected void onBind()

Overrides:

onBind in class org.apache.wicket.ajax.AbstractDefaultAjaxBehavior

renderHead

public void renderHead(org.apache.wicket.Component c,
              org.apache.wicket.markup.head.IHeaderResponse response)

Specified by:

renderHead in interface org.apache.wicket.markup.html.IComponentAwareHeaderContributor

Overrides:

renderHead in class org.apache.wicket.ajax.AbstractDefaultAjaxBehavior

getTimeout

public int getTimeout()

Returns the current timeout in milliseconds.

See Also:

setTimeout(int)

setTimeout

public void setTimeout(int timeout)

Sets the timeout in milliseconds. If the user is ignoring the request for sharing his location or postpones his decision (in Firefox the "Not now" option) no callback method is called. This is intended by design (see https://bugzilla.mozilla.org/show_bug.cgi?id=650247 ). For those cases we can set a timeout. After the specified amount of time the onNotAvailable method is called, passing a "3" as an error code. The specification (http://dev.w3.org/geo/api/spec-source.html#position_error_interface) defines also a timeout attribute: "The length of time specified by the timeout property has elapsed before the implementation could successfully acquire a new Position object." So it applies only for the case the user grants permission to share his location and is NOT the timeout which is set in this method! It MIGHT happen that the determination of the location takes a bit longer, even though the user granted permission to share his location. In this case first onNotAvailable(org.apache.wicket.ajax.AjaxRequestTarget, java.lang.String, java.lang.String) will be called and as soon as the location could be obtained onGeoAvailable(org.apache.wicket.ajax.AjaxRequestTarget, java.lang.String, java.lang.String) will be called. So don't set the timeout too low. The default timeout is set to 10 seconds.