Overview | Library | Tag | Help
| FRAMES NO FRAMES

## RichFaces
Tag listShuttle

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

Tag Information
Tag Class | org.richfaces.taglib.ListShuttleTag
TagExtraInfo Class | None
Body Content | JSP
Display Name | None

Attributes
Name | Required | Request-time | Type | Description
activeItem | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.Object`) | Stores active item
ajaxKeys | false | false | `javax.el.ValueExpression` (must evaluate to `java.util.Set`) | Defines row keys that are updated after an Ajax request
binding | false | false | `javax.el.ValueExpression` (must evaluate to `javax.faces.component.UIComponent`) | The attribute takes a value-binding expression for a component property of a backing bean
bottomControlClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more space-separated CSS class names to the 'Bottom' button
bottomControlLabel | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Defines a label for a bottom control
bottomTitle | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: alt for the last button
columnClasses | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more space-separated CSS class names to the columns. If the CSS class names are comma-separated, each class will be assigned to a particular column in the order they follow in the attribute. If you have less class names than columns, the class will be applied to every n-fold column where n is the order in which the class is listed in the attribute. If there are more class names than columns, the overflow ones are ignored.
componentState | false | false | `javax.el.ValueExpression` (must evaluate to `org.ajax4jsf.model.DataComponentState`) | It defines EL-binding for a component state for saving or redefinition
controlsType | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Defines type of a control: button or none. Default value is "button".
controlsVerticalAlign | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Customizes vertically a position of move/copy and order controls relatively to lists. Default value is "middle"
converter | false | false | `javax.el.ValueExpression` (must evaluate to `javax.faces.convert.Converter`) | Id of Converter to be used or reference to a Converter
converterMessage | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | A ValueExpression enabled attribute that, if present, will be used as the text of the converter message, replacing any message that comes from the converter
copyAllControlClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more space-separated CSS class names to the 'Copy all' button
copyAllControlLabel | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Defines a label for a "Copy all" control
copyAllTitle | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: alt for "Copy all" button
copyControlClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more space-separated CSS class names to the 'Copy' button
copyControlLabel | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Defines a label for a "Copy" control
copyTitle | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: alt for a "Copy" button
disabledControlClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more space-separated CSS class names to the component disabled controls
downControlClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more space-separated CSS class names to the 'Down' button
downControlLabel | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Defines a label for a down control
downTitle | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: alt for bottom button
fastMoveControlsVisible | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | If "false", 'Copy All' and 'Remove All' controls aren't displayed. Default value is "true".
fastOrderControlsVisible | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | If "false", 'Top' and 'Bottom' controls aren't displayed. Default value is "true".
id | false | false | `java.lang.String` | Every component may have a unique id that is automatically created if omitted
immediate | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | A flag indicating that this component value must be converted and validated immediately (that is, during Apply Request Values phase), rather than waiting until a Process Validations phase
label | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | A localized user presentable name for this component.
listClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more space-separated CSS class names to the component lists
listsHeight | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Defines height of the list. Default value is "140".
moveControlsVisible | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | If "false", 'Copy' and 'Remove' controls aren't displayed. Default value is "true".
onblur | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when the component loses the focus
onbottomclick | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when the 'Bottom' button is clicked
onclick | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when the component is clicked
oncopyallclick | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when the 'Copy All' button is clicked
oncopyclick | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when the 'Copy' button is clicked
ondblclick | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when the component is double-clicked
ondownclick | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when the 'Down' button is clicked
onfocus | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when the component gets the focus
onlistchange | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called before the list is changed
onlistchanged | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when the list is changed
onmousemove | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when a pointer is moved within the component
onmouseout | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when a pointer is moved away from the component
onmouseover | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when a pointer is moved onto the component
onorderchange | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called before the list order is changed
onorderchanged | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when the list order is changed
onremoveallclick | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when the 'Remove All' button is clicked
onremoveclick | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when the 'Remove' button is clicked
ontopclick | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when the 'Top' button is clicked
onupclick | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when the 'Up' button is clicked
orderControlsVisible | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | If "false", 'Up' and 'Down' controls aren't displayed. Default value is "true".
removeAllControlClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more space-separated CSS class names to the 'Remove all' button
removeAllControlLabel | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Defines a label for a "Remove all" control
removeAllTitle | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: alt for "Remove all" button
removeControlClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more space-separated CSS class names to the 'Remove' button
removeControlLabel | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Defines a label for a "Remove" control
removeTitle | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: alt for a "Remove" button
rendered | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | If "false", this component is not rendered
requiredMessage | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | A ValueExpression enabled attribute which defines text of validation message to show, if a required field is missing
rowClasses | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more space-separated CSS class names to the rows. If the CSS class names are comma-separated, each class will be assigned to a particular row in the order they follow in the attribute. If you have less class names than rows, the class will be applied to every n-fold row where n is the order in which the class is listed in the attribute. If there are more class names than rows, the overflow ones are ignored.
rowKeyConverter | false | false | `javax.el.ValueExpression` (must evaluate to `javax.faces.convert.Converter`) | Converter for a row key object
rowKeyVar | false | false | `java.lang.String` | The attribute provides access to a row key in a Request scope
showButtonLabels | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | Shows a label for a button. Default value is "true".
sourceCaptionLabel | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Defines source list caption representation text
sourceListWidth | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Defines width of a source list. Default value is "140".
sourceRequired | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | Defines the case when source value is being validated. If the value is "true", there should be at least one item in the source list
sourceSelection | false | false | `javax.el.ValueExpression` (must evaluate to `java.util.Set`) | Manages selection in a source list from the server side
sourceValue | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.Object`) | Defines a List or Array of items to be shown in a source list
style | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | CSS style rules to be applied to the component
styleClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more CSS class names to the component. Corresponds to the HTML "class" attribute.
switchByClick | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | If "true", dragging between lists realized by click
switchByDblClick | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | If "true", items can be moved between the lists by double-clicking on them. Default value is "true".
targetCaptionLabel | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Defines target list caption representation text
targetListWidth | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Defines width of a target list. Default value is "140".
targetRequired | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | Defines the case when target value is being validated. If the value is "true", there should be at least one item in the target list
targetSelection | false | false | `javax.el.ValueExpression` (must evaluate to `java.util.Set`) | Manages selection in a target list from the server side
targetValue | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.Object`) | Defines a List or Array of items to be shown in a target list
topControlClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more space-separated CSS class names to the 'Top' button
topControlLabel | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Defines a label for a "Top" control
topTitle | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: alt for the first button
upControlClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more space-separated CSS class names to the 'Up' button
upControlLabel | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Defines a label for an "Up" control
upTitle | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: alt for top button
validator | false | false | `javax.el.MethodExpression` (signature must match `void validator(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object)`) | MethodBinding pointing at a method that is called during Process Validations phase of the request processing lifecycle, to validate the current value of this component
validatorMessage | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | A ValueExpression enabled attribute that, if present, will be used as the text of the validator message, replacing any message that comes from the validator
valueChangeListener | false | false | `javax.el.MethodExpression` (signature must match `void valueChangeListener(javax.faces.event.ValueChangeEvent)`) | Listener for value changes
var | false | false | `java.lang.String` | Defines a list on the page

Variables
| No Variables Defined.

Overview | Library | Tag | Help
| FRAMES NO FRAMES

Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.