selectBooleanCheckbox

Summary

Tag name: < af:selectBooleanCheckbox >

UIComponent class: oracle.adf.view.faces.component.core.input.CoreSelectBooleanCheckbox

Component type: oracle.adf.CoreSelectBooleanCheckbox

The selectBooleanCheckbox control 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:

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

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

Events

Type Phases Description

javax.faces.event.ValueChangeEvent Process Validations

Apply Request Values Event delivered when a new value is entered by a user.

Attributes

Ungrouped 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 must exist in the `text` attribute of this selectBooleanCheckbox instance. If it does not, the user will receive no visual indication of the existence of the accessKey.
attributeChangeListener	javax.faces.el.MethodBinding	Only EL	a method reference to an attribute change listener
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.).
disabled	boolean	Yes	whether the element is disabled.
immediate	boolean	Yes	whether the value is converted and validated immediately in the Apply Request Values phase, or in the Process Validators phase.
label	String	Yes	the label of the bean.
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.
readOnly	boolean	Yes	whether the element is read-only.
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.
requiredMessageDe tail	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.
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, messageDescUrl messageTargetFrame, showRequired, tip), and may use simpler layout primitives
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
valign	String	Yes	the vertical alignment of the label and other contents. The acceptable values are "middle", "top", and "bottom".
value	Object	Yes	the value of the component
valueChangeListener	javax.faces.el.MethodBinding	Only EL	a method reference to an value change listener

Message attributes

Name	Type	Supports EL?	Description
messageDescUrl	String	Yes	an URL to a page with more information about the message.
messageTargetFrame	String	Yes	the target frame for the message description URL, if any.
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.
tip	String	Yes	the tip text associated with the control

Core attributes

Name	Type	Supports EL?	Description
binding	oracle.adf.view.faces.component. core.input.CoreSelectBooleanCheckbox	Only EL	a binding reference to store the component instance
converter	javax.faces.convert.Converter	Yes	a converter object
id	String	No	the identifier for the component. This must be a valid XML ID, and therefore may not contain whitespace or start with a number. Also, JSF requires that IDs must not contain any colons (":").
inlineStyle	String	Yes	the inline CSS style for this element
rendered	boolean	Yes	whether the bean is rendered. When set to false, no output will be delivered for this bean.
shortDesc	String	Yes	the short description of the bean. This text is commonly u sed by user agents to display tooltip help text.
styleClass	String	Yes	the CSS style class of the bean.

Javascript attributes

Name	Type	Supports EL?	Description
onblur	String	Yes	the event handler for when the element loses focus.
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 when the element receives focus.
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.