org.primefaces.extensions.component.waypoint
Class Waypoint

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          org.primefaces.extensions.component.waypoint.Waypoint

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, org.primefaces.component.api.Widget, Attachable, EnhancedAttachable

public class Waypoint
extends javax.faces.component.UIComponentBase
implements org.primefaces.component.api.Widget, EnhancedAttachable, javax.faces.component.behavior.ClientBehaviorHolder

Waypoint.

Since:

0.6

Version:

$Revision$

Author:

Oleg Varaksin / last modified by $Author$

Nested Class Summary

protected static class

Waypoint.PropertyKeys PropertyKeys

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_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

Waypoint()

Method Summary

java.util.Collection<java.lang.String>	getEventNames()
java.lang.String	getFamily()
java.lang.String	getFor()
java.lang.String	getForContext()
java.lang.String	getForContextSelector()
java.lang.String	getForSelector()
java.lang.String	getOffset()
java.lang.String	getWidgetVar()
boolean	isContinuous()
boolean	isOnlyOnScroll()
boolean	isTriggerOnce()
void	processDecodes(javax.faces.context.FacesContext fc)
void	processUpdates(javax.faces.context.FacesContext fc)
void	processValidators(javax.faces.context.FacesContext fc)
void	queueEvent(javax.faces.event.FacesEvent event)
java.lang.String	resolveWidgetVar()
void	setAttribute(Waypoint.PropertyKeys property, java.lang.Object value)
void	setContinuous(boolean continuous)
void	setFor(java.lang.String forValue)
void	setForContext(java.lang.String forContext)
void	setForContextSelector(java.lang.String forContextSelector)
void	setForSelector(java.lang.String forSelector)
void	setOffset(java.lang.String offset)
void	setOnlyOnScroll(boolean onlyOnScroll)
void	setTriggerOnce(boolean triggerOnce)
void	setWidgetVar(java.lang.String widgetVar)

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, 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, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

addClientBehavior, getClientBehaviors, getDefaultEventName

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

Constructor Detail

Waypoint

public Waypoint()

Method Detail

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

getWidgetVar

public java.lang.String getWidgetVar()

setWidgetVar

public void setWidgetVar(java.lang.String widgetVar)

getFor

public java.lang.String getFor()

Specified by:

getFor in interface Attachable

setFor

public void setFor(java.lang.String forValue)

Specified by:

setFor in interface Attachable

getForSelector

public java.lang.String getForSelector()

Specified by:

getForSelector in interface EnhancedAttachable

setForSelector

public void setForSelector(java.lang.String forSelector)

Specified by:

setForSelector in interface EnhancedAttachable

getForContext

public java.lang.String getForContext()

setForContext

public void setForContext(java.lang.String forContext)

getForContextSelector

public java.lang.String getForContextSelector()

setForContextSelector

public void setForContextSelector(java.lang.String forContextSelector)

getOffset

public java.lang.String getOffset()

setOffset

public void setOffset(java.lang.String offset)

isContinuous

public boolean isContinuous()

setContinuous

public void setContinuous(boolean continuous)

isOnlyOnScroll

public boolean isOnlyOnScroll()

setOnlyOnScroll

public void setOnlyOnScroll(boolean onlyOnScroll)

isTriggerOnce

public boolean isTriggerOnce()

setTriggerOnce

public void setTriggerOnce(boolean triggerOnce)

getEventNames

public java.util.Collection<java.lang.String> getEventNames()

Specified by:

getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getEventNames in class javax.faces.component.UIComponentBase

processDecodes

public void processDecodes(javax.faces.context.FacesContext fc)

Overrides:

processDecodes in class javax.faces.component.UIComponentBase

processValidators

public void processValidators(javax.faces.context.FacesContext fc)

Overrides:

processValidators in class javax.faces.component.UIComponentBase

processUpdates

public void processUpdates(javax.faces.context.FacesContext fc)

Overrides:

processUpdates in class javax.faces.component.UIComponentBase

queueEvent

public void queueEvent(javax.faces.event.FacesEvent event)

Overrides:

queueEvent in class javax.faces.component.UIComponentBase

resolveWidgetVar

public java.lang.String resolveWidgetVar()

Specified by:

resolveWidgetVar in interface org.primefaces.component.api.Widget

setAttribute

public void setAttribute(Waypoint.PropertyKeys property,
                         java.lang.Object value)