JBoss.orgCommunity Documentation

6.35.  < rich:column >

The component for row rendering for a UIData component.


Table 6.127. rich : column attributes

Attribute NameDescription
bindingThe attribute takes a value-binding expression for a component property of a backing bean
breakBeforeif "true" next column begins from the first row
colspanCorresponds to the HTML colspan attribute
comparatorDefines value binding to the comparator that is used to compare the values
dirDirection indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left)
filterByDefines iterable object property which is used when filtering performed.
filterEventEvent for filter input that forces the filtration (default value is "onchange")
filterExpressionAttribute defines a bean property which is used for filtering of a column
filterMethodThis attribute is defined with method binding. This method accepts on Object parameter and return boolean value
filterValueDefines current filtering value
footerClassSpace-separated list of CSS style class(es) that are be applied to any footer generated for this table
headerClassSpace-separated list of CSS style class(es) that are be applied to any header generated for this table
idEvery component may have a unique id that is automatically created if omitted
labelColumn label for drag indicator. Usable only for extendedDataTable component
langCode describing the language used in the generated markup for this component
renderedIf "false", this component is not rendered
rowspanCorresponds to the HTML rowspan attribute
selfSortedManages if the header of the column is clickable, icons rendered and sorting is fired after click on the header. You need to define this attribute inside <rich:dataTable> component
sortableBoolean attribute. If "true" it's possible to sort the column content after click on the header. Default value is "true"
sortByAttribute defines a bean property which is used for sorting of a column
sortExpressionDEPRECATED(use sortBy)Attribute defines a bean property which is used for sorting of a column
sortIconDefines sort icon
sortIconAscendingDefines sort icon in ascending order
sortIconDescendingDefines sort icon in descending order
sortOrderSortOrder is an enumeration of the possible sort orderings.
styleCSS style(s) is/are to be applied when this component is rendered
styleClassCorresponds to the HTML class attribute
titleAdvisory title information about markup elements generated for this component
visibleThe attribute is used to define whether the component is visible or not. The default value is "true".
widthAttribute defines width of column.

Table 6.128. Component identification parameters

NameValue
component-typeorg.richfaces.Column
component-classorg.richfaces.component.html.HtmlColumn
component-familyorg.richfaces.Column
renderer-typeorg.richfaces.ColumnRenderer
tag-classorg.richfaces.taglib.ColumnTag

To create the simplest variant of column on a page, use the following syntax:

Example:


...
    <rich:dataTable var="set">
        <rich:column>
            <h:outputText value="#{set.property1}"/>
        </rich:column>
        <!--Set of another columns and header/footer facets-->
    </rich:dataTable>
...

Example:

import org.richfaces.component.html.HtmlColumn;

...
HtmlColumn myColumn = new HtmlColumn();
...

To output a simple table, the <rich:column> component is used the same way as the standard <h:column> , i.e. the following code on a page is used:

Example:


...
    <rich:dataTable value="#{capitalsBean.capitals}" var="cap" rows="5"> 
        <rich:column>
            <f:facet name="header">State Flag</f:facet>
            <h:graphicImage value="#{cap.stateFlag}"/>
        </rich:column>
        <rich:column>
            <f:facet name="header">State Name</f:facet>
            <h:outputText value="#{cap.state}"/>
        </rich:column>
        <rich:column >
            <f:facet name="header">State Capital</f:facet>
            <h:outputText value="#{cap.name}"/>
        </rich:column>
        <rich:column>
        <f:facet name="header">Time Zone</f:facet>
            <h:outputText value="#{cap.timeZone}"/>
        </rich:column>
    </rich:dataTable>
...

The result is:


Now, in order to group columns with text information into one row in one column with a flag, use the "colspan" attribute, which is similar to an HTML one, specifying that the first column contains 3 columns. In addition, it's necessary to specify that the next column begins from the first row with the help of the breakBefore="true".

Example:


...
     <rich:dataTable value="#{capitalsBean.capitals}" var="cap" rows="5"> 
        <rich:column colspan="3">
            <h:graphicImage value="#{cap.stateFlag}"/>
        </rich:column>
        <rich:column breakBefore="true"> 
            <h:outputText value="#{cap.state}"/>
        </rich:column>
        <rich:column >
            <h:outputText value="#{cap.name}"/>
        </rich:column>
        <rich:column>
            <h:outputText value="#{cap.timeZone}"/>
        </rich:column>
    </rich:dataTable>
...

As a result the following structure is rendered:


The same way is used for columns grouping with the "rowspan" attribute that is similar to an HTML one responsible for rows quantity definition occupied with the current one. The only thing to add in the example is an instruction to move onto the next row for each next after the second column.

Example:


...
    <rich:dataTable value="#{capitalsBean.capitals}" var="cap" rows="5"> 
        <rich:column rowspan="3">
            <f:facet name="header">State Flag</f:facet>
            <h:graphicImage value="#{cap.stateFlag}"/>
        </rich:column>
        <rich:column> 
            <f:facet name="header">State Info</f:facet>
            <h:outputText value="#{cap.state}"/>
        </rich:column>
        <rich:column breakBefore="true">
            <h:outputText value="#{cap.name}"/>
        </rich:column>
        <rich:column breakBefore="true">
            <h:outputText value="#{cap.timeZone}"/>
        </rich:column>
    </rich:dataTable>
