rich:dataOrderedList HtmlDataOrderedList ordered list

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

## Creating the Component with a Page Tag

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>
    ...

## Creating the Component Dynamically Using Java

Example:

    import org.richfaces.component.html.HtmlDataOrderedList;
    ...
    HtmlDataOrderedList myList = new HtmlDataOrderedList();
    ...

## Details of Usage

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:

Component usage

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.

## Look-and-Feel Customization

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

## Definition of Custom Style Classes

On the screenshot there are classes names that define styles for component elements.

Style classes

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 and define necessary properties in them.

To change styles of particular <rich:dataOrderedList> components, define your own style classes in the corresponding <rich:dataOrderedList> attributes.

## Relevant Resources Links

Here you can see the example of <rich:dataOrderedList > usage and sources for the given example.