|Oracle Fusion Middleware Tag Reference for Oracle ADF Faces
11g Release 1 (188.8.131.52.0)
UIComponent class: oracle.adf.view.rich.component.rich.input.RichSelectBooleanCheckbox
Component type: oracle.adf.RichSelectBooleanCheckbox
The selectBooleanCheckbox component maps to a standard browser input checkbox, which toggles between selected and unselected states. It supports displaying a prompt (label), text, and messages. Unlike the selectManyCheckbox component which only supports horizontal and vertical layout of the checkbox components, the selectBooleanCheckbox component allows more flexibility in how the checkbox components are laid out on the page. For example, selectBooleanCheckbox components can be laid out in a grid by using h:panelGrid.
The attributes "disabled", "immediate", "readOnly", "required", "requiredMessageDetail", "value" are not settable from the client for security reasons.
The "value" attribute should be set to to a boolean, not object as shown below.
The "required" attribute whether a non-null, non-empty value must be entered. If false, validators will not be executed when the value is null or empty. Having the required attribute set to true, does not mean that the user must check the checkbox before submitting. False is a valid value, even if the required attribute is true.
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"/>
Apply Request Values
|The valueChange event is delivered when the value attribute is changed.|
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.|
|help||This facet is deprecated, helpTopicId should be used for providing help. This is a no-op for form components.|
|accessKey||char||Yes||a character used to gain quick access to the form element specified by the
This attribute is sometimes referred to as the "mnemonic".
Note that the accessKey is triggered by browser-specific and platform-specific modifier keys. It even has browser-specific meaning. For example, Internet Explorer 7.0 will set focus when you press Alt+<accessKey>. Firefox 2.0 on some operating systems you press Alt+Shift+<accessKey>. Firefox 2.0 on other operating systems you press Control+<accessKey>. Refer to your browser's documentation for how it treats 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||an attribute which if set to TRUE on a form element, the component will automatically submit when an appropriate action takes place (a click, text change, etc.). Since autoSubmit is a partial submit, also submitted and re-rendered are any other components with partialTriggers pointing to this component.|
|binding||oracle.adf.view.rich.component.rich.input.RichSelectBooleanCheckbox||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.|
|changed||boolean||Yes||an attribute which if set to true, the changed indicator icon will be displayed on the component. This value defaults to false.|
|changedDesc||String||Yes||the text commonly used by user agents to display tooltip text on the changed indicator icon. Default value is "Changed". The behavior of the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips.|
|contentStyle||String||Yes||the style of the content piece of the component. You can style width by setting this attribute like this: width: 100px.|
|converter||javax.faces.convert.Converter||Yes||a converter object|
|customizationId||String||Yes||This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.|
|disabled||boolean||Yes||whether the element is disabled. Unlike a readonly component, a disabled component is unable to receive focus. If the component has the potential to have a scrollbar, and you want the user to be able to scroll through the component's text or values, use the 'readOnly' attribute, not the 'disabled' attribute.|
|helpTopicId||String||Yes||the id used to look up a topic in a helpProvider.|
|id||String||No||the identifier for the component. The identifier must follow a subset of the syntax allowed in HTML:
|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. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.|
|label||String||Yes||the label of the component. If you want the label to appear above the control, use a panelFormLayout.|
|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. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.|
|readOnly||boolean||Yes||whether the control is displayed as an editable field or as an output-style text control. Unlike a disabled component, a readonly component is able to receive focus.|
|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). If you want to change a component's rendered attribute from false to true using PPR, set the partialTrigger attribute of its parent component so the parent refreshes and in turn will render this component.|
|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.
|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, in which case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute it is recommended that helpTopicId is used as it is more flexible and is more accessibility-compliant.|
|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. An example of when it can be desirable to use the showRequired property is if you have a field that is initially empty and is required only if some other field on the page is touched.|
|simple||boolean||Yes||a boolean value that controls whether the component provides label support; when set to "true", the component will not display the label (these may be ignored: label, labelAndAccessKey, accessKey, showRequired, help facet) and may use simpler layout primitives. One of the usecases can be when the component is used in repeatable elements like in table, for-each etc., where label is not required.|
|styleClass||String||Yes||a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.|
|text||String||Yes||the text 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&ext" will set the text to "Text" and the access key to 'e'.|
|unsecure||java.util.Set||Yes||A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. Currently, this is supported only for the "disabled" attribute.|
|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|
|visible||boolean||Yes||the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property.
Not supported on the following renderkits: org.apache.myfaces.trinidad.core