org.icefaces.mobi.component.geolocation

Class GeolocationBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

org.icefaces.mobi.component.geolocation.GeolocationBase

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, IGeolocation

Direct Known Subclasses:

Geolocation

public abstract class GeolocationBase
extends javax.faces.component.UIComponentBase
implements IGeolocation

geolocation captures a geolocation object of longitude and latitude, heading, speed and altitude via html5 navigator API.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	GeolocationBase.PropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPONENT_TYPE
static java.lang.String	RENDERER_TYPE

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor and Description
GeolocationBase()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Double	getAltitude() Return the value of the altitude property.
java.lang.Double	getDirection() Return the value of the direction property.
java.lang.String	getEnableHighPrecision() Return the value of the enableHighPrecision property.
java.lang.String	getFamily()
java.lang.Double	getLatitude() Return the value of the latitude property.
java.lang.Double	getLongitude() Return the value of the longitude property.
int	getMaximumAge() Return the value of the maximumAge property.
int	getTimeout() Return the value of the timeout property.
boolean	isContinuousUpdates() Return the value of the continuousUpdates property.
boolean	isDisabled() Return the value of the disabled property.
protected boolean	isPropertySet(java.lang.String finder)
void	setAltitude(java.lang.Double altitude) Set the value of the altitude property.
void	setContinuousUpdates(boolean continuousUpdates) Set the value of the continuousUpdates property.
void	setDirection(java.lang.Double direction) Set the value of the direction property.
void	setDisabled(boolean disabled) Set the value of the disabled property.
void	setEnableHighPrecision(java.lang.String enableHighPrecision) Set the value of the enableHighPrecision property.
void	setLatitude(java.lang.Double latitude) Set the value of the latitude property.
void	setLongitude(java.lang.Double longitude) Set the value of the longitude property.
void	setMaximumAge(int maximumAge) Set the value of the maximumAge property.
void	setTimeout(int timeout) Set the value of the timeout property.
void	setValueExpression(java.lang.String name, javax.el.ValueExpression binding)

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, visitTree

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

GeolocationBase

public GeolocationBase()

Method Detail

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

setAltitude

public void setAltitude(java.lang.Double altitude)

Set the value of the altitude property.

Contents: Altitude of mobile device in meters.

Specified by:

setAltitude in interface IGeolocation

getAltitude

public java.lang.Double getAltitude()

Return the value of the altitude property.

Contents: Altitude of mobile device in meters.

Specified by:

getAltitude in interface IGeolocation

setContinuousUpdates

public void setContinuousUpdates(boolean continuousUpdates)

Set the value of the continuousUpdates property.

Contents: Determines if the component will continuously update the position. If true, a listener is used to retrieve position from navigator.geolocation.watchPosition. If false, the component will fetch a one time update via navigator.gelocation.getCurrentPosition

Specified by:

setContinuousUpdates in interface IGeolocation

isContinuousUpdates

public boolean isContinuousUpdates()

Return the value of the continuousUpdates property.

Contents: Determines if the component will continuously update the position. If true, a listener is used to retrieve position from navigator.geolocation.watchPosition. If false, the component will fetch a one time update via navigator.gelocation.getCurrentPosition Default = 'true'.

Specified by:

isContinuousUpdates in interface IGeolocation

setDirection

public void setDirection(java.lang.Double direction)

Set the value of the direction property.

Contents: Direction of mobile device in degrees from North.

Specified by:

setDirection in interface IGeolocation

getDirection

public java.lang.Double getDirection()

Return the value of the direction property.

Contents: Direction of mobile device in degrees from North.

Specified by:

getDirection in interface IGeolocation

setDisabled

public void setDisabled(boolean disabled)

Set the value of the disabled property.

Contents: Disables this component, so it does not receive focus or get submitted.

Specified by:

setDisabled in interface IGeolocation

isDisabled

public boolean isDisabled()

Return the value of the disabled property.

Contents: Disables this component, so it does not receive focus or get submitted. Default = 'false'.

Specified by:

isDisabled in interface IGeolocation

setEnableHighPrecision

public void setEnableHighPrecision(java.lang.String enableHighPrecision)

Set the value of the enableHighPrecision property.

Contents: Determines if high precision location is retrieved using GPS. Has values of true, false, and asNeeded; where true means use GPS, false means don't use GPS, and asNeeded means use GPS only if needed to get a position.

Specified by:

setEnableHighPrecision in interface IGeolocation

getEnableHighPrecision

public java.lang.String getEnableHighPrecision()

Return the value of the enableHighPrecision property.

Contents: Determines if high precision location is retrieved using GPS. Has values of true, false, and asNeeded; where true means use GPS, false means don't use GPS, and asNeeded means use GPS only if needed to get a position. Default = 'asNeeded'.

Specified by:

getEnableHighPrecision in interface IGeolocation

setLatitude

public void setLatitude(java.lang.Double latitude)

Set the value of the latitude property.

Contents: Latitude of mobile device in decimal degrees.

Specified by:

setLatitude in interface IGeolocation

getLatitude

public java.lang.Double getLatitude()

Return the value of the latitude property.

Contents: Latitude of mobile device in decimal degrees.

Specified by:

getLatitude in interface IGeolocation

setLongitude

public void setLongitude(java.lang.Double longitude)

Set the value of the longitude property.

Contents: Longitude of mobile device in decimal degrees.

Specified by:

setLongitude in interface IGeolocation

getLongitude

public java.lang.Double getLongitude()

Return the value of the longitude property.

Contents: Longitude of mobile device in decimal degrees.

Specified by:

getLongitude in interface IGeolocation

setMaximumAge

public void setMaximumAge(int maximumAge)

Set the value of the maximumAge property.

Contents: Indicates maximum age in seconds, of a cached position that is acceptable for use.

Specified by:

setMaximumAge in interface IGeolocation

getMaximumAge

public int getMaximumAge()

Return the value of the maximumAge property.

Contents: Indicates maximum age in seconds, of a cached position that is acceptable for use. Default = '0'.

Specified by:

getMaximumAge in interface IGeolocation

setTimeout

public void setTimeout(int timeout)

Set the value of the timeout property.

Contents: The maximum time in seconds to wait for success or error response. A value of 0 indicates no timeout.

Specified by:

setTimeout in interface IGeolocation

getTimeout

public int getTimeout()

Return the value of the timeout property.

Contents: The maximum time in seconds to wait for success or error response. A value of 0 indicates no timeout. Default = '0'.

Specified by:

getTimeout in interface IGeolocation

isPropertySet

protected boolean isPropertySet(java.lang.String finder)

setValueExpression

public void setValueExpression(java.lang.String name,
                      javax.el.ValueExpression binding)

Overrides:

setValueExpression in class javax.faces.component.UIComponent