6.12.1. < rich:listShuttle > available since 3.1.3

### Create new RichFaces Documentation Jira issue

Summary
255 characters left
Description
Environment
This will launch the RichFaces Jira page - to complete your feedback please login if needed, and submit the Jira.

JBoss.org Community Documentation

- Prev
- Next

### 6.12.1. < rich:listShuttle > available since 3.1.3

expand all

#### 6.12.1.1. Description

The <rich:listShuttle> component is used for moving chosen items from one list into another with their optional reordering there.

Figure 6.171. <rich:ListShuttle> component

#### 6.12.1.2. Key Features

- Highly customizable look and feel

- Reordering possibility for lists items

- Multiple selection of lists items

- Keyboard support

#### 6.12.1.3. Details of Usage

The <rich:listShuttle> component consists of the following parts:

- two item lists (source and target). List consists of items. Each item has three different representations: common, selected, active

- optional caption element

- optional ordering controls set is a set of controls that performs reordering

- move controls set is a set of controls, which performs moving items between lists

## Note:

Now the listener can not be called from the column facet. This is a temporary limitation. The additional information can be found in RichFaces Jira.

The "sourceValue" attribute defines a List or Array of items to be shown in the source list.

The "targetValue" attribute defines a List or Array of items to be shown in the target list.

The "var" attribute could be shared between both Lists or Arrays to define lists on the page.

The "sourceRequired" and "targetRequired" attributes define the case when source and target values are being validated. If the value of both attributes is "true" there should be at least one item in source and target lists. Otherwise validation fails.

Example:

    ...

    <h:form id="myForm">

            <rich:messages>

                    <f:facet name="errorMarker">

                            <h:graphicImage value="/images/ajax/error.gif" />

                    </f:facet>

            </rich:messages>

            <rich:listShuttle id="myListShuttle" sourceValue="#{toolBar.freeItems}" targetValue="#{toolBar.items}"

                                    sourceRequired = "true" targetRequired = "true" var="items" converter="listShuttleconverter"

                                    sourceCaptionLabel="Source List" targetCaptionLabel="Target List">

                    <rich:column>

                            <h:graphicImage value="#{items.iconURI}" />

                    </rich:column>

                    <rich:column>

                            <h:outputText value="#{items.label}" />

                    </rich:column>

            </rich:listShuttle>

            <a4j:commandButton value="Submit" />

    </h:form>

    ...

In the example above the source list is empty. If you submit the form validation fails and error message appears on a page.

This is the result:

Figure 6.172. Style classes

The "converter" attribute is used to convert component data to a particular component's value. For example, when you select items in a list, a converter is used to format a set of objects to a strings to be displayed.

## Note

The "sourceSelection" attribute stores the collection of items selected by you in the source list. The "targetSelection" attribute stores the collection of items selected by you in the target list.

Captions could be added to a list only after it was defined as a "sourceCaption" and "targetCaption" named facets inside the component or defined with the "sourceCaptionLabel" and "targetCaptionLabel" attribute.

    ...

    <rich:listShuttle var="item" sourceValue="#{bean.source}" targetValue="#{bean.target}" sourceSelection="#{bean.sourceSelection}"

                            targetSelection="#{bean.targetSelection}" converter="listShuttleconverter">

            <f:facet name="sourceCaption">

                    <h:outputText value="Cars Store #1" />

            </f:facet>

            <f:facet name="targetCaption">

                    <h:outputText value="Cars Store #2" />

            </f:facet>

            <rich:column>

                    <h:outputText value="#{items.name}" />

            </rich:column>

    </rich:listShuttle>

    ...

The <rich:listShuttle> component provides the possibility to use ordering controls set, which performs reordering in the target item list. Every control has possibility to be disabled.

An ordering controls set could be defined with "topControlLabel" , "bottomControlLabel" , "upControlLabel" , "downControlLabel" attributes.

It is also possible to use "topControl" , "topControlDisabled" , "bottomControl" , "bottomControlDisabled" , "upControl" , "upControlDisabled" , "downControl" , "downControlDisabled" facets in order to replace the default controls with facets content.

