View Source

h2. Overview

The _ace:checkboxButton_ component is a simple true/false selection used to toggle a value that is bound to the button.

h2. Getting Started
{panel}
{code:xml|borderStyle=dashed}
<html ... xmlns:ace="http://www.icefaces.org/icefaces/components">
<h:body class="ice-skin-rime">
<h:form>
<ace:checkboxButton
value="{button.checked}"
label="checkbox"/>
</h:form>
</h:body>
</html>
{code}
{panel}
h2. Attributes

{tip:title=TagLib Documentation}This section covers attributes involved in the typical use-cases for this component. For reference, the complete taglib documentation for this component is available [here|http://www.icefaces.org/docs/v3_latest/ace/tld/ace/checkboxButton.html].{tip}
{panel}
*label* The label of the button-what the user sees that relates to that particular button. For example, "Remember Me"
{panel}
{panel}
*style* a pass through to the root element of the component.
{panel}
{panel}
*styleClass* a pass through to the root element of the component.
{panel}
{panel}
*tabindex* a pass through to the root element of the component, default=0.
{panel}
{panel}
*disabled* a pass through to the root element of the component.
{panel}
{panel}
The following attributes are supported as pass-thru attributes: *accesskey*, *alt*, *dir*, *label*, *lang*, *style*, *tabindex*, *title*, *type*, *onchange*, *onselect*, *onclick*, *ondblclick*, *onkeydown*, *onkeypress*, *onkeyup*, *onmousedown*, *onmousemove*, *onmouseout*, *onmouseover*, *onmouseup*, *onblur*, *onfocus*
{panel}

h2. Event Listeners

As a descendant of UIInput, this component supports a value change listener.

| valueChangeListener | Method that will be notified when a new value has been set for this component |

h2. Client Behavior Events

| activate | Fired when the button is clicked or pressed by any other means (default event). |

h2. JavaScript API

None.

h2. Keyboard Support

Default browser keyboard support for {{<button>}} elements (i.e. tabbing in and out, pressing space to activate).

h2. Known Issues

None.

h2. Additional Resources

None.