org.icefaces.mobi.component.geotrack

Class GeoTrackBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

org.icefaces.mobi.component.geotrack.GeoTrackBase

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, IGeoTrack

Direct Known Subclasses:

GeoTrack

public abstract class GeoTrackBase
extends javax.faces.component.UIComponentBase
implements IGeoTrack

The geoTrack component renders a button that allows geotracking to be initiated through the bridgeit.js API. After Bridgeit geotracking is initiated, Bridget will send geoJSON data to the server as well as any custom parameters defined in the component tag. This data will be published to the application-scoped bean property specified by the attribute 'publish'. Because of the way the Bridgeit geotracking feature works, a user can be tracked for hours without necessarily having an active session. Because of this and because of the fact that the data is sent in a non-JSF request, only application-scoped beans are supported. The data sent by Bridgeit will be in JSON format. The custom parameters will be under the 'properties' object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	GeoTrackBase.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
GeoTrackBase()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getButtonLabel() Return the value of the buttonLabel property.
double	getDuration() Return the value of the duration property.
java.lang.String	getFamily()
java.lang.String	getParameters() Return the value of the parameters property.
java.lang.String	getPublish() Return the value of the publish property.
java.lang.String	getStrategy() Return the value of the strategy property.
java.lang.String	getStyle() Return the value of the style property.
java.lang.String	getStyleClass() Return the value of the styleClass property.
int	getTabindex() Return the value of the tabindex property.
boolean	isDisabled() Return the value of the disabled property.
protected boolean	isPropertySet(java.lang.String finder)
void	setButtonLabel(java.lang.String buttonLabel) Set the value of the buttonLabel property.
void	setDisabled(boolean disabled) Set the value of the disabled property.
void	setDuration(double duration) Set the value of the duration property.
void	setParameters(java.lang.String parameters) Set the value of the parameters property.
void	setPublish(java.lang.String publish) Set the value of the publish property.
void	setStrategy(java.lang.String strategy) Set the value of the strategy property.
void	setStyle(java.lang.String style) Set the value of the style property.
void	setStyleClass(java.lang.String styleClass) Set the value of the styleClass property.
void	setTabindex(int tabindex) Set the value of the tabindex 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

GeoTrackBase

public GeoTrackBase()

Method Detail

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

setButtonLabel

public void setButtonLabel(java.lang.String buttonLabel)

Set the value of the buttonLabel property.

Contents: The label to be displayed on the button.

Specified by:

setButtonLabel in interface IGeoTrack

getButtonLabel

public java.lang.String getButtonLabel()

Return the value of the buttonLabel property.

Contents: The label to be displayed on the button. Default = 'Geotrack'.

Specified by:

getButtonLabel in interface IGeoTrack

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 IGeoTrack

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 IGeoTrack

setDuration

public void setDuration(double duration)

Set the value of the duration property.

Contents: The duration in hours.

Specified by:

setDuration in interface IGeoTrack

getDuration

public double getDuration()

Return the value of the duration property.

Contents: The duration in hours. Default = '1.0'.

Specified by:

getDuration in interface IGeoTrack

setParameters

public void setParameters(java.lang.String parameters)

Set the value of the parameters property.

Contents: Custom parameters that will be echoed by Bridgeit whenever it sends geotracking data to the server. These parameters can be used to identify individual users, pages, etc. The parameters must be in correct JSON format (without the opening/closing brackets), and the names should always start with the underscore character (e.g. "_viewId: '/geotracking.jsf', _userId: '001'").

Specified by:

setParameters in interface IGeoTrack

getParameters

public java.lang.String getParameters()

Return the value of the parameters property.

Contents: Custom parameters that will be echoed by Bridgeit whenever it sends geotracking data to the server. These parameters can be used to identify individual users, pages, etc. The parameters must be in correct JSON format (without the opening/closing brackets), and the names should always start with the underscore character (e.g. "_viewId: '/geotracking.jsf', _userId: '001'").

Specified by:

getParameters in interface IGeoTrack

setPublish

public void setPublish(java.lang.String publish)

Set the value of the publish property.

Contents: The application-scoped bean property where the geoJSON data and other parameters will be published to.

Specified by:

setPublish in interface IGeoTrack

getPublish

public java.lang.String getPublish()

Return the value of the publish property.

Contents: The application-scoped bean property where the geoJSON data and other parameters will be published to.

Specified by:

getPublish in interface IGeoTrack

setStrategy

public void setStrategy(java.lang.String strategy)

Set the value of the strategy property.

Contents: Three strategies are currently supported: 'continuous' where the location of the device will be uploaded as frequently as it changes (intended for testing only due to high power consumption), 'significant' where the location is uploaded when it changes significantly, and 'stop' to cease location tracking.

Specified by:

setStrategy in interface IGeoTrack

getStrategy

public java.lang.String getStrategy()

Return the value of the strategy property.

Contents: Three strategies are currently supported: 'continuous' where the location of the device will be uploaded as frequently as it changes (intended for testing only due to high power consumption), 'significant' where the location is uploaded when it changes significantly, and 'stop' to cease location tracking. Default = 'continuous'.

Specified by:

getStrategy in interface IGeoTrack

setStyle

public void setStyle(java.lang.String style)

Set the value of the style property.

Contents: Sets the CSS style definition to be applied to this component.

Specified by:

setStyle in interface IGeoTrack

getStyle

public java.lang.String getStyle()

Return the value of the style property.

Contents: Sets the CSS style definition to be applied to this component.

Specified by:

getStyle in interface IGeoTrack

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Set the value of the styleClass property.

Contents: Sets the CSS class to apply to this component.

Specified by:

setStyleClass in interface IGeoTrack

getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property.

Contents: Sets the CSS class to apply to this component.

Specified by:

getStyleClass in interface IGeoTrack

setTabindex

public void setTabindex(int tabindex)

Set the value of the tabindex property.

Contents: The tabindex of this component.

Specified by:

setTabindex in interface IGeoTrack

getTabindex

public int getTabindex()

Return the value of the tabindex property.

Contents: The tabindex of this component.

Specified by:

getTabindex in interface IGeoTrack

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