Example:

    ...

    <rich:listShuttle var="item" sourceValue="#{bean.source}" targetValue="#{bean.target}" converter="listShuttleconverter">

            ...

            <f:facet name="topControl">

                    <h:outputText value="Move to top" />

            </f:facet>

            <f:facet name="upControl">

                    <h:outputText value="Move up" />

            </f:facet>

            <f:facet name="downControl">

                    <h:outputText value="Move down" />

            </f:facet>

            <f:facet name="bottomControl">

                    <h:outputText value="Move to bottom" />

            </f:facet>

    </rich:listShuttle>

    ...

The <rich:listShuttle> component also provides 4 predefined controls in move controls set for moving items between source and target lists. Every control has possibility to be disabled.

A move controls set could be defined with "copyControlLabel" , "removeControlLabel" , "copyAllControlLabel" , "removeAllControlLabel" attributes.

It is also possible to use "copyControl" , "removeControl" , "copyAllControl" , "removeAllControl" facets in order to replace the default controls with facets content.

    ...

    <rich:listShuttle var="item" sourceValue="#{bean.source}" targetValue="#{bean.target}" converter="listShuttleconverter"

                            copyControlLabel="Copy" removeControlLabel="Remove"

                            copyAllControlLabel="Copy all" removeAllControlLabel="Remove all">

            <h:column>

                    <f:facet name="header">

                            <h:outputText value="Cars" />

                    </f:facet>

                    <h:outputText value="#{item.name}" />

            </h:column>

    </rich:listShuttle>

    ...

Controls rendering is based on the "controlsType" attribute. Possible types are button and none.

## Note

Currently the button controls type is based on <div> element.

The <rich:listShuttle> component allows to use internationalization method to redefine and localize the labels. You could use application resource bundle and define `RICH_SHUTTLES_TOP_LABEL`, `RICH_SHUTTLES_BOTTOM_LABEL`, `RICH_SHUTTLES_UP_LABEL`, `RICH_SHUTTLES_DOWN_LABEL` `RICH_LIST_SHUTTLE_COPY_ALL_LABEL`, `RICH_LIST_SHUTTLE_COPY_LABEL`, `RICH_LIST_SHUTTLE_REMOVE_ALL_LABEL`, `RICH_LIST_SHUTTLE_REMOVE_LABEL` there.

You could also pack `org.richfaces.renderkit.listShuttle` resource bundle with your JARs defining the same properties.

Table 6.206. Keyboard usage for elements selection

Keys and combinations | Description
--- | ---
CTRL+click | Inverts selection for an item
SHIFT+click | Selects all rows from active one to a clicked row if they differ, else select the actve row. All other selections are cleared
CTRL+A | Selects all elements inside the list if some active element is already present in a list
Up, Down arrows | Changes the active element to the next or previous in a list and make it the only selected. Scroll follows the selection to keep it visible

Table 6.207. Keyboard usage for elements reordering

Keys and combinations | Description
--- | ---
Home | Moves selected set to the top of a list (for target list only)
End | Moves selected set to the bottom of a list (for target list only)
CTRL+Up arrow | Moves selected item to one position upper
CTRL+Down arrow | Moves selected item to one position lower

#### 6.12.1.4. Reference Data

Table of <rich:listShuttle> attributes.

Table 6.208. Component Identification Parameters

Name | Value
--- | ---
component-type | org.richfaces.ListShuttle
component-class | org.richfaces.component.html.HtmlListShuttle
component-family | org.richfaces.ListShuttle
renderer-type | org.richfaces.ListShuttleRenderer
tag-class | org.richfaces.taglib.ListShuttleTag

Table 6.209. JavaScript API

Function | Description
--- | ---
enable() | Enables ordering control (to be implemented)
disable() | Disables ordering control (to be implemented)
isEnabled() | Checks if current control is enabled (to be implemented)
up() | Moves up selected item in the list
down() | Moves down selected item in the list
top() | Moves top selected item in the list
bottom() | Moves bottom selected item in the list
copy() | Copies selected item from the source list to the target list
remove() | Removes selected item from the target list to the source list
copyAll() | Copies all items from the source list to the target list
removeAll() | Removes all items from the target list to the source list
getSelection() | Returns currently selected item (to be implemented)
getItems() | Returns the collection of all items (to be implemented)

Table 6.210. Facets

