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 Classorg.richfaces.taglib.ListShuttleTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
activeItemfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Stores active item
ajaxKeysfalsefalsejavax.el.ValueExpression
(must evaluate to java.util.Set)
Defines row keys that are updated after an Ajax request
bindingfalsefalsejavax.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
The attribute takes a value-binding expression for a component property of a backing bean
bottomControlClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Assigns one or more space-separated CSS class names to the 'Bottom' button
bottomControlLabelfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Defines a label for a bottom control
bottomTitlefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: alt for the last button
columnClassesfalsefalsejavax.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.
componentStatefalsefalsejavax.el.ValueExpression
(must evaluate to org.ajax4jsf.model.DataComponentState)
It defines EL-binding for a component state for saving or redefinition
controlsTypefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Defines type of a control: button or none. Default value is "button".
controlsVerticalAlignfalsefalsejavax.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"
converterfalsefalsejavax.el.ValueExpression
(must evaluate to javax.faces.convert.Converter)
Id of Converter to be used or reference to a Converter
converterMessagefalsefalsejavax.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
copyAllControlClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Assigns one or more space-separated CSS class names to the 'Copy all' button
copyAllControlLabelfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Defines a label for a "Copy all" control
copyAllTitlefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: alt for "Copy all" button
copyControlClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Assigns one or more space-separated CSS class names to the 'Copy' button
copyControlLabelfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Defines a label for a "Copy" control
copyTitlefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: alt for a "Copy" button
disabledControlClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Assigns one or more space-separated CSS class names to the component disabled controls
downControlClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Assigns one or more space-separated CSS class names to the 'Down' button
downControlLabelfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Defines a label for a down control
downTitlefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: alt for bottom button
fastMoveControlsVisiblefalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
If "false", 'Copy All' and 'Remove All' controls aren't displayed. Default value is "true".
fastOrderControlsVisiblefalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
If "false", 'Top' and 'Bottom' controls aren't displayed. Default value is "true".
idfalsefalsejava.lang.StringEvery component may have a unique id that is automatically created if omitted
immediatefalsefalsejavax.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
labelfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
A localized user presentable name for this component.
listClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Assigns one or more space-separated CSS class names to the component lists
listsHeightfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Defines height of the list. Default value is "140".
moveControlsVisiblefalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
If "false", 'Copy' and 'Remove' controls aren't displayed. Default value is "true".
onblurfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when the component loses the focus
onbottomclickfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when the 'Bottom' button is clicked
onclickfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when the component is clicked
oncopyallclickfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when the 'Copy All' button is clicked
oncopyclickfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when the 'Copy' button is clicked
ondblclickfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when the component is double-clicked
ondownclickfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when the 'Down' button is clicked
onfocusfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when the component gets the focus
onlistchangefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called before the list is changed
onlistchangedfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when the list is changed
onmousemovefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when a pointer is moved within the component
onmouseoutfalsefalsejavax.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
onmouseoverfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when a pointer is moved onto the component
onorderchangefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called before the list order is changed
onorderchangedfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when the list order is changed
onremoveallclickfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when the 'Remove All' button is clicked
onremoveclickfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when the 'Remove' button is clicked
ontopclickfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when the 'Top' button is clicked
onupclickfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when the 'Up' button is clicked
orderControlsVisiblefalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
If "false", 'Up' and 'Down' controls aren't displayed. Default value is "true".
removeAllControlClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Assigns one or more space-separated CSS class names to the 'Remove all' button
removeAllControlLabelfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Defines a label for a "Remove all" control
removeAllTitlefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: alt for "Remove all" button
removeControlClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Assigns one or more space-separated CSS class names to the 'Remove' button
removeControlLabelfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Defines a label for a "Remove" control
removeTitlefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: alt for a "Remove" button
renderedfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
If "false", this component is not rendered
requiredMessagefalsefalsejavax.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
rowClassesfalsefalsejavax.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.
rowKeyConverterfalsefalsejavax.el.ValueExpression
(must evaluate to javax.faces.convert.Converter)
Converter for a row key object
rowKeyVarfalsefalsejava.lang.StringThe attribute provides access to a row key in a Request scope
showButtonLabelsfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
Shows a label for a button. Default value is "true".
sourceCaptionLabelfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Defines source list caption representation text
sourceListWidthfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Defines width of a source list. Default value is "140".
sourceRequiredfalsefalsejavax.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
sourceSelectionfalsefalsejavax.el.ValueExpression
(must evaluate to java.util.Set)
Manages selection in a source list from the server side
sourceValuefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Defines a List or Array of items to be shown in a source list
stylefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
CSS style rules to be applied to the component
styleClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Assigns one or more CSS class names to the component. Corresponds to the HTML "class" attribute.
switchByClickfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
If "true", dragging between lists realized by click
switchByDblClickfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
If "true", items can be moved between the lists by double-clicking on them. Default value is "true".
targetCaptionLabelfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Defines target list caption representation text
targetListWidthfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Defines width of a target list. Default value is "140".
targetRequiredfalsefalsejavax.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
targetSelectionfalsefalsejavax.el.ValueExpression
(must evaluate to java.util.Set)
Manages selection in a target list from the server side
targetValuefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Defines a List or Array of items to be shown in a target list
topControlClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Assigns one or more space-separated CSS class names to the 'Top' button
topControlLabelfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Defines a label for a "Top" control
topTitlefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: alt for the first button
upControlClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Assigns one or more space-separated CSS class names to the 'Up' button
upControlLabelfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Defines a label for an "Up" control
upTitlefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: alt for top button
validatorfalsefalsejavax.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
validatorMessagefalsefalsejavax.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
valueChangeListenerfalsefalsejavax.el.MethodExpression
(signature must match void valueChangeListener(javax.faces.event.ValueChangeEvent))
Listener for value changes
varfalsefalsejava.lang.StringDefines a list on the page

Variables
No Variables Defined.


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.