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
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.
Events:
Type |
Phases |
Description |
org.apache.myfaces.trinidad.event.PollEvent |
Invoke Application |
Event delivered when the poll component polls the server. |
org.apache.myfaces.trinidad.event.AttributeChangeEvent |
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. |
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. |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase |
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeAttributeChangeListener, removeFacesListener, restoreState, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl |
Methods inherited from class javax.faces.component.UIComponent |
getContainerClientId, invokeOnComponent |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
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
CorePoll
public CorePoll()
- Construct an instance of the CorePoll.
CorePoll
protected CorePoll(java.lang.String rendererType)
- Construct an instance of the CorePoll.
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
Copyright © 2001-2007 Apache Software Foundation. All Rights Reserved.