NetUI Tag Library Documentation (Version 1.0.1)

netui
netui:checkBoxOption Tag

Renders a single HTML checkbox within a group of checkboxes.

Syntax

<netui:checkBoxOption
    [accessKey="string_accessKey"]
    [alt="string_alt"]
    [defaultValue="boolean_defaultValue"]
    [dir="string_dir"]
    [disabled="boolean_disabled"]
    [labelStyle="string_label"]
    [labelStyleClass="string_class"]
    [lang="string_lang"]
    [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_styleClass"]
    [tabindex="string_tabIndex"]
    [tagId="string_tagId"]
    [title="string_title"]
    [value="string_literal_or_expression_value"] >
    ... JSP content ...
</netui:checkBoxOption>

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  |   Type: char  |   Supports runtime evaluation / JSP Expression Language: Yes

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  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The alt attribute of the element.
defaultValue
Required: No  |   Type: boolean  |   Supports runtime evaluation / JSP Expression Language: Yes

The boolean value or expression to be used as the default value.
dir
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

Specifies the direction of text. (LTR | RTL)
disabled
Required: No  |   Type: boolean  |   Supports runtime evaluation / JSP Expression Language: Yes

Set the disable state either with the literal "true" or "false" or with an expression.
labelStyle
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The style of the text displayed by the rendered checkbox.
labelStyleClass
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The class of the text displayed by the rendered checkbox.
lang
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

Sets the language code for the base language of an element's attribute values and text content.
onBlur
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onBlur JavaScript event.
onChange
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onChange JavaScript event.
onClick
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onClick JavaScript event.
onDblClick
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onDblClick JavaScript event.
onFocus
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onFocus JavaScript event.
onKeyDown
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onKeyDown JavaScript event.
onKeyPress
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onKeyPress JavaScript event.
onKeyUp
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onKeyUp JavaScript event.
onMouseDown
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onMouseDown JavaScript event.
onMouseMove
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onMouseMove JavaScript event.
onMouseOut
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onMouseOut JavaScript event.
onMouseOver
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onMouseOver JavaScript event.
onMouseUp
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onMouseUp JavaScript event.
onSelect
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onSelect JavaScript event.
style
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

Specifies style information for the current element.
styleClass
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The style class (a style sheet selector).
tabindex
Required: No  |   Type: int  |   Supports runtime evaluation / JSP Expression Language: Yes

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  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

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 lookupIdByTagId( 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:

    lookupIdByTagId( "foo", this )

To get a <netui:form> element and all of its children elements in JavaScript, use the same JavaScript function lookupIdByTagId( 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[lookupIdByTagId( "bar", this )]

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

    document[lookupIdByTagId("bar", this)][lookupIdByTagId("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.

title
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The title.
value
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: 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>


Tag Information
Tag Classorg.apache.beehive.netui.tags.html.CheckBoxOption
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone