Skip navigation links

org.apache.myfaces.trinidad.component.core
Class CorePoll

java.lang.Object
javax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
org.apache.myfaces.trinidad.component.UIXPoll
org.apache.myfaces.trinidad.component.core.CorePoll

All Implemented Interfaces:

javax.faces.component.StateHolder

public class CorePoll

extends UIXPoll

<html:p> The poll element triggers an event after the time interval specified by the interval attribute (in milliseconds). On the server, the org.apache.myfaces.trinidad.event.PollEvent is queued and the listeners get a chance to update the model, refresh components, or even display a dialog in response to this event. The components that have listed this poll component as a partiaTrigger get a chance to re-render themselves. The poll component automatically uses Partial Page Rendering (PPR) if available. </html:p>

Events:

Type	Phases	Description
org.apache.myfaces.trinidad.event.PollEvent	Apply Request Values Invoke Application	Event delivered when the poll component polls the server.
org.apache.myfaces.trinidad.event.AttributeChangeEvent	Invoke Application Apply Request Values	Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static PropertyKey	INTERVAL_KEY
static FacesBean.Type	TYPE

Fields inherited from class org.apache.myfaces.trinidad.component.UIXPoll

IMMEDIATE_KEY, POLL_LISTENER_KEY

Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Fields inherited from class javax.faces.component.UIComponent

bindings

Constructor Summary

	CorePoll() Construct an instance of the CorePoll.
protected	CorePoll(java.lang.String rendererType) Construct an instance of the CorePoll.

Method Summary

protected FacesBean.Type	getBeanType()
java.lang.String	getFamily()
int	getInterval() Gets the time between poll events, in milliseconds.
void	setInterval(int interval) Sets the time between poll events, in milliseconds.

Methods inherited from class org.apache.myfaces.trinidad.component.UIXPoll

addPollListener, broadcast, getPollListener, getPollListeners, isImmediate, queueEvent, removePollListener, setImmediate, setPollListener, setPollListener

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getComponentChangeFilters, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeAttributeChangeListener, removeComponentChangeFilter, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent

addPartialTarget, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getContainerClientId

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final FacesBean.Type TYPE

INTERVAL_KEY

public static final PropertyKey INTERVAL_KEY

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

CorePoll

public CorePoll()

Construct an instance of the CorePoll.

CorePoll

protected CorePoll(java.lang.String rendererType)

Construct an instance of the CorePoll.

Method Detail

getInterval

public final int getInterval()

Gets the time between poll events, in milliseconds. The default is 5000. If in screen-reader mode, make sure the interval is long enough for the screen reader to read through the re-render before a new poll occurs.

Returns:

the new interval value

setInterval

public final void setInterval(int interval)

Sets the time between poll events, in milliseconds. The default is 5000. If in screen-reader mode, make sure the interval is long enough for the screen reader to read through the re-render before a new poll occurs.

Parameters:

interval - the new interval value

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class UIXPoll

getBeanType

protected FacesBean.Type getBeanType()

Overrides:

getBeanType in class UIXPoll

Skip navigation links