net.java.html.geo

Class Position.Handle

java.lang.Object

net.java.html.geo.Position.Handle

Enclosing class:

Position

public abstract static class Position.Handle
extends Object

Rather than subclassing this class directly consider using OnLocation annotation. Such annotation will generate a subclass for you automatically with two static methods createQuery and createWatch which can be used to obtain instance of this class.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Handle(boolean oneTime) Creates new instance of this handle.

Method Summary

Modifier and Type	Method and Description
boolean	isSupported() Check whether the location API is supported.
protected abstract void	onError(Exception ex) Callback when an error occurs.
protected abstract void	onLocation(Position p) Callback from the implementation when a (new) position has been received and identified
void	setHighAccuracy(boolean enable) Turns on high accuracy mode as specified by the W3C's Geolocation API.
void	setMaximumAge(long age) Sets maximum age of cached results which are acceptable to be returned.
void	setTimeout(long timeout) The amount of milliseconds to wait for a result.
void	start() Initializes the query or watch request(s) and returns immediately.
void	stop() Stops all pending requests.

Methods inherited from class java.lang.Object

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

Constructor Detail

Handle

protected Handle(boolean oneTime)

Creates new instance of this handle.

Parameters:

oneTime - true if the handle represents one time query. false if it represents a watch

Method Detail

onLocation

protected abstract void onLocation(Position p)
                            throws Throwable

Callback from the implementation when a (new) position has been received and identified

Parameters:

p - the position

Throws:

Throwable - if an exception is thrown, it will be logged by the system

onError

protected abstract void onError(Exception ex)
                         throws Throwable

Callback when an error occurs.

Parameters:

ex - the exception describing what went wrong

Throws:

Throwable - if an exception is thrown, it will be logged by the system

isSupported

public final boolean isSupported()

Check whether the location API is supported.

Returns:

true, if one can call Position.Handle.start().

setHighAccuracy

public final void setHighAccuracy(boolean enable)

Turns on high accuracy mode as specified by the W3C's Geolocation API. By default the mode is disabled.

Parameters:

enable - true or false

setTimeout

public final void setTimeout(long timeout)

The amount of milliseconds to wait for a result. By default infinity.

Parameters:

timeout - time in milliseconds to wait for a result.

setMaximumAge

public final void setMaximumAge(long age)

Sets maximum age of cached results which are acceptable to be returned. By default maximum age is set to zero.

Parameters:

age - time in milliseconds of acceptable cached results

start

public final void start()

Initializes the query or watch request(s) and returns immediately. Has no effect if the query has already been started. If a problem appears while starting the system, it is immediately reported via the Position.Handle.onError(java.lang.Exception) callback. For example, if the Position.Handle.isSupported() method returns false an IllegalStateException is created and sent to the callback method.

stop

public final void stop()

Stops all pending requests. After this call no further callbacks can be obtained. Does nothing if no query or watch was in progress.