org.fujion.lmaps

Class LocateOptions

java.lang.Object

org.fujion.ancillary.Options

org.fujion.lmaps.LocateOptions

All Implemented Interfaces:

org.fujion.ancillary.IOptionMapTransform, org.fujion.client.IClientTransform

public class LocateOptions
extends org.fujion.ancillary.Options

Some geolocation methods take this options parameter.

Field Summary

Fields

Modifier and Type	Field and Description
Boolean	enableHighAccuracy Enables high accuracy, see description in the W3C spec.
Integer	maximumAge Maximum age of detected location.
Integer	maxZoom The maximum zoom for automatic view setting when using setView option.
Boolean	setView If true, automatically sets the map view to the user location with respect to detection accuracy, or to world view if geolocation failed.
Integer	timeout Number of milliseconds to wait for a response from geolocation before firing a locationerror event.
Boolean	watch If true, starts continuous watching of location changes (instead of detecting it once) using W3C watchPosition method.

Constructor Summary

Constructors

Constructor and Description
LocateOptions()

Method Summary

Methods inherited from class org.fujion.ancillary.Options

toMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.fujion.ancillary.IOptionMapTransform

transformForClient

Field Detail

watch

@Option
public Boolean watch

If true, starts continuous watching of location changes (instead of detecting it once) using W3C watchPosition method. You can later stop watching using map.stopLocate() method.

Default: false

setView

@Option
public Boolean setView

If true, automatically sets the map view to the user location with respect to detection accuracy, or to world view if geolocation failed.

Default: false

maxZoom

@Option
public Integer maxZoom

The maximum zoom for automatic view setting when using setView option.

Default: no maximum

timeout

@Option
public Integer timeout

Number of milliseconds to wait for a response from geolocation before firing a locationerror event.

Default: 10000

maximumAge

@Option
public Integer maximumAge

Maximum age of detected location. If less than this amount of milliseconds passed since last geolocation response, locate will return a cached location.

Default: 0

enableHighAccuracy

@Option
public Boolean enableHighAccuracy

Enables high accuracy, see description in the W3C spec.

Default: false

Constructor Detail

LocateOptions

public LocateOptions()