Facet | Description
--- | ---
copyAllControl | Redefines the label content for the "copyAll" control. Related attribute is "copyAllControlLabel"
removeAllControl | Redefines the label content for the "removeAll" control. Related attribute is "removeAllControlLabel"
copyControl | Redefines the label content for the "copy" control. Related attribute is "copyControlLabel"
removeControl | Redefines the label content for the "remove" control. Related attribute is "removeControlLabel"
copyAllControlDisabled | Redefines the disabled label content for the "copyAll" control
removeAllControlDisabled | Redefines the disabled label content for the "removeAll" control
caption | Redefines the caption control
sourceCaption | Defines source list caption representation text. Related attribute is "sourceCaptionLabel"
targetCaption | Defines source list target representation text. Related attribute is "targetCaptionLabel"

Table 6.211. Classes names that define a list representation

Class name | Description
--- | ---
rich-list-shuttle | Defines styles for a wrapper table element of a listShuttle
rich-list-shuttle-caption | Defines styles for a list caption
rich-shuttle-body | Defines styles for a list body
rich-shuttle-list-content | Defines styles for a list content
rich-shuttle-source-items | Defines styles for a wrapper <div> element for source list
rich-shuttle-target-items | Defines styles for a wrapper <div> element for target list
rich-shuttle-list-header | Defines styles for a lists header
rich-shuttle-header-tab-cell | Defines styles for a header cell

Table 6.212. Classes names that define a caption representations in a source and target lists

Class name | Description
--- | ---
rich-shuttle-source-caption | Defines styles for a caption in a source list
rich-shuttle-target-caption | Defines styles for a caption in a target list

Table 6.213. Classes names that define a rows representations in a source list

Class name | Description
--- | ---
rich-shuttle-source-row | Defines styles for a row in a source list
rich-shuttle-source-row-selected | Defines styles for a selected row in a source list
rich-shuttle-source-row-active | Defines styles for an active row in a source list

Table 6.214. Classes names that define a rows representations in a target list

Class name | Description
--- | ---
rich-shuttle-target-row | Defines styles for a row in a target list
rich-shuttle-target-row-selected | Defines styles for a selected row in a target list
rich-shuttle-target-row-active | Defines styles for an active row in a target list

Table 6.215. Classes names that define a cells representations in a source list

Class name | Description
--- | ---
rich-shuttle-source-cell | Defines styles for a cell in a source list
rich-shuttle-source-cell-selected | Defines styles for a selected cell in a source list
rich-shuttle-source-cell-active | Defines styles for an active cell in a source list

Table 6.216. Classes names that define a cells representations in a target list

Class name | Description
--- | ---
rich-shuttle-target-cell | Defines styles for a cell in a target list
rich-shuttle-target-cell-selected | Defines styles for a selected cell in a target list
rich-shuttle-target-cell-active | Defines styles for an active cell in a target list

Table 6.217. Classes names that define controls representations

Class name | Description
--- | ---
rich-shuttle-controls | Defines styles for a controls group
rich-shuttle-top | Defines styles for a "Top" control
rich-shuttle-bottom | Defines styles for a "Bottom" control
rich-shuttle-up | Defines styles for a "Up" control
rich-shuttle-down | Defines styles for a "Down" control
rich-shuttle-copy | Defines styles for a "Copy" control
rich-shuttle-remove | Defines styles for a "Remove" control
rich-shuttle-copyAll | Defines styles for a "copyAll" control
rich-shuttle-removeAll | Defines styles for a "removeAll" control
rich-shuttle-control-disabled | Defines styles for a control in a disabled state

Table 6.218. Classes names that define a button representation

Class name | Description
--- | ---
rich-list-shuttle-button | Defines styles for a button
rich-list-shuttle-button-disabled | Defines styles for a disabled button
rich-list-shuttle-button-light | Defines styles for a button highlight
rich-list-shuttle-button-press | Defines styles for a pressed button
rich-list-shuttle-button-content | Defines styles for a button content
rich-list-shuttle-button-selection | Defines styles for a button selection

You can find all necessary information about style classes redefinition in Definition of Custom Style Classes section.

#### 6.12.1.5. Relevant Resources Links

On RichFaces LiveDemo page you can see an example of <rich:listShuttle> usage and sources for the given example.

- Prev6.12. Rich Selects
- Top of page
- Front page
- Next6.12.2. < rich:orderingList > ...