@Generated(value={"RichFaces CDK","4.5.0-SNAPSHOT"}) public class UIAjaxFunction extends AbstractAjaxFunction implements javax.faces.component.behavior.ClientBehaviorHolder, AjaxProps
The <r:jsFunction> component performs Ajax requests directly from JavaScript code and retrieves server-side data. The server-side data is returned in JavaScript Object Notation (JSON) format prior to the execution of any JavaScript code defined using the "oncomplete" attribute.
| Modifier and Type | Class and Description |
|---|---|
protected static class |
UIAjaxFunction.Properties |
| Modifier and Type | Field and Description |
|---|---|
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
| Constructor and Description |
|---|
UIAjaxFunction() |
| 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() |
String |
getName()
The name of the generated javascript function
|
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
|
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 |
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 |
setExecute(Object execute) |
void |
setLimitRender(boolean limitRender) |
void |
setName(String name) |
void |
setOnbeforedomupdate(String onbeforedomupdate) |
void |
setOnbegin(String onbegin) |
void |
setOncomplete(String oncomplete) |
void |
setRender(Object render) |
void |
setStatus(String status) |
queueEventaddActionListener, broadcast, getAction, getActionExpression, getActionListener, getActionListeners, getValue, isImmediate, removeActionListener, setAction, setActionExpression, setActionListener, setImmediate, setValueaddClientBehavior, 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, unsubscribeFromEventencodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTreepublic static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
public String getFamily()
getFamily in class javax.faces.component.UICommandpublic Collection<String> getEventNames()
getEventNames in interface javax.faces.component.behavior.ClientBehaviorHoldergetEventNames in class javax.faces.component.UIComponentBasepublic String getDefaultEventName()
getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHoldergetDefaultEventName in class javax.faces.component.UIComponentBasepublic boolean isBypassUpdates()
AbstractActionComponentisBypassUpdates in class AbstractActionComponentpublic void setBypassUpdates(boolean bypassUpdates)
setBypassUpdates in class AbstractActionComponentpublic Object getData()
AjaxPropspublic void setData(Object data)
public Object getExecute()
AjaxPropsgetExecute in interface AjaxPropspublic void setExecute(Object execute)
public boolean isLimitRender()
AjaxPropsisLimitRender in interface AjaxPropspublic void setLimitRender(boolean limitRender)
public String getName()
AbstractAjaxFunctiongetName in class AbstractAjaxFunctionpublic void setName(String name)
public String getOnbeforedomupdate()
AjaxEventsPropsgetOnbeforedomupdate in interface AjaxEventsPropspublic void setOnbeforedomupdate(String onbeforedomupdate)
public String getOnbegin()
AjaxEventsPropsgetOnbegin in interface AjaxEventsPropspublic void setOnbegin(String onbegin)
public String getOncomplete()
AjaxEventsPropsgetOncomplete in interface AjaxEventsPropspublic void setOncomplete(String oncomplete)
public Object getRender()
AjaxPropspublic void setRender(Object render)
public String getStatus()
AjaxPropspublic void setStatus(String status)
Copyright © 2014 JBoss by Red Hat. All rights reserved.