com.rapidclipse.framework.server.webapi.geolocation

Class Geolocation

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.polymertemplate.AbstractTemplate<M>

com.vaadin.flow.component.polymertemplate.PolymerTemplate<M>

com.rapidclipse.framework.server.webapi.JavascriptTemplate<Geolocation.GeolocationTemplateModel>

com.rapidclipse.framework.server.webapi.geolocation.Geolocation

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, Serializable

@HtmlImport(value="frontend://webapi/geolocation.html")
 @Tag(value="rap-geolocation")
public class Geolocation
extends JavascriptTemplate<Geolocation.GeolocationTemplateModel>

This class lets you query the geographic position of the current device and also register onChange update listeners.

Since:

10.02.00

Author:

XDEV Software

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Geolocation.GeolocationTemplateModel

Constructor Summary

Constructors

Constructor and Description
Geolocation(com.vaadin.flow.component.HasElement parent)

Method Summary

Modifier and Type	Method and Description
com.vaadin.flow.shared.Registration	addPositionErrorConsumer(com.vaadin.flow.function.SerializableConsumer<PositionError> consumer) Add a position error consumer.
com.vaadin.flow.shared.Registration	addPositionListener(com.vaadin.flow.function.SerializableConsumer<Position> listener) Add a position listener.
void	clearWatch() Clears the listeners registered with the addPosition...
void	getCurrentPosition(PositionOptions options) Ask the device for its current geographic location.
com.vaadin.flow.shared.Registration	watchPosition(PositionOptions options) Queries the geographic location of the device.

Methods inherited from class com.rapidclipse.framework.server.webapi.JavascriptTemplate

clearConsumers, notifyConsumers, registerConsumer, registerConsumer, unregisterAllConsumers, unregisterAllConsumers

Methods inherited from class com.vaadin.flow.component.polymertemplate.PolymerTemplate

getChildren

Methods inherited from class com.vaadin.flow.component.polymertemplate.AbstractTemplate

getModel, getModelType, getModelType, getStateNode, initModel, isSupportedClass

Methods inherited from class com.vaadin.flow.component.Component

addListener, fireEvent, from, get, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getUI, hasListener, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Constructor Detail

Geolocation

public Geolocation(com.vaadin.flow.component.HasElement parent)

Method Detail

addPositionListener

public com.vaadin.flow.shared.Registration addPositionListener(com.vaadin.flow.function.SerializableConsumer<Position> listener)

Add a position listener. This consumer is triggered when watchPosition(PositionOptions) returns a position successfully.

addPositionErrorConsumer

public com.vaadin.flow.shared.Registration addPositionErrorConsumer(com.vaadin.flow.function.SerializableConsumer<PositionError> consumer)

Add a position error consumer. This consumer is triggered when watchPosition(PositionOptions) returns an error.

getCurrentPosition

public void getCurrentPosition(PositionOptions options)

Ask the device for its current geographic location. When the information is received, the consumers added via addPositionListener(SerializableConsumer) are called. If errors are received the consumers added via addPositionErrorConsumer(SerializableConsumer) are called.

Parameters:

options - Various options used for the query. If a simple read suffices the PositionOptions#DEFAULT constant can be used.

watchPosition

public com.vaadin.flow.shared.Registration watchPosition(PositionOptions options)

Queries the geographic location of the device. When the location is received the consumers added via addPositionListener(SerializableConsumer) are called. If an error is received the consumers added via addPositionErrorConsumer(SerializableConsumer) are called.

Parameters:

options - Various options that are used for the location query.

clearWatch

public void clearWatch()

Clears the listeners registered with the addPosition... methods and stops the client from sending more events to the server.