|
RichFaces UI Components UI 4.3.0.CR1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.behavior.BehaviorBase
javax.faces.component.behavior.ClientBehaviorBase
org.richfaces.component.behavior.ClientBehavior
org.ajax4jsf.component.behavior.AjaxBehavior
public class AjaxBehavior
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.
Field Summary | |
---|---|
static String |
BEHAVIOR_ID
|
Constructor Summary | |
---|---|
AjaxBehavior()
|
Method Summary | |
---|---|
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)
|
Methods inherited from class org.richfaces.component.behavior.ClientBehavior |
---|
compare, getFacesContext, getStateHelper, getValueExpression, setLiteralValue, setValueExpression |
Methods inherited from class javax.faces.component.behavior.ClientBehaviorBase |
---|
decode, getRenderer, getScript |
Methods inherited from class javax.faces.component.behavior.BehaviorBase |
---|
addBehaviorListener, clearInitialState, initialStateMarked, isTransient, markInitialState, removeBehaviorListener, setTransient |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface javax.faces.component.behavior.ClientBehavior |
---|
decode, getScript |
Field Detail |
---|
public static final String BEHAVIOR_ID
Constructor Detail |
---|
public AjaxBehavior()
Method Detail |
---|
public void setLiteralAttribute(String name, Object value)
setLiteralAttribute
in class ClientBehavior
public Object getData()
getData
in interface org.ajax4jsf.component.AjaxClientBehavior
public void setData(Object data)
setData
in interface org.ajax4jsf.component.AjaxClientBehavior
public Collection<String> getExecute()
getExecute
in interface org.ajax4jsf.component.AjaxClientBehavior
public void setExecute(Collection<String> execute)
setExecute
in interface org.ajax4jsf.component.AjaxClientBehavior
public String getOnbeforedomupdate()
getOnbeforedomupdate
in interface org.ajax4jsf.component.AjaxClientBehavior
public void setOnbeforedomupdate(String onbeforedomupdate)
setOnbeforedomupdate
in interface org.ajax4jsf.component.AjaxClientBehavior
public String getOnbegin()
getOnbegin
in interface org.ajax4jsf.component.AjaxClientBehavior
public void setOnbegin(String onbegin)
setOnbegin
in interface org.ajax4jsf.component.AjaxClientBehavior
public String getOnbeforesubmit()
getOnbeforesubmit
in interface org.ajax4jsf.component.AjaxClientBehavior
public void setOnbeforesubmit(String onbeforesubmit)
setOnbeforesubmit
in interface org.ajax4jsf.component.AjaxClientBehavior
public String getOncomplete()
getOncomplete
in interface org.ajax4jsf.component.AjaxClientBehavior
public void setOncomplete(String oncomplete)
setOncomplete
in interface org.ajax4jsf.component.AjaxClientBehavior
public String getOnerror()
getOnerror
in interface org.ajax4jsf.component.AjaxClientBehavior
public void setOnerror(String onerror)
setOnerror
in interface org.ajax4jsf.component.AjaxClientBehavior
public String getQueueId()
getQueueId
in interface org.ajax4jsf.component.AjaxClientBehavior
public void setQueueId(String queueId)
setQueueId
in interface org.ajax4jsf.component.AjaxClientBehavior
public Collection<String> getRender()
getRender
in interface org.ajax4jsf.component.AjaxClientBehavior
public void setRender(Collection<String> render)
setRender
in interface org.ajax4jsf.component.AjaxClientBehavior
public String getStatus()
getStatus
in interface org.ajax4jsf.component.AjaxClientBehavior
public void setStatus(String status)
setStatus
in interface org.ajax4jsf.component.AjaxClientBehavior
public boolean isDisabled()
isDisabled
in interface org.ajax4jsf.component.AjaxClientBehavior
public void setDisabled(boolean disabled)
setDisabled
in interface org.ajax4jsf.component.AjaxClientBehavior
public boolean isLimitRender()
isLimitRender
in interface org.ajax4jsf.component.AjaxClientBehavior
public void setLimitRender(boolean limitRender)
setLimitRender
in interface org.ajax4jsf.component.AjaxClientBehavior
public 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.ClientBehaviorBase
public Set<javax.faces.component.behavior.ClientBehaviorHint> getHints()
getHints
in interface javax.faces.component.behavior.ClientBehavior
getHints
in class javax.faces.component.behavior.ClientBehaviorBase
public void addAjaxBehaviorListener(javax.faces.event.AjaxBehaviorListener listener)
addAjaxBehaviorListener
in interface org.ajax4jsf.component.AjaxClientBehavior
public void removeAjaxBehaviorListener(javax.faces.event.AjaxBehaviorListener listener)
removeAjaxBehaviorListener
in interface org.ajax4jsf.component.AjaxClientBehavior
public void broadcast(javax.faces.event.BehaviorEvent event) throws javax.faces.event.AbortProcessingException
broadcast
in interface javax.faces.component.behavior.Behavior
broadcast
in class javax.faces.component.behavior.BehaviorBase
javax.faces.event.AbortProcessingException
public void restoreState(javax.faces.context.FacesContext context, Object state)
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class ClientBehavior
public Object saveState(javax.faces.context.FacesContext context)
saveState
in interface javax.faces.component.StateHolder
saveState
in class ClientBehavior
|
RichFaces UI Components UI 4.3.0.CR1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |