public class AjaxBehavior extends ClientBehavior implements org.ajax4jsf.component.AjaxClientBehavior
The <a4j:ajax> behavior allows Ajax capability to be added to a non-Ajax component. The non-Ajax component must implement the ClientBehaviorHolder interface for all the event attributes that support behavior rendering.
| Modifier and Type | Field and Description |
|---|---|
static String |
BEHAVIOR_ID |
| Constructor and Description |
|---|
AjaxBehavior() |
| Modifier and Type | Method and Description |
|---|---|
void |
addAjaxBehaviorListener(javax.faces.event.AjaxBehaviorListener listener) |
void |
broadcast(javax.faces.event.BehaviorEvent event) |
Object |
getData()
Serialized (on default with JSON) data passed to the client by a developer on an AJAX request.
|
Collection<String> |
getExecute()
Ids of components that will participate in the "execute" portion of the Request Processing Lifecycle.
|
Set<javax.faces.component.behavior.ClientBehaviorHint> |
getHints() |
String |
getOnbeforedomupdate()
The client-side script method to be called after the ajax response comes back, but before the DOM is updated
|
String |
getOnbeforesubmit()
The client-side script method to be called before the AJAX request is submitted
|
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 |
getOnerror()
The client-side script method to be called when an error has occurred during Ajax communications
|
String |
getQueueId()
Identify the name of the destination queue
|
Collection<String> |
getRender()
Ids of components that will participate in the "render" portion of the Request Processing Lifecycle.
|
String |
getRendererType() |
String |
getStatus()
ID of the request status component
|
boolean |
isBypassUpdates()
If "true", after process validations phase it skips updates of model beans on a force render response.
|
boolean |
isDisabled()
If "true", do not initiate an ajax request when the associated event is observed
|
boolean |
isImmediate()
Flag indicating that, if this component is activated by the user, notifications should be delivered to interested
listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke
Application phase.
|
boolean |
isLimitRender()
If "true", render only those ids specified in the "render" attribute, forgoing the render of the auto-rendered panels
|
void |
removeAjaxBehaviorListener(javax.faces.event.AjaxBehaviorListener listener) |
void |
restoreState(javax.faces.context.FacesContext context,
Object state) |
Object |
saveState(javax.faces.context.FacesContext context) |
void |
setBypassUpdates(boolean bypassUpdates) |
void |
setData(Object data) |
void |
setDisabled(boolean disabled) |
void |
setExecute(Collection<String> execute) |
void |
setImmediate(boolean immediate) |
void |
setLimitRender(boolean limitRender) |
void |
setLiteralAttribute(String name,
Object value) |
void |
setOnbeforedomupdate(String onbeforedomupdate) |
void |
setOnbeforesubmit(String onbeforesubmit) |
void |
setOnbegin(String onbegin) |
void |
setOncomplete(String oncomplete) |
void |
setOnerror(String onerror) |
void |
setQueueId(String queueId) |
void |
setRender(Collection<String> render) |
void |
setStatus(String status) |
compare, getFacesContext, getStateHelper, getValueExpression, setLiteralValue, setValueExpressiondecode, getRenderer, getScriptaddBehaviorListener, clearInitialState, initialStateMarked, isTransient, markInitialState, removeBehaviorListener, setTransientpublic static final String BEHAVIOR_ID
public void setLiteralAttribute(String name, Object value)
setLiteralAttribute in class ClientBehaviorpublic Object getData()
getData in interface org.ajax4jsf.component.AjaxClientBehaviorpublic void setData(Object data)
setData in interface org.ajax4jsf.component.AjaxClientBehaviorpublic Collection<String> getExecute()
getExecute in interface org.ajax4jsf.component.AjaxClientBehaviorpublic void setExecute(Collection<String> execute)
setExecute in interface org.ajax4jsf.component.AjaxClientBehaviorpublic String getOnbeforedomupdate()
getOnbeforedomupdate in interface org.ajax4jsf.component.AjaxClientBehaviorpublic void setOnbeforedomupdate(String onbeforedomupdate)
setOnbeforedomupdate in interface org.ajax4jsf.component.AjaxClientBehaviorpublic String getOnbegin()
getOnbegin in interface org.ajax4jsf.component.AjaxClientBehaviorpublic void setOnbegin(String onbegin)
setOnbegin in interface org.ajax4jsf.component.AjaxClientBehaviorpublic String getOnbeforesubmit()
getOnbeforesubmit in interface org.ajax4jsf.component.AjaxClientBehaviorpublic void setOnbeforesubmit(String onbeforesubmit)
setOnbeforesubmit in interface org.ajax4jsf.component.AjaxClientBehaviorpublic String getOncomplete()
getOncomplete in interface org.ajax4jsf.component.AjaxClientBehaviorpublic void setOncomplete(String oncomplete)
setOncomplete in interface org.ajax4jsf.component.AjaxClientBehaviorpublic String getOnerror()
getOnerror in interface org.ajax4jsf.component.AjaxClientBehaviorpublic void setOnerror(String onerror)
setOnerror in interface org.ajax4jsf.component.AjaxClientBehaviorpublic String getQueueId()
getQueueId in interface org.ajax4jsf.component.AjaxClientBehaviorpublic void setQueueId(String queueId)
setQueueId in interface org.ajax4jsf.component.AjaxClientBehaviorpublic Collection<String> getRender()
getRender in interface org.ajax4jsf.component.AjaxClientBehaviorpublic void setRender(Collection<String> render)
setRender in interface org.ajax4jsf.component.AjaxClientBehaviorpublic String getStatus()
getStatus in interface org.ajax4jsf.component.AjaxClientBehaviorpublic void setStatus(String status)
setStatus in interface org.ajax4jsf.component.AjaxClientBehaviorpublic boolean isDisabled()
isDisabled in interface org.ajax4jsf.component.AjaxClientBehaviorpublic void setDisabled(boolean disabled)
setDisabled in interface org.ajax4jsf.component.AjaxClientBehaviorpublic boolean isLimitRender()
isLimitRender in interface org.ajax4jsf.component.AjaxClientBehaviorpublic void setLimitRender(boolean limitRender)
setLimitRender in interface org.ajax4jsf.component.AjaxClientBehaviorpublic boolean isImmediate()
public void setImmediate(boolean immediate)
public boolean isBypassUpdates()
public void setBypassUpdates(boolean bypassUpdates)
public String getRendererType()
getRendererType in class javax.faces.component.behavior.ClientBehaviorBasepublic Set<javax.faces.component.behavior.ClientBehaviorHint> getHints()
getHints in interface javax.faces.component.behavior.ClientBehaviorgetHints in class javax.faces.component.behavior.ClientBehaviorBasepublic void addAjaxBehaviorListener(javax.faces.event.AjaxBehaviorListener listener)
addAjaxBehaviorListener in interface org.ajax4jsf.component.AjaxClientBehaviorpublic void removeAjaxBehaviorListener(javax.faces.event.AjaxBehaviorListener listener)
removeAjaxBehaviorListener in interface org.ajax4jsf.component.AjaxClientBehaviorpublic void broadcast(javax.faces.event.BehaviorEvent event)
throws javax.faces.event.AbortProcessingException
broadcast in interface javax.faces.component.behavior.Behaviorbroadcast in class javax.faces.component.behavior.BehaviorBasejavax.faces.event.AbortProcessingExceptionpublic void restoreState(javax.faces.context.FacesContext context,
Object state)
restoreState in interface javax.faces.component.StateHolderrestoreState in class ClientBehaviorpublic Object saveState(javax.faces.context.FacesContext context)
saveState in interface javax.faces.component.StateHoldersaveState in class ClientBehaviorCopyright © 2012 JBoss by Red Hat. All Rights Reserved.