Tag Documentation

Description:
A button that toggles the client-side visibility of a group of controls, or the server-side rendered property of a group of non-hideable controls. Only the selected control from the group specified in the Toggle Button control's value property is visible. For more information, see information about toggle controls in the webMethods CAF Development Help.

For more information about hiding controls, see information about concealable controls in webMethods CAF Development Help.

The selection options are specified using the javax.faces.SelectItem or javax.faces.SelectItems by value specifying a control ID. For more information, see the Option conrol or the Option Group control.

Children
- javax.faces.SelectItem, Option control
- javax.faces.SelectItems, JSF Option Group control

Component Information
Info	Value
Component Type	`com.webmethods.caf.faces.toggle.ToggleButton`
Handler Class	None
Renderer Type	`com.webmethods.caf.faces.toggle.ToggleButton`
Description	Displays select-item model as a button that toggles among a group of controls
Palette Location	`CAF Html/Control/Toggle/Toggle Button`
Client-Side Model	`CAF.Select.Button.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.
`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`)	A localized user presentable name for this component.
`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.
`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.
`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 button width Valid values are: button2 button3 button4 button5 button6 button7 button8 button9 button10 button12 button14 button16 button18 button20

Toggle Button - caf_h:toggleButton