Create new RichFaces Documentation Jira issue
This will launch the RichFaces Jira page - to complete your feedback please login if needed, and submit the Jira.
JBoss.orgCommunity Documentation
The <a4j:status> component generates elements for displaying of the current Ajax requests status. There are two status modes: Ajax request is in process or finished.
There are two ways for the components or containers definition, which Ajax requests status is tracked by a component.
Definition with the "for" attribute on the <a4j:status> component. Here "for" attribute should point at an Ajax container ( <a4j:region> ) id, which requests are tracked by a component.
Definition with the "status" attribute obtained by any RichFaces library action component. The attribute should point at the <a4j:status> component id. Then this <a4j:status> component shows the status for the request fired from this action component.
The component creates two <span> or <div> elements depending on attribute "layout" with content defined for each status, one of the elements (start) is initially hidden. At the beginning of an Ajax request, elements state is inversed, hence the second element is shown and the first is hidden. At the end of a response processing, elements display states return to its initial values.
Example:
<a4j:status startText="Started" stopText="stopped" />
The code shown in the example above is decoded on a page as:
<span id="j_id20:status.start" style="display: none">
Started
</span>
<span id="j_id20:status.stop">
Stopped
</span>
and after the generation of an Ajax response is changed to:
<span id="j_id20:status.start">
Started
</span>
<span id="j_id20:status.stop" style="display: none">
Stopped
</span>
There is a possibility to group a <a4j:status> elements content into <div> elements, instead of <span> . To use it, just redefine the "layout" attribute from "inline" (default) to "block".
Table of <a4j:status> attributes.
Table 6.13. Component Identification Parameters
| Name | Value |
|---|---|
| component-type | org.ajax4jsf.Status |
| component-family | javax.faces.Panel |
| component-class | org.ajax4jsf.component.html.HtmlAjaxStatus |
| renderer-type | org.ajax4jsf.components.AjaxStatusRenderer |
Table 6.14. Facets
| Facet name | Description |
|---|---|
| start | Redefines the content for display on starting request |
| stop | Redefines the content for display on request complete |
Visit Status page at RichFaces Livedemo for examples of component usage and their sources.
Useful articles at JBoss portal:
RichFacesPleaseWaitBox describes how to show a "Please Wait" box and block the input while the Ajax request is processed using combination of <a4j:status> and <rich:modalPanel> .