Send your remarks, comments or wishes to doc team
Subject:
Message:
Your name:
Your email:

JBoss.org Community Documentation

- Prev
- Next

## 6.74. < rich:panelBarItem >

### 6.74.1. Description

panelBarItem is used for grouping any content inside within one panelBar which is loaded on client side and appears as groups divided on child panels after header is clicked.

Figure 6.213. <rich:panelBarItem> component

### 6.74.2. Key Features

- Highly customizable look and feel

- Groups any content inside each Panels

Table 6.403. rich : panelBarItem attributes

Attribute Name | Description
--- | ---
binding | The attribute takes a value-binding expression for a component property of a backing bean
contentClass | The component content style class
contentStyle | The component content style
headerClass | The component header style class
headerClassActive | The component header style class active
headerStyle | The component header style
headerStyleActive | The component header style active
id | Every component may have a unique id that is automatically created if omitted
label | Label text appears on a panel item header
name | Attribute defines item name. Default value is "getId()".
onenter | Event must occurs on than item has been entered
onleave | Event must occurs on than item has been leaved
rendered | If "false", this component is not rendered

Table 6.404. Component identification parameters

Name | Value
--- | ---
component-type | org.richfaces.PanelBarItem
component-class | org.richfaces.component.html.HtmlPanelBarItem
component-family | org.richfaces.PanelBarItem
renderer-type | org.richfaces.PanelBarItemRenderer
tag-class | org.richfaces.taglib.PanelBarItemTag

### 6.74.3. Creating the Component with a Page Tag

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

Example:

    ...

        <rich:panelBar>

            <rich:panelBarItem label="Canon">

                ...

            </rich:panelBarItem>

            <rich:panelBarItem label="Nikon">

                ...

            </rich:panelBarItem>

        </rich:panelBar>

    ...

### 6.74.4. Creating the Component Dynamically Using Java

Example:

    import org.richfaces.component.html.HtmlPanelBarItem;

    ...

    HtmlPanelBarItem myBarItem = new HtmlPanelBarItem();

    ...

### 6.74.5. Details of Usage

The "label" attribute defines text to be represented. If you can use the "label" facet, you can even not use the "label" attribute.

Example:

    ...

        <rich:panelBarItem...>

            <f:facet name="label">

                <h:graphicImage value="/images/img1.png"/>

            </f:facet>

            ...

            <!--Any Content inside-->

            ...

        </rich:panelBarItem>

    ...

As it was mentioned above, panelBarItem is used for grouping any content inside within one panelBar, thus its customization deals only with specification of sizes and styles for rendering.

panelBar could contain any number of child panelBarItem components inside, which content is uploaded onto the client and headers are controls to open the corresponding child element.

### 6.74.6. Facets

Table 6.405. Facets

Facet name | Description
--- | ---
label | defines the label text on the panel item header

### 6.74.7. 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:panelBarItem> components at once:

- Redefine the corresponding skin parameters

- Add to your style sheets style classes used by a <rich:panelBarItem> component

### 6.74.8. Skin Parameters Redefinition

Table 6.406. Skin parameters redefinition for a content

Skin parameters | CSS properties
--- | ---
generalTextColor | color
preferableDataSizeFont | font-size
preferableDataFamilyFont | font-family

Table 6.407. Skin parameters redefinition for a header element (active or inactive)

Skin parameters | CSS properties
--- | ---
headerTextColor | color
headerBackgroundColor | background-color
headerSizeFont | font-size
headerWeightFont | font-weight
headerFamilyFont | font-family

### 6.74.9. Definition of Custom Style Classes

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

Figure 6.214. Style classes

Table 6.408. Classes names that define a component appearance

Class name | Class description
--- | ---
rich-panelbar-header | Defines styles for a wrapper <div> element of a header element
rich-panelbar-header-act | Defines styles for a wrapper <div> element of an active header element
rich-panelbar-content | Defines styles for a content

Table 6.409. Style component classes

A class attribute | A component element defined by an attribute
--- | ---
headerClass | Applicable to a header element
contentClass | Applicable to a content

In order to redefine styles for all <rich:panelBarItem> 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-panelbar-content{

            background-color: #ecf4fe;

    }

    ...

This is a result:

Figure 6.215. Redefinition styles with predefined classes

In the example a content background color was changed.

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

Example:

    ...

    .myClass{

      font-family: monospace;

    }

    ...

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

Example:

    <rich:panelBarItem ... headerClass="myClass"/>

This is a result:

Figure 6.216. Redefinition styles with own classes and styleClass attributes

As it could be seen on the picture above, the font family for header of active item was changed.

- Prev6.73. < rich:panelBar >
- Top of page
- Front page
- Next6.75. < rich:panelMenu >