@Generated(value={"RichFaces CDK","4.3.1.Final"}) public class UIPoll extends AbstractPoll implements javax.faces.component.behavior.ClientBehaviorHolder
The <a4j:poll> component allows periodical sending of Ajax requests to the server. It is used for repeatedly updating a page at specific time intervals.
Modifier and Type | Class and Description |
---|---|
protected static class |
UIPoll.Properties |
Modifier and Type | Field and Description |
---|---|
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
BEFOREDOMUPDATE, BEGIN, COMPLETE, ON_BEFOREDOMUPDATE, ON_BEGIN, ON_COMPLETE, ON_TIMER, TIMER
Constructor and Description |
---|
UIPoll() |
Modifier and Type | Method and Description |
---|---|
Object |
getData() |
String |
getDefaultEventName() |
Collection<String> |
getEventNames() |
Object |
getExecute() |
String |
getFamily() |
int |
getInterval()
Specifies the time in milliseconds between requests.
|
String |
getOnbeforedomupdate() |
String |
getOnbegin() |
String |
getOncomplete() |
String |
getOntimer()
The client-side script method to be called after the timer counts down, but before the Ajax request is initiated
|
Object |
getRender() |
String |
getStatus() |
boolean |
isBypassUpdates()
If "true", after process validations phase it skips updates of model beans on a force render response.
|
boolean |
isEnabled()
Enables/disables polling to the server.
|
boolean |
isLimitRender() |
void |
setBypassUpdates(boolean bypassUpdates) |
void |
setData(Object data) |
void |
setEnabled(boolean enabled) |
void |
setExecute(Object execute) |
void |
setInterval(int interval) |
void |
setLimitRender(boolean limitRender) |
void |
setOnbeforedomupdate(String onbeforedomupdate) |
void |
setOnbegin(String onbegin) |
void |
setOncomplete(String oncomplete) |
void |
setOntimer(String ontimer) |
void |
setRender(Object render) |
void |
setStatus(String status) |
queueEvent
addActionListener, broadcast, getAction, getActionExpression, getActionListener, getActionListeners, getValue, isImmediate, removeActionListener, setAction, setActionExpression, setActionListener, setImmediate, setValue
addClientBehavior, addFacesListener, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent
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
public static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
public String getFamily()
getFamily
in class javax.faces.component.UICommand
public Collection<String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
getEventNames
in class javax.faces.component.UIComponentBase
public String getDefaultEventName()
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class javax.faces.component.UIComponentBase
public boolean isBypassUpdates()
AbstractActionComponent
isBypassUpdates
in class AbstractActionComponent
public void setBypassUpdates(boolean bypassUpdates)
setBypassUpdates
in class AbstractActionComponent
public Object getData()
public void setData(Object data)
public boolean isEnabled()
AbstractPoll
isEnabled
in class AbstractPoll
public void setEnabled(boolean enabled)
public Object getExecute()
public void setExecute(Object execute)
public int getInterval()
AbstractPoll
getInterval
in class AbstractPoll
public void setInterval(int interval)
public boolean isLimitRender()
public void setLimitRender(boolean limitRender)
public String getOnbeforedomupdate()
public void setOnbeforedomupdate(String onbeforedomupdate)
public String getOnbegin()
public void setOnbegin(String onbegin)
public String getOncomplete()
public void setOncomplete(String oncomplete)
public String getOntimer()
AbstractPoll
getOntimer
in class AbstractPoll
public void setOntimer(String ontimer)
public Object getRender()
public void setRender(Object render)
public String getStatus()
public void setStatus(String status)
Copyright © 2013 JBoss by Red Hat. All Rights Reserved.