Tag Documentation

Description:

Specifies a user interface control that contains a group of check boxes. Selection options are defined by specifying javax.faces.SelectItem or javax.faces.SelectItems as children of this control. For more information, see the control documentation for the standard JSF controls Option and Option Group. The control's value attribute (the current selection values) is expressed as an array of values.

You can only use this control in a Form control.

Set the other attribute to true to add a value to the list of options in the Checkbox Group. When the other property is set to true, an Other button is rendered at the end of the list of check boxes. When the user clicks the Other button, a dialog box opens and prompts the user for a new value. When the user clicks the OK button, a new check box item is added to the group with the user-specified value. Default is false.

Children

javax.faces.SelectItem (JSF Option control) and javax.faces.SelectItems (JSF Option Group control).

Component Information
Info	Value
Component Type	`com.webmethods.caf.faces.select.SelectManyCheckbox`
Handler Class	None
Renderer Type	`com.webmethods.caf.faces.Checkbox`
Description	Checkbox group
Palette Location	`CAF Html/Control/Input/Checkbox Group`
Client-Side Model	`CAF.Select.Checkbox.Model`

Attributes
Name	Required	Type	Description
`accesskey`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Keyboard shortcut letter
`border`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Integer`)	Border width in pixels
`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: LTR RTL
`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".
`disabledClass`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	CSS class to apply to disabled options
`enabledClass`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	CSS class to apply to enabled options
`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
`layout`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Orientation: pageDirection=vertical, lineDirection=horizontal If not specified, the default value is "lineDirection". Valid values are: pageDirection lineDirection
`onblur`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	JavaScript "onblur" event handler
`onchange`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	JavaScript "onchange" event handler
`onclick`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	JavaScript "onclick" event handler
`ondblclick`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	JavaScript "ondblclick" event handler
`onfocus`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	JavaScript "onfocus" event handler
`onkeydown`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	JavaScript "onkeydown" event handler
`onkeypress`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	JavaScript "onkeypress" event handler
`onkeyup`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	JavaScript "onkeyup" event handler
`onmousedown`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	JavaScript "onmousedown" event handler
`onmousemove`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	JavaScript "onmousemove" event handler
`onmouseout`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	JavaScript "onmouseout" event handler
`onmouseover`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	JavaScript "onmouseover" event handler
`onmouseup`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	JavaScript "onmouseup" event handler
`other`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	Show Other... option
`readonly`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	True if control is un-modifiable 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.
`sortByLabel`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	True to sort options alphabetically by their label text If not specified, the default value is "false".
`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: 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]
`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: true false
`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: input2 input4 input6 input8 input10 input20 input30 input40 input50 input100

Checkbox Group - caf_h:selectManyCheckbox