JBoss.orgCommunity Documentation
The component for ordered lists rendering that allows choosing data from a model and obtains built-in support of Ajax updates.
A completely skinned list and child elements
Possibility to update a limited set of rows with Ajax
Possibility to receive values dynamically from a model
Table 6.75. rich : dataOrderedList attributes
Table 6.76. Component identification parameters
Name | Value |
---|---|
component-type | org.richfaces.DataOrderedList |
component-class | org.richfaces.component.html.HtmlDataOrderedList |
component-family | org.richfaces.DataOrderedList |
renderer-type | org.richfaces.DataOrderedListRenderer |
tag-class | org.richfaces.taglib.DataOrderedListTag |
To create the simplest variant of dataOrderedList on a page, use the following syntax:
Example:
...
<rich:dataOrderedList var="car" value="#{dataTableScrollerBean.allCars}" >
<h:outputText value="#{car.model}"/>
</rich:dataOrderedList>
...
Example:
import org.richfaces.component.html.HtmlDataOrderedList;
...
HtmlDataOrderedList myList = new HtmlDataOrderedList();
...
The <rich:dataOrderedList> component allows to generate an ordered list from a model.
The component has the "type" attribute, which corresponds to the "type" parameter for the <OL> HTML element and defines a marker type. Possible values for "type" attribute are: "A", "a", "I", "i", "1".
Here is an example:
...
<h:form>
<rich:dataOrderedList var="car" value="#{dataTableScrollerBean.allCars}" rows="5" type="1" title="Car Store">
<h:outputText value="#{car.make} #{car.model}"/><br/>
<h:outputText value="Price:" styleClass="label"></h:outputText>
<h:outputText value="#{car.price}" /><br/>
<h:outputText value="Mileage:" styleClass="label"></h:outputText>
<h:outputText value="#{car.mileage}" /><br/>
</rich:dataOrderedList>
</h:form>
...
This is a result:
In the example the "rows" attribute limits number of output elements of the list.
"first" attribute defines first element for output. "title" are used for popup title.
The component was created basing on the <a4j:repeat> component and as a result it could be partially updated with Ajax. "ajaxKeys" attribute allows to define row keys that are updated after an Ajax request.
Here is an example:
Example:
...
<rich:dataOrderedList value="#{dataTableScrollerBean.allCars}" var="car" ajaxKeys="#{listBean.list}"
binding="#{listBean.dataList}" id="list">
...
</rich:dataOrderedList>
...
<a4j:commandButton action="#{listBean.action}" reRender="list" value="Submit"/>
...
In the example "reRender" attribute contains value of "id" attribute for <rich:dataOrderedList> component. As a result the component is updated after an Ajax request.
For skinnability implementation, the components use a style class redefinition method. Default style classes are mapped on skin parameters.
There are two ways to redefine the appearance of all <rich:dataOrderedList> components at once:
Redefine the corresponding skin parameters
Add to your style sheets style classes used by a <rich:dataOrderedList> component
On the screenshot there are classes names that define styles for component elements.
Table 6.77. Classes names that define a list appearance
Class name | Description |
---|---|
rich-orderedlist | Defines styles for an html <ol> element |
rich-list-item | Defines styles for an html <li> element |
In order to redefine styles for all <rich:dataOrderedList> components on a page using CSS, it's enough to create classes with the same names (possible classes could be found in the tables above ) and define necessary properties in them.
Example:
...
.rich-orderedlist{
background-color: #ebf3fd;
}
...
This is a result:
In the example background color was changed.
Also it's possible to change styles of particular <rich:dataOrderedList> component. In this case you should create own style classes and use them in corresponding <rich:dataOrderedList> styleClass attributes. An example is placed below:
Example:
...
.myClass{
font-style: italic;
}
...
Example:
<rich:dataOrderedList ... styleClass="myClass"/>
This is a result:
As it could be seen on the picture above, the font style was changed.
On the component LiveDemo page you can see the example of <rich:dataOrderedList > usage and sources for the given example.