...

As a result:


Hence, additionally to a standard output of a particular row provided with the <h:column> component, it becomes possible to group easily the rows with special HTML attribute.

The columns also could be grouped in a particular way with the help of the <h:columnGroup> component that is described in the following chapter.

Here you can find additional information about dynamic columns.

In order to sort the columns you should use "sortBy" attribute that indicates what values to be sorted. In order to sort the column you should click on its header. See the following example.

Example:


...
<h:form>
    <rich:dataTable value="#{capitalsBean.capitals}" var="cap" width="300px">
        <f:facet name="header">
            <h:outputText value="Sorting Example"/>
        </f:facet>
        <rich:column sortBy="#{cap.state}">
            <f:facet name="header">
                <h:outputText value="State Name"/>
            </f:facet>
            <h:outputText value="#{cap.state}"/>
        </rich:column> 
        <rich:column sortBy="#{cap.name}">
            <f:facet name="header">
                <h:outputText value="State Capital"/>
            </f:facet>
            <h:outputText value="#{cap.name}"/> 
        </rich:column>
    </rich:dataTable>
</h:form>
...

This is result:


The "selfSorted" attribute that would add the possibility of automatic sorting by clicking the column header. Default value is "true". In the example below the second column is unavailable for sorting.

Example:


...
<rich:dataTable value="#{capitalsBean.capitals}" var="cap">
        <rich:column>
                <f:facet name="header">
                        <h:outputText value="State Flag"/>
                </f:facet>
                <h:graphicImage value="#{cap.stateFlag}"/> 
        </rich:column>
        <rich:column sortBy="#{cap.state}" selfSorted="false"> 
                <f:facet name="header">
                        <h:outputText value="State Name"/>
                </f:facet>
                <h:outputText value="#{cap.state}"/>
        </rich:column> 
</rich:dataTable>
...

"sortOrder" attribute is used for changing the sorting of columns by means of external controls.

Possible values are:

  • "ASCENDING" - column is sorted in ascending

  • "DESCENDING" - column is sorted in descending

  • "UNSORTED" - column isn't sorted

Example:


...
<h:form>
    <rich:dataTable value="#{capitalsBean.capitals}" var="cap" width="300px">
        <f:facet name="header">
            <h:outputText value="Sorting Example"/>
        </f:facet>
        <rich:column sortBy="#{cap.state}" sortOrder="ASCENDING">
            <f:facet name="header">
                <h:outputText value="State Name"/>
            </f:facet>
            <h:outputText value="#{cap.state}"/>
        </rich:column> 
        <rich:column sortBy="#{cap.name}" sortOrder="DESCENDING">
            <f:facet name="header">
                <h:outputText value="State Capital"/>
            </f:facet>
            <h:outputText value="#{cap.name}"/> 
        </rich:column>
    </rich:dataTable>
</h:form>
...

Below you can see the result:


In the example above the first column is sorted in descending order. But if recurring rows appear in the table the relative second column are sorted in ascending order.

You can customize the sorting's icon element using "rich-sort-icon" class.

The "sortPriority" attribute defines a set of column ids in the order the columns could be set.

If the columns sort order changed externally sort priorities could be used to define which columns will be sorted first.

The "sortable" attribute which is used with <rich:scrollableDataTable> component. In the following example only the first column could be sorted.

Example:


...
<rich:scrollableDataTable rowKeyVar="rkv" frozenColCount="1"
        id="carList" columnClasses="col" value="#{dataTableScrollerBean.allCars}" var="category" 
        sortMode="single" binding="#{dataTableScrollerBean.table}"
        selection="#{dataTableScrollerBean.selection}">
        <rich:column id="make" sortable="true">
                <f:facet name="header">
                        <h:outputText styleClass="headerText" value="Make"/>
                </f:facet>
                <h:outputText value="#{category.make}"/>
        </rich:column>
        <rich:column id="model">
                <f:facet name="header">
                        <h:outputText styleClass="headerText" value="Model"/>
                </f:facet>
                <h:outputText value="#{category.model}"/>
        </rich:column>
        <rich:column id="price">
                <f:facet name="header">
                        <h:outputText styleClass="headerText" value="Price"/>
                </f:facet>
                <h:outputText value="#{category.price}"/>
        </rich:column>
</rich:scrollableDataTable>
...

"sortExpression" attribute defines a bean property which is used for sorting of a column.

There are two ways to filter the column value:

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:column> components at once:

Skin parameters redefinition for <rich:column> are the same as for the <rich:dataTable> component.

Custom style classes for <rich:column> are the same as for the <rich:dataTable> component.

In order to redefine styles for all <rich:column> 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-table-cell{
        
font-style: italic; 
}    
...

This is a result:


In the example cells font style was changed.

Also it's possible to change styles of particular <rich:column> component. In this case you should create own style classes and use them in corresponding <rich:column> styleClass attributes. An example is placed below:

Example:


...
.myClass{
        
font-weight: bolder;
}
...

The "styleClass" attribute for <rich:column> is defined as it's shown in the example below:

Example:


<rich:column styleClass="myClass">

This is a result:


As it could be seen on the picture above, the font weight for second column was changed.

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