Swapbox - caf_h:inputSwapBox

Component Information 
InfoValue
Component Typecom.webmethods.caf.faces.select.SelectMany
Handler ClassNone
Renderer Typecom.webmethods.caf.faces.select.Swapbox
Description Multi-select swapbox
Palette LocationCAF Html/Control/Input/Swapbox
Client-Side ModelCAF.Select.Swapbox.Model
Attributes 
NameRequiredTypeDescription
accesskeyfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Keyboard shortcut letter
availableLabelfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Label for available listbox; defaults to localized value (in English, "Available")
converterfalsejavax.el.ValueExpression
(must evaluate to javax.faces.convert.Converter)
A value binding expression for a method that returns a converter instance.
converterMessagefalsejavax.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.
dirfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Specifies the directionality of the flow of the content for the current element

Valid values are:

  • LTR
  • RTL
disabledfalsejavax.el.ValueExpression
(must evaluate to boolean)
True if control is grayed-out and un-modifiable

If not specified, the default value is "false".

filterfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Filter value
idfalsejava.lang.String Control identifier
immediatefalsejavax.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".

labelfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
A localized user presentable name for this component.
langfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Specifies the language of the enclosed content
movefalsejavax.el.ValueExpression
(must evaluate to boolean)
True to allow re-ordering of selected items

If not specified, the default value is "false".

otherfalsejavax.el.ValueExpression
(must evaluate to boolean)
Show Other... option

If not specified, the default value is "false".

renderedfalsejavax.el.ValueExpression
(must evaluate to boolean)
True to render control; false to ignore it

If not specified, the default value is "true".

requiredfalsejavax.el.ValueExpression
(must evaluate to boolean)
True if user must specify a value for control

If not specified, the default value is "false".

requiredMessagefalsejavax.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.
selectedLabelfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Label for selected listbox; defaults to localized value (in English, "Selected")
sizefalsejavax.el.ValueExpression
(must evaluate to java.lang.Integer)
Height in lines
stylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML "style" attribute value
styleClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML "class" attribute value

Valid values are:

  • portlet-font
  • portlet-font-dim
  • portlet-msg-status
  • portlet-msg-info
  • portlet-msg-error
  • portlet-msg-alert
  • portlet-msg-success
  • portlet-section-header
  • portlet-section-body
  • portlet-section-alternate
  • portlet-section-selected
  • portlet-section-subheader
  • portlet-section-footer
  • portlet-section-text
  • portlet-form-label
  • portlet-form-input-field
  • portlet-form-button
  • portlet-icon-label
  • portlet-dlg-icon-label
  • portlet-form-field-label
  • portlet-form-field
  • portlet-menu
  • portlet-menu-item
  • portlet-menu-item-selected
  • portlet-menu-item-hover
  • portlet-menu-item-hover-selected
  • portlet-menu-cascade-item
  • portlet-menu-cascade-item-selected
  • portlet-menu-description
  • portlet-menu-caption
  • [any_other_value]
tabindexfalsejavax.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.
titlefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML "title" attribute value (often displayed as a tooltip)
useClientSideValidationfalsejavax.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:

  • true
  • false
validatorfalsejavax.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.
validatorMessagefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Will be used as the description of the validator message.
valuefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Control value
valueChangeListenerfalsejavax.el.MethodExpression
(signature must match void valueChange(javax.faces.event.ValueChangeEvent))
Value change listener method binding
widthfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Pre-defined input width

Valid values are:

  • input2
  • input4
  • input6
  • input8
  • input10
  • input20
  • input30
  • input40
  • input50
  • input100

Output generated by Vdldoc View Declaration Language Documentation Generator.