bar rich:toolBar HtmlToolBar

Component identification parameters

Name | Value
--- | ---
component-type | org.richfaces.ToolBar
component-class | org.richfaces.component.html.HtmlToolBar
component-family | org.richfaces.ToolBar
renderer-type | org.richfaces.ToolBarRenderer
tag-class | org.richfaces.taglib.ToolBarTag

## Creating the Component with a Page Tag

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

Example:

    ...
        <rich:toolBar>
            <!--//...Set of action or other JSF components-->
        </rich:toolBar>
    ...

## Creating the Component Dynamically Using Java

Example:

    import org.richfaces.component.html.HtmlToolBar;
    ...
    HtmlToolBar myToolBar = new HtmlToolBar();
    ...

## Details of Usage

A toolBar is a wrapper component that facilitates creation of menu and tool bars. All components defined inside are located on a stylized bar with possibility to group, arrange on the both bar sides, and place predefined separators between them.

Grouping and an input side definition is described for toolBarGroup that defines this functionality.

Separators are located between components with the help of the "itemSeparator" attribute with four predefined values:

- "none"

- "line"

- "square"

- "disc"

For example, when setting a separator of a disc type, the following result is produced:

<rich:toolBar> with a "disc" separator

Moreover, for toolBar style "width" and "height" attributes are placed above all.

A custom separator can be added with the help of "itemSeparator" facet.

Example:

    ...
    <f:facet name="itemSeparator">
        <rich:separator width="2" height="14" />
    </f:facet>
    ...

Custom separator can be also specified by URL to the separator image in the attribute "itemSeparator" of the <rich:toolBar>.

Example:

    ...
    <rich:toolBar id="toolBar" width="#{bean.width}" height="#{bean.height}" itemSeparator="/images/separator_img.jpg"/>
    ...

This is a result:

<rich:toolBar> with "itemSeparator" attribute.

As it could be seen in the picture above, the image for itemSeparator was changed.

## Facets

Facets

Facet name | Description
--- | ---
itemSeparator | Defines the custom separator. Related attribute is "itemSeparator"

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

- Redefine the corresponding skin parameters

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

## Skin Parameters Redefinition

Skin parameters redefinition for a component exterior

Skin parameters | CSS properties
--- | ---
panelBorderColor | border-color
headerBackgroundColor | background-color

Skin parameters redefinition for a component item

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

## Definition of Custom Style Classes

Classes names that define a component appearance

Class name | Description
--- | ---
rich-toolbar | Defines styles for a toolbar element
rich-toolbar-item | Defines styles for a toolbar item

Classes names

In order to redefine styles for all <rich:toolBar> 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-toolbar-item{
        font-weight:bold;
    }
    ...

This is a result:

Redefinition styles with predefined classes

In the example font weight for items was changed.

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

Example:

    ...
    .myClass{
        font-style:italic;
        font-weight:bold;
    }
    ...

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

Example:

    <rich:toolBar ... styleClass="myClass"/>

This is a result:

Redefinition styles with own classes and styleClass attributes

As it could be seen on the picture above,the font style and the font weight for items was changed.

The component also has the standard attributes "style" and "styleClass" that could redefine an appearance of a particular component variants.

## Relevant Resources Links

On the component LiveDemo page you can see the example of <rich:toolBar> usage and sources for the given example.