View Source

h2. Overview
_Since 2.0_

The _ace:checkboxButton_ component is a simple true/false selection used to toggle a value that is bound to the button. As of EE 3.3.0_P02/4.0 release, the buttonGroup component can be used to manage a group of checkboxButton components.

{tip}See the ICEfaces Showcase [Live Demo|] of this component, complete with source code.{tip}

h2. Getting Started
<html ... xmlns:ace="">
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|].{tip}
*label* The label of the button-what the user sees that relates to that particular button. For example, "Remember Me"
*style* a pass through to the root element of the component.
*group* ID of button group component if this button is outside of the button group but wants to logically belong to the group.
*styleClass* a pass through to the root element of the component.
*tabindex* a pass through to the root element of the component, default=0.
*disabled* a pass through to the root element of the component.
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*

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

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

{tip}Prior to 4.0 this event was named "activate". The "activate" event name is now deprecated but treated as an alias for "action" for backwards compatibility with existing applications.{tip}

h2. JavaScript API

h4. ICEfaces 3.x

The client side component object is exposed through the global variable name specified in the *widgetVar* attribute.

h4. ICEfaces 4+

The "widgetVar" attribute on the ACE components has been removed in ICEfaces 4 and in its place a new "ice.ace.instance()" client JavaScript object lookup API has been introduced. The reason for this change is to enable lazy-initialization of the ACE component JavaScript objects to improve runtime performance and reduce browser memory use.

{code}var widget = ice.ace.instance('frm:componentId);{code}

{tip}The _ice.ace.instance_ function requires the _full_ client id of the component to be specified, such as "j_idt77:componentId" instead of just "componentId". To reduce the complexity of working with complete IDs with this function it may be preferable in some cases to use {{prependId="false"}} in the enclosing form (e.g. _<h:form prependId="false">_).{tip}

{info}This component doesn't have a client-side API made specifically to be used by application developers. However, the component's internal methods and variables can be accessed in this way, including the underlying jQuery object and objects from underlying Javascript libraries (if applicable), and can be used for whatever purpose a developer might have in mind.

h2. Keyboard and ARIA Support

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

The following ARIA roles are supported: checkbox.

h2. CSS Classes

The following markup represents the basic HTML structure of the component and the CSS classes it uses.

<!-- Root container -->
<div class="ice-checkboxbutton [user defined classes]" style="[user defined styles]">
<span class="ui-button ui-widget">
<span class="first-child">
<button class="ui-corner-all ui-widget-content ice-checkboxbutton-checked">
<!-- Icon -->
<span class="fa fa-check-square-o fa-lg"></span>

h2. Known Issues


h2. Additional Resources