A swapbox that is two list boxes with options that shuttle between them. Selection options are specified using Option and Option Group children. The control's value is an array of selected values.
You cannot drop an input control outside of a Form control.
Children
javax.faces.SelectItem
, Option controljavax.faces.SelectItems
, Option Group controlInfo | Value |
---|---|
Component Type | com.webmethods.caf.faces.select.SelectMany |
Handler Class | None |
Renderer Type | com.webmethods.caf.faces.select.Swapbox |
Description | Multi-select swapbox |
Palette Location | CAF Html/Control/Input/Swapbox |
Client-Side Model | CAF.Select.Swapbox.Model |
Name | Required | Type | Description |
---|---|---|---|
accesskey | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Keyboard shortcut letter |
availableLabel | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Label for available listbox; defaults to localized value (in English, "Available") |
converter | false | javax.el.ValueExpression
(must evaluate to javax.faces.convert.Converter )
| A value binding expression for a method that returns a converter instance. |
converterMessage | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Will be used as the text of the converter message, replacing any message that comes from the converter. |
dir | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
|
Specifies the directionality of the flow of the content for the current element
Valid values are:
|
disabled | false | javax.el.ValueExpression
(must evaluate to boolean )
|
True if control is grayed-out and un-modifiable
If not specified, the default value is "false". |
filter | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Filter value |
id | false | java.lang.String | Control identifier |
immediate | false | javax.el.ValueExpression
(must evaluate to boolean )
|
True to process value change listeners in the Apply Request Values phase; false to process in the Process Validations phase
If not specified, the default value is "false". |
label | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| A localized user presentable name for this component. |
lang | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Specifies the language of the enclosed content |
move | false | javax.el.ValueExpression
(must evaluate to boolean )
|
True to allow re-ordering of selected items
If not specified, the default value is "false". |
other | false | javax.el.ValueExpression
(must evaluate to boolean )
|
Show Other... option
If not specified, the default value is "false". |
rendered | false | javax.el.ValueExpression
(must evaluate to boolean )
|
True to render control; false to ignore it
If not specified, the default value is "true". |
required | false | javax.el.ValueExpression
(must evaluate to boolean )
|
True if user must specify a value for control
If not specified, the default value is "false". |
requiredMessage | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Will be used as the text of the validation message for the "required" facility, if the "required" facility is used. |
selectedLabel | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Label for selected listbox; defaults to localized value (in English, "Selected") |
size | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer )
| Height in lines |
style | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| HTML "style" attribute value |
styleClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
|
HTML "class" attribute value
Valid values are:
|
tabindex | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Order in tab (key) sequence, from 1 to n. Zero adds control to tab sequence, negative integer removes control. |
title | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| HTML "title" attribute value (often displayed as a tooltip) |
useClientSideValidation | false | javax.el.ValueExpression
(must evaluate to boolean )
|
True if client side validation should be attempted (if available) for the control
If not specified, the default value is "true". Valid values are:
|
validator | false | javax.el.MethodExpression
(signature must match void validate(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object) )
| A method binding expression for a method that validates the component local value. |
validatorMessage | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Will be used as the description of the validator message. |
value | false | javax.el.ValueExpression
(must evaluate to java.lang.Object )
| Control value |
valueChangeListener | false | javax.el.MethodExpression
(signature must match void valueChange(javax.faces.event.ValueChangeEvent) )
| Value change listener method binding |
width | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
|
Pre-defined input width
Valid values are:
|
Output generated by Vdldoc View Declaration Language Documentation Generator.