<netui:checkBox> Tag

Generates a single HTML checkbox.

Syntax

<netui:checkBox
    [accessKey="accessKey"]
    [alt="alt"]
    dataSource="dataSource"
    [defaultValue="defaultValue"]
    [dir="dir"]
    [disabled="disabled"]
    [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"] />

Description

Generates a single HTML checkbox. The <netui:checkBox> tag should be used on its own, not within a <netui:checkBoxGroup> .

The <netui:checkBox> tag can be data bound to a boolean or Boolean type. For instance, the following <netui:checkBox> tag...

    <netui:checkBox dataSource="{actionForm.checkBoxValue}"/>
...must be bound to a boolean or Boolean field in the Form Bean...
    public static class ProcessDataForm extends FormData
    {
        private boolean checkBoxValue;

        public void setCheckBoxValue(boolean checkBoxValue)
        {
            this.checkBoxValue = checkBoxValue;
        }

        public boolean isCheckBoxValue()
        {
            return this.checkBoxValue;
        }
    }

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.
dataSource
Required: Yes  |   Supports runtime evaluation: No  |   Data bindable:

The dataSource attribute determines both (1) the source of populating data for the tag and (2) the object to which the tag submits data.

For example, assume that the Controller file (= JPF file) contains a Form Bean with the property foo. Then the following <netui:textBox> tag will (1) draw populating data from the Form Bean's foo property and (2) submit user defined data to the same property.

    <netui:textBox dataSource="{actionForm.foo}" />

The dataSource attribute takes either a data binding expression or the name of a Form Bean property. In the above example, <netui:textBox dataSource="foo" /> would have the exactly same behavior.

When the tag is used to submit data, the data binding expression must refer to a Form Bean property. In cases where the tag is not used to submit data, but is used for displaying data only, the data binding expression need not refer to a Form Bean property. For example, assume that myIterativeData is a member variable on the Controller file ( = JPF file). The following <netui-data:repeater> tag draws its data from myIterativeData.

    <netui-data:repeater dataSource="{pageFlow.myIterativeData}">

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

Use in <netui:checkBoxGroup>, <netui:checkBox>, <netui:radioButtonGroup>, and <netui:select> tags

Sets the preselected value or values.

The defaultValue attribute takes either a String literal or a data binding expression.

If the defaultValue attribute has a String value (or if the data binding expression points to a String), then a single value will be preselected.

If the defaultValue attribute points to a String[] object (or any object which can be iterated over), then multiple values will be preselected.

Use in <netui:textArea> and <netui:textBox> tags

Sets the initial display text.

The defaultValue attribute takes either a String literal or a data binding expression that points to a String.

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

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

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.

 
Example

In this sample, the <netui:checkBox reads it initial value from the Form Bean field wantSpecialOffers. Upon submission, the user specified value is loaded into the same Form Bean field. The data is submitted to the action method processData.

    <netui:form action="processData">
        Do you want to be notified of special offers?
        <netui:checkBox dataSource="{actionForm.wantsSpecialOffers}"/><br>
        <netui:button value="Submit" type="submit"/>
    </netui:form>