@Generated(value={"RichFaces CDK","4.5.0-SNAPSHOT"}) public class UIPoll extends AbstractPoll implements javax.faces.component.behavior.ClientBehaviorHolder, AjaxProps
The <r: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()
Serialized (on default with JSON) data passed to the client by a developer on an AJAX request.
|
String |
getDefaultEventName() |
Collection<String> |
getEventNames() |
Object |
getExecute()
IDs of components that will participate in the "execute" portion of the Request Processing Lifecycle.
|
String |
getFamily() |
int |
getInterval()
Specifies the time in milliseconds between requests.
|
String |
getOnbeforedomupdate()
The client-side script method to be called after the ajax response comes back, but before the DOM is updated
|
String |
getOnbegin()
The client-side script method to be called before an ajax request.
|
String |
getOncomplete()
The client-side script method to be called after the DOM is updated
|
String |
getOntimer()
The client-side script method to be called after the timer counts down, but before the Ajax request is initiated
|
Object |
getRender()
IDs of components that will participate in the "render" portion of the Request Processing Lifecycle.
|
String |
getStatus()
Name of the request status component that will indicate the status of the Ajax request
|
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()
If "true", render only those ids specified in the "render" attribute, forgoing the render of the auto-rendered panels
|
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, getPassThroughAttributes, 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, getPassThroughAttributes, 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()
AjaxProps
public void setData(Object data)
public boolean isEnabled()
AbstractPoll
isEnabled
in class AbstractPoll
public void setEnabled(boolean enabled)
public Object getExecute()
AjaxProps
getExecute
in interface AjaxProps
public void setExecute(Object execute)
public int getInterval()
AbstractPoll
getInterval
in class AbstractPoll
public void setInterval(int interval)
public boolean isLimitRender()
AjaxProps
isLimitRender
in interface AjaxProps
public void setLimitRender(boolean limitRender)
public String getOnbeforedomupdate()
AjaxEventsProps
getOnbeforedomupdate
in interface AjaxEventsProps
public void setOnbeforedomupdate(String onbeforedomupdate)
public String getOnbegin()
AjaxEventsProps
getOnbegin
in interface AjaxEventsProps
public void setOnbegin(String onbegin)
public String getOncomplete()
AjaxEventsProps
getOncomplete
in interface AjaxEventsProps
public void setOncomplete(String oncomplete)
public String getOntimer()
AbstractPoll
getOntimer
in class AbstractPoll
public void setOntimer(String ontimer)
public Object getRender()
AjaxProps
public void setRender(Object render)
public String getStatus()
AjaxProps
public void setStatus(String status)
Copyright © 2014 JBoss by Red Hat. All rights reserved.