Foundation
Project Documentation

Summary

Tag name: <tr:selectBooleanCheckbox>
UIComponent class: org.apache.myfaces.trinidad.component.core.input.CoreSelectBooleanCheckbox
Component type: org.apache.myfaces.trinidad.CoreSelectBooleanCheckbox

The selectBooleanCheckbox component maps to a standard browser input checkbox, which toggles between selected and unselected states. It supports displaying a prompt, text, and messages. The text contained by the selectBooleanCheckbox control will be displayed as the checkbox label.

Example(s):

This example renders a checkbox with the text "checkbox2" and a label of "Label:" which can be toggled using the accessKey '2'.

<tr:selectBooleanCheckbox label="Label:"
                          textAndAccessKey="checkbox&amp;2"
                          accessKey="2"/>

Events

Type Phases Description
javax.faces.event.ValueChangeEvent Process Validations,
Apply Request Values		 The valueChange event is delivered when the value attribute is changed.
org.apache.myfaces.trinidad.event.AttributeChangeEvent Invoke Application,
Apply Request Values		 Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.

Supported Facets

Name Description
help This facet should contain field level help.

Attributes

Name Type Supports EL? Description
accessKey char Yes Character used to gain quick access to this checkbox. For accessibility reasons, this functionality is not supported in screen reader mode.

If the same access key appears in multiple locations in the same page of output, the rendering user agent will cycle among the elements accessed by the similar keys.

This attribute is sometimes referred to as the "mnemonic".

The character specified by this attribute mustexist in the textattribute of this selectBooleanCheckbox instance. If it does not, the user will receive no visual indication of the existence of the accessKey.

attributeChangeListener javax.el.MethodExpression Only EL a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
autoSubmit boolean Yes If set to TRUE on a form element, the component will automatically submit the enclosing form when an appropriate action takes place (a click, text change, etc.).
binding org.apache.myfaces.trinidad.component.core.input.CoreSelectBooleanCheckbox Only EL an EL reference that will store the component instance on a bean. This can be used to give programmatic access to a component from a backing bean, or to move creation of the component to a backing bean.
contentStyle String Yes the CSS styles to attach to the content of the component. For example, you can set the width of that portion to 100 pixels by setting this attribute to "width: 100px".
converter javax.faces.convert.Converter Yes a converter object
disabled boolean Yes whether the element is disabled.
id String No the identifier for the component. The identifier must follow a subset of the syntax allowed in HTML:
  • Must not be a zero-length String.
  • First character must be an ASCII letter (A-Za-z) or an underscore ('_').
  • Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').
immediate boolean Yes whether the value is converted and validated immediately in the Apply Request Values phase, or is handled in the Process Validators phase, the default. By default, values are converted and validated together in the Process Validators phase. However, if you need access to the value of a component during Apply Request Values - for example, if you need to get the value from an actionListener on an immediate commandButton - then setting this to "immediate" makes that possible.
inlineStyle String Yes the CSS styles to use for this component.
label String Yes the label of the bean.
onblur String Yes the event handler for the component losing the focus.
Not supported on the following agents: pda
onchange String Yes event handler for when the value is changed.
onclick String Yes an onclick Javascript handler.
ondblclick String Yes an ondblclick Javascript handler.
onfocus String Yes the event handler for the component gaining the focus.
Not supported on the following agents: pda
onkeydown String Yes an onkeydown Javascript handler.
onkeypress String Yes an onkeypress Javascript handler.
onkeyup String Yes an onkeyup Javascript handler.
onmousedown String Yes an onmousedown Javascript handler.
onmousemove String Yes an onmousemove Javascript handler.
onmouseout String Yes an onmouseout Javascript handler.
onmouseover String Yes an onmouseover Javascript handler.
onmouseup String Yes an onmouseup Javascript handler.
partialTriggers String[] Yes the IDs of the components that should trigger a partial update.

This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too.

Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"

Identifiers must account for NamingContainers. You can use a single colon to start the search from the root, or use multiple colons to move up through the NamingContainer. For example, "::" will pop out of this component's naming container (it pops out of itself if it is a naming container), ":::" will pop out of two naming containers, etc. The search for the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the component with id = commandButton1 after popping out of two naming containers relative to this component. To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".
readOnly boolean Yes whether the element is read-only.
rendered boolean Yes whether the component is rendered. When set to false, no output will be delivered for this component (the component will not in any way be rendered, and cannot be made visible on the client).
required boolean Yes whether a non-null, non-empty value must be entered. If false, validators will not be executed when the value is null or empty.
requiredMessageDetail String Yes the message to be displayed, if 'required' validation fails.

Parameters:

  • {0} the label that identifies the component

selected boolean Yes whether or not the component is currently selected. This is a typesafe alias for the "value" attribute.
shortDesc String Yes The short description of the component. This text is commonly used by user agents to display tooltip help text.
showRequired boolean Yes whether the associated control displays a visual indication of required user input. If a "required" attribute is also present, both the "required" attribute and the "showRequired" attribute must be false for the visual indication not to be displayed.
simple boolean Yes a boolean value that controls whether the component provides label and message support; when set to "true", the component will not display messaging support or the label (these attributes may be ignored: label, labelAndAccessKey, accessKey, showRequired, tip), and may use simpler layout primitives
styleClass String Yes a CSS style class to use for this component.
text String Yes the text value of the checkbox.
textAndAccessKey String Yes An attribute that will simultaneously set both the "text" and "accessKey" attributes from a single value, using conventional ampersand ('&') notation.

For example, setting this attribute to "T&amp;ext" will set the text to "Text" and the access key to 'e'.

validator javax.faces.el.MethodBinding Only EL a method reference to a validator method
value Object Yes the value of the component. If the EL binding for the "value" points to a bean property with a getter but no setter, and this is an editable component, the component will be rendered in read-only mode.
valueChangeListener javax.faces.el.MethodBinding Only EL a method reference to a value change listener