Tag Documentation

Description:

Specifies a Boolean check box that is a standard JavaServer Faces control. You can only use this control in a Form control.

Component Information
Info	Value
Component Type	`javax.faces.HtmlSelectBooleanCheckbox`
Handler Class	None
Renderer Type	`com.webmethods.caf.faces.Checkbox`
Description	Single checkbox
Palette Location	`CAF Html/Control/Input/Checkbox`
Client-Side Model	`CAF.Checkbox.Model`

Attributes
Name	Required	Type	Description
`accesskey`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Keyboard shortcut letter
`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".
`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`)	Checkbox label
`lang`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Specifies the language of the enclosed content
`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
`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.
`selected`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	True if checkbox is checked 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 text of the validator message, replacing any message that comes from the validator.
`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

Checkbox - caf_h:selectBooleanCheckbox