Keywords: rich:separator

JBoss.org Community Documentation

- Prev
- Next

## 6.74. < rich:separator >

### 6.74.1. Description

A horizontal line to use as a separator in a layout. The line type can be customized with the "lineType" parameter.

Figure 6.234. <rich:separator> component

### 6.74.2. Key Features

- Highly customizable look and feel

- Leveraging layout elements creation

Table 6.413. rich : separator attributes

Attribute Name | Description
--- | ---
align | left|center|right [CI] This attribute specifies a position of the separator according to the document. Permitted values: * left: The separator is to the left of the document. * center: The separator is to the center of the document. * right: The separator is to the right of the document
binding | The attribute takes a value-binding expression for a component property of a backing bean
height | The separator height. Default value is "6px".
id | Every component may have a unique id that is automatically created if omitted
lineType | A line type. The possible values are "beveled" (default), "dotted", "dashed", "double", "solid" and "none".
onclick | HTML: a script expression; a pointer button is clicked
ondblclick | HTML: a script expression; a pointer button is double-clicked
onkeydown | HTML: a script expression; a key is pressed down
onkeypress | HTML: a script expression; a key is pressed and released
onkeyup | HTML: a script expression; a key is released
onmousedown | HTML: script expression; a pointer button is pressed down
onmousemove | HTML: a script expression; a pointer is moved within
onmouseout | HTML: a script expression; a pointer is moved away
onmouseover | HTML: a script expression; a pointer is moved onto
onmouseup | HTML: script expression; a pointer button is released
rendered | If "false", this component is not rendered
style | CSS style(s) is/are to be applied when this component is rendered
styleClass | Corresponds to the HTML class attribute
title | HTML: An advisory title for this element. Often displayed as a tooltip
width | The separator width that can be defined in pixels or in percents. Default value is "100%".

Table 6.414. Component identification parameters

Name | Value
--- | ---
component-type | org.richfaces.separator
component-class | org.richfaces.component.html.HtmlSeparator
component-family | org.richfaces.separator
renderer-type | org.richfaces.SeparatorRenderer
tag-class | org.richfaces.taglib.SeparatorTag

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

Here is a simple example as it could be used on a page:

Example:

    ...

        <rich:separator/>

    ...

### 6.74.4. Creating the Component Dynamically Using Java

Example:

    import org.richfaces.component.html.HtmlSeparator;

    ...

    HtmlSeparator mySeparator = new HtmlSeparator();

    ...

### 6.74.5. Details of Usage

<rich:separator> is a simple layout component which represents a separator stylized as a skin. Thus, the main attributes that define its style are "style" and "styleClass". In addition there are width and height attributes that should be specified in pixels.

The line type can be customized with the "lineType" parameter. For example, different line types are shown after rendering with the following initial settings lineType="double" and "lineType="solid".

Figure 6.235. Different line types of <rich:separator>

Except style attributes, there are also event definition attributes.

- onmouseover

- onclick

- onmouseout

- etc.

### 6.74.6. Look-and-Feel Customization

For skinnability implementation, the components use a style class redefinition method.

To redefine the appearance of all <rich:separator> components at once, you should add to your style sheets the style class used by a <rich:separator> component.

### 6.74.7. Definition of Custom Style Classes

Table 6.415. Classes names that define a component appearance

Class name | Description
--- | ---
rich-separator | Defines styles for a component appearance

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

        background-color:#ff7700;

    }

    ...

This is a result:

Figure 6.236. Redefinition styles with predefined classes

In the example background color for separator was changed.

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

Example:

    ...

    .myClass{

        background-color:#ffead9;

    }

    ...

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

Example:

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

This is a result:

Figure 6.237. Redefinition styles with own classes and styleClass attributes

As it could be seen on the picture above,background color for separator was changed.

### 6.74.8. Relevant Resources Links

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

- Prev6.73. < rich:scrollableDataTable > ...
- Top of page
- Front page
- Next6.75. < rich:simpleTogglePanel >