oracle.adf.view.faces.component.core
Class CorePoll

java.lang.Object
  javax.faces.component.UIComponent
      oracle.adf.view.faces.component.UIXComponent
          oracle.adf.view.faces.component.UIXComponentBase
              oracle.adf.view.faces.component.UIXPoll
                  oracle.adf.view.faces.component.core.CorePoll

All Implemented Interfaces:

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 oracle.adf.view.faces.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.

*

This bean is not supported on the following agent types: pda, phone, voice.

Events:

Type	Phases	Description
oracle.adf.view.faces.event.PollEvent	Apply Request Values Invoke Application	Event delivered at the server upon polling.

It does not support any children.

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 oracle.adf.view.faces.component.UIXPoll

IMMEDIATE_KEY, POLL_LISTENER_KEY

Fields inherited from class oracle.adf.view.faces.component.UIXComponentBase

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

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 oracle.adf.view.faces.component.UIXPoll

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

Methods inherited from class oracle.adf.view.faces.component.UIXComponentBase

addAttributeChange, addAttributeChange, addAttributeChangeListener, addFacesListener, 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, getLocalClientId, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeAttributeChangeListener, removeFacesListener, restoreState, saveState, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

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.

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.

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class UIXPoll

getBeanType

protected FacesBean.Type getBeanType()

Overrides:

getBeanType in class UIXPoll