<netui:checkBoxOption> Tag

Renders a single HTML checkbox within a group of checkboxes.

Syntax

<netui:checkBoxOption
    [accessKey="accessKey"]
    [alt="alt"]
    [defaultValue="defaultValue"]
    [dir="dir"]
    [disabled="disabled"]
    [labelStyle="labelStyle"]
    [labelStyleClass="labelStyleClass"]
    [lang="lang"]
    [onBlur="onBlur"]
    [onChange="onChange"]
    [onClick="onClick"]
    [onDblClick="onDblClick"]
    [onFocus="onFocus"]
    [onKeyDown="onKeyDown"]
    [onKeyPress="onKeyPress"]
    [onKeyUp="onKeyUp"]
    [onMouseDown="onMouseDown"]
    [onMouseMove="onMouseMove"]
    [onMouseOut="onMouseOut"]
    [onMouseOver="onMouseOver"]
    [onMouseUp="onMouseUp"]
    [onSelect="onSelect"]
    [style="style"]
    [styleClass="styleClass"]
    [tabindex="tabindex"]
    [tagId="tagId"]
    [title="title"]
    [value="value"] />

Description

Renders a single HTML checkbox within a group of checkboxes. The <netui:checkBoxOption> tags must have a parent <netui:checkBoxGroup> tag (which determines the data binding for the <netui:checkBoxOption> tags).

Attributes
accessKey
Required: No  |   Supports runtime evaluation: Yes  |   Data bindable: No

The keyboard navigation key for the element. The following values are not recommended because they are often used by browsers: A, C, E, F, G, H, V, left arrow, and right arrow
alt
Required: No  |   Supports runtime evaluation: Yes  |   Data bindable:

The alt attribute of the element.
defaultValue
Required: No  |   Supports runtime evaluation: Yes  |   Data bindable:

dir
Required: No  |   Supports runtime evaluation: Yes  |   Data bindable: No

The dir.
disabled
Required: No  |   Supports runtime evaluation: Yes  |   Data bindable:

labelStyle
Required: No  |   Supports runtime evaluation: Yes  |   Data bindable: No

The style of the text displayed by the rendered checkbox.
labelStyleClass
Required: No  |   Supports runtime evaluation: Yes  |   Data bindable: No

The class of the text displayed by the rendered checkbox.
lang
Required: No  |   Supports runtime evaluation: Yes  |   Data bindable: No

The lang.
onBlur
Required: No  |   Supports runtime evaluation: Yes  |   Data bindable:

onChange
Required: No  |   Supports runtime evaluation: Yes  |   Data bindable:

onClick
Required: No  |   Supports runtime evaluation: Yes  |   Data bindable: No

The onClick JavaScript event.
onDblClick
Required: No  |   Supports runtime evaluation: Yes  |   Data bindable: No

The onDblClick JavaScript event.
onFocus
Required: No  |   Supports runtime evaluation: Yes  |   Data bindable:

onKeyDown
Required: No  |   Supports runtime evaluation: Yes  |   Data bindable: No

The onKeyDown JavaScript event.
onKeyPress
Required: No  |   Supports runtime evaluation: Yes  |   Data bindable: No

The onKeyPress JavaScript event.
onKeyUp
Required: No  |   Supports runtime evaluation: Yes  |   Data bindable: No

The onKeyUp JavaScript event.
onMouseDown
Required: No  |   Supports runtime evaluation: Yes  |   Data bindable: No

The onMouseDown JavaScript event.
onMouseMove
Required: No  |   Supports runtime evaluation: Yes  |   Data bindable: No

The onMouseMove JavaScript event.
onMouseOut
Required: No  |   Supports runtime evaluation: Yes  |   Data bindable: No

The onMouseOut JavaScript event.
onMouseOver
Required: No  |   Supports runtime evaluation: Yes  |   Data bindable: No

The onMouseOver JavaScript event.
onMouseUp
Required: No  |   Supports runtime evaluation: Yes  |   Data bindable: No

The onMouseUp JavaScript event.
onSelect
Required: No  |   Supports runtime evaluation: Yes  |   Data bindable:

style
Required: No  |   Supports runtime evaluation: Yes  |   Data bindable: No

The style.
styleClass
Required: No  |   Supports runtime evaluation: Yes  |   Data bindable: No

The style class.
tabindex
Required: No  |   Supports runtime evaluation: Yes  |   Data bindable: No

The tabIndex of the rendered HTML tag. This attribute determines the position of the tag in the sequence of page elements that the user may advance through by pressing the TAB key.
tagId
Required: No  |   Supports runtime evaluation: Yes  |   Data bindable: No

String value. Sets the id (or name) attribute of the rendered HTML tag. Note that the real id attribute rendered in the browser may be changed by the application container (for example, Portal containers may change the rendered id value to ensure the uniqueness of id's on the page). In this case, the real id rendered in the browser may be looked up through the JavaScript function getNetuiTagName( tagId, tag ).

For example, assume that some tag's tagId attribute is set to foo.

    <netui:textBox tagId="foo" />

Then the following JavaScript function will return the real id attribute rendered in the browser:

    getNetuiTagName( "foo", this )

To get a <netui:form> element and all of its children elements in JavaScript, use the same JavaScript function getNetuiTagName( tagId, tag ). For example, assume that there is a <netui:form> whose tagId attribute is set to bar.

    <netui:form tagId="bar" >

Then the following JavaScript function will return the <netui:form> element and its children (packaged as an array).

    document[getNetuiTagName( "bar", this )]

To retreive the value entered into a <netui:textBox> within the <netui:form> tag, use the following JavaScript expression.

    document[getNetuiTagName("bar", this)][getNetuiTagName("foo", this)].value

The second parameter ensures that the JavaScript function begins its search within the correct Portlet scope. Pass the JavaScript keyword this as the second parameter. For detailed information on using the function getNetuiTagName( tagId, tag ) see Using JavaScript in Page Flow and Portal Applications.

title
Required: No  |   Supports runtime evaluation: Yes  |   Data bindable: No

The title.
value
Required: No  |   Supports runtime evaluation: Yes  |   Data bindable: Yes

A String literal or a data binding expression. The value attribute determines the value submitted by the checkbox.

 
Example

In this sample, a set of <checkBoxOption> tags are submitted to the processData action method.

     <netui:form action="processData">
          <netui:checkBoxGroup dataSource="{actionForm.data}" defaultValue="{actionForm.defaultChoices}">
              <netui:checkBoxOption value="wantSpecialCDOffers">Do you want to be notified of special CD offers?</netui:checkBoxOption><br>
              <netui:checkBoxOption value="wantSpecialDVDOffers">Do you want to be notified of special DVD offers?</netui:checkBoxOption><br>
          </netui:checkBoxGroup>
          <netui:button value="Submit" type="submit"/>
      </netui:form>