apex:selectCheckboxes

A set of related checkbox input elements displayed in a table.

This component supports HTML pass-through attributes using the “html-” prefix. Pass-through attributes are attached to the generated container <table> tag.

Example 

1<!-- Page: -->
2<apex:page controller="sampleCon">
3    <apex:form>
4        <apex:selectCheckboxes value="{!countries}">
5            <apex:selectOptions value="{!items}"/>
6        </apex:selectCheckboxes><br/>
7        <apex:commandButton value="Test" action="{!test}" rerender="out" status="status"/>
8    </apex:form>
9    <apex:outputPanel id="out">
10        <apex:actionstatus id="status" startText="testing...">
11            <apex:facet name="stop">
12                <apex:outputPanel>
13                    <p>You have selected:</p>
14                    <apex:dataList value="{!countries}" var="c">{!c}</apex:dataList>
15                </apex:outputPanel>
16            </apex:facet>
17        </apex:actionstatus>
18    </apex:outputPanel>
19</apex:page>
20
21/*** Controller: ***/
22public class sampleCon {
23    String[] countries = new String[]{};
24
25    public PageReference test() {
26        return null;
27    }
28
29    public List<SelectOption> getItems() {
30        List<SelectOption> options = new List<SelectOption>();
31        options.add(new SelectOption('US','US'));
32        options.add(new SelectOption('CANADA','Canada'));
33        options.add(new SelectOption('MEXICO','Mexico'));
34
35        return options;
36    }
37
38    public String[] getCountries() {
39        return countries;
40    }
41
42    public void setCountries(String[] countries) {
43        this.countries = countries;
44    }
45}

Attributes 

Attribute NameAttribute TypeDescriptionRequired?API VersionAccess
accesskeyStringThe keyboard access key that puts the selectCheckboxes component in focus. When the selectCheckboxes component is in focus, users can use the keyboard to select and deselect individual checkbox options. 10.0global
borderIntegerThe width of the frame around the rendered HTML table, in pixels. 10.0global
borderVisibleBooleanControls whether the border around the <fieldset> that wraps the checkboxes table is visible or hidden. The default value is false, there is no border. 29.0
dirStringThe direction in which the generated HTML component should be read. Possible values include “RTL” (right to left) or “LTR” (left to right). 10.0global
disabledBooleanA Boolean value that specifies whether the selectCheckboxes component should be displayed in a disabled state. If set to true, the checkboxes appear disabled. If not specified, this value defaults to false. 10.0global
disabledClassStringThe style class used to display the selectCheckboxes component when the disabled attribute is set to true, used primarily to designate which CSS styles are applied when using an external CSS stylesheet. 10.0global
enabledClassStringThe style class used to display the selectCheckboxes component when the disabled attribute is set to false, used primarily to designate which CSS styles are applied when using an external CSS stylesheet. 10.0global
idStringAn identifier that allows the selectCheckboxes component to be referenced by other components in the page. 10.0global
immediateBooleanA Boolean value that specifies whether the action associated with this component should happen immediately, without processing any validation rules associated with the fields on the page. If set to true, the action happens immediately and validation rules are skipped. If not specified, this value defaults to false. See Use the immediate Attribute Carefully. 11.0global
labelStringA text value that allows to display a label next to the control and reference the control in the error message 23.0
langStringThe base language for the generated HTML output, for example, “en” or “en-US”. For more information on this attribute, see the W3C specifications. 10.0global
layoutStringThe method by which checkboxes should be displayed in the table. Possible values include “lineDirection”, in which checkboxes are placed horizontally, or “pageDirection”, in which checkboxes are placed vertically. If not specified, this value defaults to “lineDirection”. 10.0global
legendInvisibleBooleanControls whether the legend text is displayed or hidden. The default value is false, the legend text is displayed for all users. When set to true, the <legend> has a styling attribute added, class="assistiveText", which preserves the legend text in the DOM, but moves the display off-screen. This makes the text accessible to screen readers, without being displayed visually. 29.0
legendTextStringThe text to be displayed as a legend for the checkboxes group. When the border is visible, the legend is inlaid along the top-left edge of the border. When legendText is an empty string, or not set, no legend is added. 29.0
onblurStringThe JavaScript invoked if the onblur event occurs–that is, if the focus moves off of the selectCheckboxes component. 10.0global
onchangeStringThe JavaScript invoked if the onchange event occurs–that is, if the value of any checkbox in the selectCheckboxes component changes. 10.0global
onclickStringThe JavaScript invoked if the onclick event occurs–that is, if the user clicks the selectCheckboxes component. 10.0global
ondblclickStringThe JavaScript invoked if the onclick event occurs–that is, if the user clicks the selectCheckboxes component twice. 10.0global
onfocusStringThe JavaScript invoked if the onfocus event occurs–that is, if the focus is on the selectCheckboxes component. 10.0global
onkeydownStringThe JavaScript invoked if the onkeydown event occurs–that is, if the user presses a keyboard key. 10.0global
onkeypressStringThe JavaScript invoked if the onkeypress event occurs–that is, if the user presses or holds down a keyboard key. 10.0global
onkeyupStringThe JavaScript invoked if the onkeyup event occurs–that is, if the user releases a keyboard key. 10.0global
onmousedownStringThe JavaScript invoked if the onmousedown event occurs–that is, if the user clicks a mouse button. 10.0global
onmousemoveStringThe JavaScript invoked if the onmousemove event occurs–that is, if the user moves the mouse pointer. 10.0global
onmouseoutStringThe JavaScript invoked if the onmouseout event occurs–that is, if the user moves the mouse pointer away from the selectCheckboxes component. 10.0global
onmouseoverStringThe JavaScript invoked if the onmouseover event occurs–that is, if the user moves the mouse pointer over the selectCheckboxes component. 10.0global
onmouseupStringThe JavaScript invoked if the onmouseup event occurs–that is, if the user releases the mouse button. 10.0global
onselectStringThe JavaScript invoked if the onselect event occurs–that is, if the user selects a checkbox in the selectCheckboxes component. 10.0global
readonlyBooleanA Boolean value that specifies whether this selectCheckboxes component is rendered as read-only. If set to true, the checkbox values cannot be changed. If not selected, this value defaults to false. 10.0global
renderedBooleanA Boolean value that specifies whether the component is rendered on the page. If not specified, this value defaults to true. 10.0global
requiredBooleanA Boolean value that specifies whether this selectCheckboxes component is a required field. If set to true, the user must select one or more of these checkboxes. If not selected, this value defaults to false. 10.0global
styleStringThe style used to display the selectCheckboxes component, used primarily for adding inline CSS styles. 10.0global
styleClassStringThe style class used to display the selectCheckboxes component, used primarily to designate which CSS styles are applied when using an external CSS stylesheet. 10.0global
tabindexStringThe order in which this selectCheckboxes component is selected compared to other page components when a user presses the Tab key repeatedly. This value must be an integer between 0 and 32767, with component 0 being the first component that is selected when a user presses the Tab key. 10.0global
titleStringThe text to display as a tooltip when the user’s mouse pointer hovers over this component. 10.0global
valueObjectA merge field that references the controller class variable that is associated with this selectCheckboxes component. For example, if the name of the associated variable in the controller class is myCheckboxSelections use value=”{!myCheckboxSelections}” to reference the variable. 10.0global

See Also