org.icefaces.mobi.component.onlinestatus

Class OnlineStatusBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

org.icefaces.mobi.component.onlinestatus.OnlineStatusBase

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

Direct Known Subclasses:

OnlineStatus

public abstract class OnlineStatusBase
extends javax.faces.component.UIComponentBase
implements IOnlineStatus

Renders an element that has its CSS class changed depending on what the online state of the browser. Also it provides attributes that can take Javascript code that is executed when browser goes online or offline.

Nested Class Summary

Nested Classes

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getFamily()
java.lang.String	getOfflineStyleClass() Return the value of the offlineStyleClass property.
java.lang.String	getOnlineStyleClass() Return the value of the onlineStyleClass property.
java.lang.String	getOnOffline() Return the value of the onOffline property.
java.lang.String	getOnOnline() Return the value of the onOnline property.
protected boolean	isPropertySet(java.lang.String finder)
void	setOfflineStyleClass(java.lang.String offlineStyleClass) Set the value of the offlineStyleClass property.
void	setOnlineStyleClass(java.lang.String onlineStyleClass) Set the value of the onlineStyleClass property.
void	setOnOffline(java.lang.String onOffline) Set the value of the onOffline property.
void	setOnOnline(java.lang.String onOnline) Set the value of the onOnline 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

OnlineStatusBase

public OnlineStatusBase()

Method Detail

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

setOfflineStyleClass

public void setOfflineStyleClass(java.lang.String offlineStyleClass)

Set the value of the offlineStyleClass property.

Contents: The CSS class applied to the component's root element when browser is offline.

Specified by:

setOfflineStyleClass in interface IOnlineStatus

getOfflineStyleClass

public java.lang.String getOfflineStyleClass()

Return the value of the offlineStyleClass property.

Contents: The CSS class applied to the component's root element when browser is offline.

Specified by:

getOfflineStyleClass in interface IOnlineStatus

setOnOffline

public void setOnOffline(java.lang.String onOffline)

Set the value of the onOffline property.

Contents: JavaScript to be evaluated when the browser goes offline. The 'element' argument passed to the callback code is the root element of the component.

Specified by:

setOnOffline in interface IOnlineStatus

getOnOffline

public java.lang.String getOnOffline()

Return the value of the onOffline property.

Contents: JavaScript to be evaluated when the browser goes offline. The 'element' argument passed to the callback code is the root element of the component.

Specified by:

getOnOffline in interface IOnlineStatus

setOnOnline

public void setOnOnline(java.lang.String onOnline)

Set the value of the onOnline property.

Contents: JavaScript to be evaluated when the browser goes online. The 'element' argument passed to the callback code is the root element of the component.

Specified by:

setOnOnline in interface IOnlineStatus

getOnOnline

public java.lang.String getOnOnline()

Return the value of the onOnline property.

Contents: JavaScript to be evaluated when the browser goes online. The 'element' argument passed to the callback code is the root element of the component.

Specified by:

getOnOnline in interface IOnlineStatus

setOnlineStyleClass

public void setOnlineStyleClass(java.lang.String onlineStyleClass)

Set the value of the onlineStyleClass property.

Contents: The CSS class applied to the component's root element when browser is online.

Specified by:

setOnlineStyleClass in interface IOnlineStatus

getOnlineStyleClass

public java.lang.String getOnlineStyleClass()

Return the value of the onlineStyleClass property.

Contents: The CSS class applied to the component's root element when browser is online.

Specified by:

getOnlineStyleClass in interface IOnlineStatus

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