netui:checkBoxOption Tag

<netui:checkBoxOption> Tag

The <netui:checkBoxOption> tag renders a single HTML checkbox within a group of checkboxes.

Syntax

<netui:checkBoxOption
    [accessKey="string_accessKey"]
    [alt="string_alt"]
    [labelStyle="string_label"]
    [labelStyleClass="string_class"]
    [onBlur="string_onBlur"]
    [onChange="string_onChange"]
    [onClick="string_onClick"]
    [onDblClick="string_onDblClick"]
    [onFocus="string_onFocus"]
    [onKeyDown="string_onKeyDown"]
    [onKeyPress="string_onKeyPress"]
    [onKeyUp="string_onKeyUp"]
    [onMouseDown="string_onMouseDown"]
    [onMouseMove="string_onMouseMove"]
    [onMouseOut="string_onMouseOut"]
    [onMouseOver="string_onMouseOver"]
    [onMouseUp="string_onMouseUp"]
    [onSelect="string_onSelect"]
    [style="string_Style"]
    [styleClass="string_Class"]
    [tabindex="string_tabIndex"]
    [tagId="string_tagId"]
    [value="string_literal_or_expression_value"] />

Description

The <netui:checkBoxOption> tag 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

accessKeyThe 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
 
RequiredSupports runtime expression evaluationData bindable
NoNoNo

altThe alt attribute of the element.
 
RequiredSupports runtime expression evaluationData bindable
NoNoRead Only

labelStyleThe style of the text displayed by the rendered checkbox.
 
RequiredSupports runtime expression evaluationData bindable
NoNoNo

labelStyleClassThe class of the text displayed by the rendered checkbox.
 
RequiredSupports runtime expression evaluationData bindable
NoNoNo

onBlurThe onBlur JavaScript event.
 
RequiredSupports runtime expression evaluationData bindable
NoYesNo

onChangeThe onChange JavaScript event.
 
RequiredSupports runtime expression evaluationData bindable
NoYesNo

onClickThe onClick JavaScript event.
 
RequiredSupports runtime expression evaluationData bindable
NoYesNo

onDblClickThe onDblClick JavaScript event.
 
RequiredSupports runtime expression evaluationData bindable
NoYesNo

onFocusThe onFocus JavaScript event.
 
RequiredSupports runtime expression evaluationData bindable
NoYesNo

onKeyDownThe onKeyDown JavaScript event.
 
RequiredSupports runtime expression evaluationData bindable
NoYesNo

onKeyPressThe onKeyPress JavaScript event.
 
RequiredSupports runtime expression evaluationData bindable
NoYesNo

onKeyUpThe onKeyUp JavaScript event.
 
RequiredSupports runtime expression evaluationData bindable
NoYesNo

onMouseDownThe onMouseDown JavaScript event.
 
RequiredSupports runtime expression evaluationData bindable
NoYesNo

onMouseMoveThe onMouseMove JavaScript event.
 
RequiredSupports runtime expression evaluationData bindable
NoYesNo

onMouseOutThe onMouseOut JavaScript event.
 
RequiredSupports runtime expression evaluationData bindable
NoYesNo

onMouseOverThe onMouseOver JavaScript event.
 
RequiredSupports runtime expression evaluationData bindable
NoYesNo

onMouseUpThe onMouseUp JavaScript event.
 
RequiredSupports runtime expression evaluationData bindable
NoYesNo

onSelectThe onSelect JavaScript event.
 
RequiredSupports runtime expression evaluationData bindable
NoYesNo

styleThe style of the rendered HTML tag.
 
RequiredSupports runtime expression evaluationData bindable
NoNoNo

styleClassThe class of the rendered HTML tag.
 
RequiredSupports runtime expression evaluationData bindable
NoNoNo

tabindexThe 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.
 
RequiredSupports runtime expression evaluationData bindable
NoNoNo

tagId

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.

 
RequiredSupports runtime expression evaluationData bindable
NoYesNo

valueA String literal or a data binding expression. The value attribute determines the value submitted by the checkbox.
 
RequiredSupports runtime expression evaluationData bindable
NoYesYes

Sample

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>

Code Sample

[BEA_HOME]/weblogic81/samples/workshop/SamplesApp/WebApp/tagSamples/netui/checkBoxOption/

Related Topics

<netui:checkBoxOption> Tag Sample

<netui:checkBoxGroup> Tag Sample

<netui:checkBoxGroup> Tag

<netui:checkBox> Tag