# com.bea.wlw.netui.tags.html
CheckBoxOption Class

public class CheckBoxOption
extends `AbstractBaseTag`
implements `IAttributeConsumer`

A checkbox whose state is determined by its enclosing CheckBoxGroup.

Attribute Descriptions
Attribute | Required | Runtime Expression Evaluation | Data Bindable
--- | --- | --- | ---
accessKey | No | No | No
Define the keyboard navigation key for the element.
action | No | No | No
The overriding action caused by pressing this button.
labelStyle | No | No | No
The style of the label for each contained CheckBoxOption
labelStyleClass | No | No | No
The style class of the label for each contained CheckBoxOption
tagId | No | No | No
The id of this control. The real id written to the HTML stream may be changed by the container (Portal), but may be looked up with the 'tagId' value through the JavaScript method `getNetuiTagNam( tagId, tag )` method written by the <netui:html> tag.
value | Yes | No | Read Only
An expression to a bean property, or a literal, which is the value of this option

Related Topics

<netui:checkBoxOption> Tag Sample
<netui:checkBoxGroup> Tag Sample
``CheckBoxGroup``
``CheckBox``

Hierarchy
  `Object`
  `TagSupport`
  `BodyTagSupport`
  `AbstractBaseTag`
  `CheckBoxOption`

All Implemented Interfaces
  `BodyTag`, `IAttributeConsumer`, `IterationTag`, `Serializable`, `Tag`

## Field Summary

`public static final `String`` | `CHECKED` String
`public static final `String`` | `DISABLED` String
`protected `String`` | `labelStyle` The style of the label for each contained CheckBoxOption.
`public static final `String`` | `LABELSTYLE` String
`public static final `String`` | `LABELSTYLECLASS` String
`protected `String`` | `text` The message text to be displayed to the user for this tag (if any)
`public static final `String`` | `TYPE` String
`protected `String`` | `value` The server value for this checkbox, also used to match against the current property value to determine whether this checkbox should be marked as checked.
`public static final `String`` | `VALUE` String

Fields from com.bea.wlw.netui.tags`.`AbstractBaseTag``
``ATTR_GENERAL`, `ATTR_GENERAL_EXPRESSION`, `ATTR_JAVASCRIPT`, `ATTR_STYLE`, `CLASS`, `ID`, `JAVASCRIPT_STATUS`, `NAME`, `NETUI_UNIQUE_CNT`, `ONCLICK`, `ONDBLCLICK`, `ONKEYDOWN`, `ONKEYPRESS`, `ONKEYUP`, `ONMOUSEDOWN`, `ONMOUSEMOVE`, `ONMOUSEOUT`, `ONMOUSEOVER`, `ONMOUSEUP`, `STYLE`, `TABINDEX``

Fields from javax.servlet.jsp.tagext`.`BodyTagSupport``
`bodyContent`

Fields from javax.servlet.jsp.tagext`.`TagSupport``
`id, pageContext`

Fields from interface javax.servlet.jsp.tagext`.`BodyTag``
`EVAL_BODY_BUFFERED, EVAL_BODY_TAG`

Fields from interface javax.servlet.jsp.tagext`.`IterationTag``
`EVAL_BODY_AGAIN`

Fields from interface javax.servlet.jsp.tagext`.`Tag``
`EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE`

## Constructor Summary

CheckBoxOption()

## Method Summary

`public int` | `doAfterBody`() Process the body text of this tag (if any).
`public int` | `doEndTag`() Process the end of this tag.
`public int` | `doStartTag`() Process the start of this tag.
`public `String`` | `getAccessKey`() Gets the accessKey attribute value.
`public `String`` | `getAlt`() Gets the alt attribute on the generate <input tag.
`public `String`` | `getLabelStyle`() Return the label style for each contained CheckBoxOption.
`public `String`` | `getLabelStyleClass`() Return the label style class for each contained CheckBoxOption.
`public `String`` | `getOnBlur`() Gets the onBlur javascript event.
`public `String`` | `getOnChange`() Gets the onChange javascript event.
`public `String`` | `getOnClick`() Gets the onClick javascript event.
`public `String`` | `getOnDblClick`() Gets the onDblClick javascript event.
`public `String`` | `getOnFocus`() Gets the onFocus javascript event.
`public `String`` | `getOnKeyDown`() Gets the onKeyDown javascript event.
`public `String`` | `getOnKeyPress`() Gets the onKeyPress javascript event.
`public `String`` | `getOnKeyUp`() Gets the onKeyUp javascript event.
`public `String`` | `getOnMouseDown`() Gets the onMouseDown javascript event.
`public `String`` | `getOnMouseMove`() Gets the onMouseMove javascript event.
`public `String`` | `getOnMouseOut`() Gets the onMouseOut javascript event.
`public `String`` | `getOnMouseOver`() Gets the onMouseOver javascript event.
`public `String`` | `getOnMouseUp`() Gets the onMouseUp javascript event.
`public `String`` | `getOnSelect`() Gets the onSelect javascript event.
`public `String`` | `getStyle`() Gets the style of the rendered html tag.
`public `String`` | `getStyleClass`() Gets the style class of the rendered html tag.
`public `String`` | `getTabindex`() Gets the tabIndex of the rendered html tag.
`public `String`` | `getTagId`() Return the ID of the tag.
`public `String`` | `getTagName`() Return the name of the Tag.
`public `String`` | `getValue`() Return the value of this CheckBoxOption.
`protected void` | `localRelease`() Release any acquired resources.
`public void` | `setAccessKey`(`String` accessKey) Sets the accessKey attribute value.
`public void` | `setAlt`(`String` alt) Sets the alt attribute value.
`public void` | `setAttribute`(`String` name, `String` value) Set an attribute value.
`public void` | `setLabelStyle`(`String` labelStyle) Set the label style for each contained CheckBoxOption.
`public void` | `setLabelStyleClass`(`String` labelStyleClass) Set the label style class for each contained CheckBoxOption.
`public void` | `setOnBlur`(`String` onblur) Sets the onBlur javascript event.
`public void` | `setOnChange`(`String` onchange) Sets the onChange javascript event.
`public void` | `setOnClick`(`String` onclick) Sets the onClick javascript event.
`public void` | `setOnDblClick`(`String` ondblclick) Sets the onDblClick javascript event.
`public void` | `setOnFocus`(`String` onblur) Sets the onFocus javascript event.
`public void` | `setOnKeyDown`(`String` onkeydown) Sets the onKeyDown javascript event.
`public void` | `setOnKeyPress`(`String` onkeypress) Sets the onKeyPress javascript event.
`public void` | `setOnKeyUp`(`String` onkeyup) Sets the onKeyUp javascript event.
`public void` | `setOnMouseDown`(`String` onmousedown) Sets the onMouseDown javascript event.
`public void` | `setOnMouseMove`(`String` onmousemove) Sets the onMouseMove javascript event.
`public void` | `setOnMouseOut`(`String` onmouseout) Sets the onMouseOut javascript event.
`public void` | `setOnMouseOver`(`String` onmouseover) Sets the onMouseOver javascript event.
`public void` | `setOnMouseUp`(`String` onmouseup) Sets the onMouseUp javascript event.
`public void` | `setOnSelect`(`String` onselect) Sets the onSelect javascript event.
`public void` | `setStyle`(`String` style) Sets the style of the rendered html tag.
`public void` | `setStyleClass`(`String` styleClass) Sets the style class of the rendered html tag.
`public void` | `setTabindex`(`String` tabindex) Sets the tabIndex of the rendered html tag.
`public void` | `setTagId`(`String` tagId) Set the ID of the tag.
`public void` | `setValue`(`String` value) Set the value of this CheckBoxOption.
`protected `String`` | `text`() Return the text to be displayed to the user for this checkboxoption (if any).

Methods from `com.bea.wlw.netui.tags.`AbstractBaseTag``
``addTagIdMapping`, `evaluateAttributeToString`, `filter`, `filter`, `getJavaScriptUtils`, `getNearestForm`, `getScriptReporter`, `getUserLocale`, `registerTagError`, `release`, `renderAttribute`, `rewriteName`, `write``

Methods from `javax.servlet.jsp.tagext.`BodyTagSupport``
`doInitBody, getBodyContent, getPreviousOut, release, setBodyContent`

Methods from `javax.servlet.jsp.tagext.`TagSupport``
`doAfterBody, doEndTag, doStartTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue`

Methods from class `java.lang.`Object``
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods from interface `javax.servlet.jsp.tagext.`BodyTag``
`doInitBody, setBodyContent`

Methods from interface `com.bea.wlw.netui.tags.`IAttributeConsumer``
``setAttribute``

Methods from interface `javax.servlet.jsp.tagext.`IterationTag``
`doAfterBody`

Methods from interface `javax.servlet.jsp.tagext.`Tag``
`doEndTag, doStartTag, getParent, release, setPageContext, setParent`

## Field Detail

### CHECKED

    public static final String CHECKED

### DISABLED

    public static final String DISABLED

### labelStyle

    protected String labelStyle

  The style of the label for each contained CheckBoxOption.

### LABELSTYLE

    public static final String LABELSTYLE

### LABELSTYLECLASS

    public static final String LABELSTYLECLASS

### text

    protected String text

  The message text to be displayed to the user for this tag (if any)

### TYPE

    public static final String TYPE

### value

    protected String value

  The server value for this checkbox, also used to match against the current property value to determine whether this checkbox should be marked as checked.

### VALUE

    public static final String VALUE

## Constructor Detail

### CheckBoxOption

    public CheckBoxOption()

## Method Detail

### doAfterBody() Method

    public int doAfterBody()
         throws JspException

Process the body text of this tag (if any).

Overrides
  `BodyTagSupport.doAfterBody()`

#### Exceptions

``JspException``
  if a JSP exception has occurred

### doEndTag() Method

    public int doEndTag()
         throws JspException

Process the end of this tag.

Overrides
  `BodyTagSupport.doEndTag()`

#### Exceptions

``JspException``
  if a JSP exception has occurred

### doStartTag() Method

    public int doStartTag()
         throws JspException

Process the start of this tag.

Overrides
  `BodyTagSupport.doStartTag()`

#### Exceptions

``JspException``
  if a JSP exception has occurred

### getAccessKey() Method

    public String getAccessKey()

Gets the accessKey attribute value.

#### Returns

the accessKey value.

### getAlt() Method

    public String getAlt()

Gets the alt attribute on the generate <input tag.

#### Returns

the alt value.

### getLabelStyle() Method

    public String getLabelStyle()

Return the label style for each contained CheckBoxOption.

#### Returns

the label style

### getLabelStyleClass() Method

    public String getLabelStyleClass()

Return the label style class for each contained CheckBoxOption.

#### Returns

the label style

### getOnBlur() Method

    public String getOnBlur()

Gets the onBlur javascript event.

#### Returns

the onBlur event.

### getOnChange() Method

    public String getOnChange()

Gets the onChange javascript event.

#### Returns

the onChange event.

### getOnClick() Method

    public String getOnClick()

Gets the onClick javascript event.

#### Returns

the onClick event.

### getOnDblClick() Method

    public String getOnDblClick()

Gets the onDblClick javascript event.

#### Returns

the onDblClick event.

### getOnFocus() Method

    public String getOnFocus()

Gets the onFocus javascript event.

#### Returns

the onFocus event.

### getOnKeyDown() Method

    public String getOnKeyDown()

Gets the onKeyDown javascript event.

#### Returns

the onKeyDown event.

### getOnKeyPress() Method

    public String getOnKeyPress()

Gets the onKeyPress javascript event.

#### Returns

the onKeyPress event.

### getOnKeyUp() Method

    public String getOnKeyUp()

Gets the onKeyUp javascript event.

#### Returns

the onKeyUp event.

### getOnMouseDown() Method

    public String getOnMouseDown()

Gets the onMouseDown javascript event.

#### Returns

the onMouseDown event.

### getOnMouseMove() Method

    public String getOnMouseMove()

Gets the onMouseMove javascript event.

#### Returns

the onMouseMove event.

### getOnMouseOut() Method

    public String getOnMouseOut()

Gets the onMouseOut javascript event.

#### Returns

the onMouseOut event.

### getOnMouseOver() Method

    public String getOnMouseOver()

Gets the onMouseOver javascript event.

#### Returns

the onMouseOver event.

### getOnMouseUp() Method

    public String getOnMouseUp()

Gets the onMouseUp javascript event.

#### Returns

the onMouseUp event.

### getOnSelect() Method

    public String getOnSelect()

Gets the onSelect javascript event.

#### Returns

the onSelect event.

### getStyle() Method

    public String getStyle()

Gets the style of the rendered html tag.

#### Returns

the style.

### getStyleClass() Method

    public String getStyleClass()

Gets the style class of the rendered html tag.

#### Returns

the style class.

### getTabindex() Method

    public String getTabindex()

Gets the tabIndex of the rendered html tag.

#### Returns

the tabindex.

### getTagId() Method

    public String getTagId()

Return the ID of the tag. The id may be rewritten by the container (such as a portal) to make sure it is unique. JavaScript my lookup the actual id of the element by looking it up in the `netui_names` table written into the HTML.

#### Returns

the tagId.

### getTagName() Method

    public String getTagName()

Return the name of the Tag.

Overrides
  `AbstractBaseTag.getTagName()`

### getValue() Method

    public String getValue()

Return the value of this CheckBoxOption.

#### Returns

the CheckBoxOption value

### localRelease() Method

    protected void localRelease()

Release any acquired resources.

Overrides
  `AbstractBaseTag.localRelease()`

### setAccessKey(String) Method

    public void setAccessKey(String accessKey)

Sets the accessKey attribute value. This should key value of the keyboard navigation key. It is recommended not to use the following values because there are often used by browsers `A, C, E, F, G, H, V, left arrow, and right arrow`.

#### Parameters

accessKey
  - the accessKey value.

### setAlt(String) Method

    public void setAlt(String alt)

Sets the alt attribute value.

#### Parameters

alt
  - the alt value.

### setAttribute(String, String) Method

    public void setAttribute(String name,
                             String value)
         throws JspException

Set an attribute value. The `name` represents the name of the attribute. The `value` represents the value and may contain a netui expression. This method may result in errors being generated. This requires that the tag buffer its body and write attributes in the end tag. For the checkboxoption tag it is not legal to set the `id`, `name`, `type`, `value`, or `checked` attributes with this method.

#### Parameters

name
  The name of the attribute. This value may not be null or the empty string.

value
  The value of the attribute. This may contain a netui expression.

#### Exceptions

``JspException``
  A JspException may be thrown if there is an error setting the attribute.

### setLabelStyle(String) Method

    public void setLabelStyle(String labelStyle)

Set the label style for each contained CheckBoxOption. The label style here will override a labelStyle at the CheckBoxGroup level.

#### Parameters

labelStyle
  - the label style

### setLabelStyleClass(String) Method

    public void setLabelStyleClass(String labelStyleClass)

Set the label style class for each contained CheckBoxOption. The label style class here will override a labelStyleClass at the CheckBoxGroup level.

#### Parameters

labelStyleClass
  - the label style

### setOnBlur(String) Method

    public void setOnBlur(String onblur)

Sets the onBlur javascript event.

#### Parameters

onblur
  - the onBlur event.

### setOnChange(String) Method

    public void setOnChange(String onchange)

Sets the onChange javascript event.

#### Parameters

onchange
  - the onChange event.

### setOnClick(String) Method

    public void setOnClick(String onclick)

Sets the onClick javascript event.

#### Parameters

onclick
  - the onClick event.

### setOnDblClick(String) Method

    public void setOnDblClick(String ondblclick)

Sets the onDblClick javascript event.

#### Parameters

ondblclick
  - the onDblClick event.

### setOnFocus(String) Method

    public void setOnFocus(String onblur)

Sets the onFocus javascript event.

#### Parameters

onblur
  - the onFocus event.

### setOnKeyDown(String) Method

    public void setOnKeyDown(String onkeydown)

Sets the onKeyDown javascript event.

#### Parameters

onkeydown
  - the onKeyDown event.

### setOnKeyPress(String) Method

    public void setOnKeyPress(String onkeypress)

Sets the onKeyPress javascript event.

#### Parameters

onkeypress
  - the onKeyPress event.

### setOnKeyUp(String) Method

    public void setOnKeyUp(String onkeyup)

Sets the onKeyUp javascript event.

#### Parameters

onkeyup
  - the onKeyUp event.

### setOnMouseDown(String) Method

    public void setOnMouseDown(String onmousedown)

Sets the onMouseDown javascript event.

#### Parameters

onmousedown
  - the onMouseDown event.

### setOnMouseMove(String) Method

    public void setOnMouseMove(String onmousemove)

Sets the onMouseMove javascript event.

#### Parameters

onmousemove
  - the onMouseMove event.

### setOnMouseOut(String) Method

    public void setOnMouseOut(String onmouseout)

Sets the onMouseOut javascript event.

#### Parameters

onmouseout
  - the onMouseOut event.

### setOnMouseOver(String) Method

    public void setOnMouseOver(String onmouseover)

Sets the onMouseOver javascript event.

#### Parameters

onmouseover
  - the onMouseOver event.

### setOnMouseUp(String) Method

    public void setOnMouseUp(String onmouseup)

Sets the onMouseUp javascript event.

#### Parameters

onmouseup
  - the onMouseUp event.

### setOnSelect(String) Method

    public void setOnSelect(String onselect)

Sets the onSelect javascript event.

#### Parameters

onselect
  - the onSelect event.

### setStyle(String) Method

    public void setStyle(String style)

Sets the style of the rendered html tag.

#### Parameters

style
  - the html style.

### setStyleClass(String) Method

    public void setStyleClass(String styleClass)

Sets the style class of the rendered html tag.

#### Parameters

styleClass
  - the html style class.

### setTabindex(String) Method

    public void setTabindex(String tabindex)

Sets the tabIndex of the rendered html tag.

#### Parameters

tabindex
  - the tab index.

### setTagId(String) Method

    public void setTagId(String tagId)

Set the ID of the tag.

#### Parameters

tagId
  - the tagId.

### setValue(String) Method

    public void setValue(String value)

Set the value of this CheckBoxOption.

#### Parameters

value
  - the CheckBoxOption value

### text() Method

    protected String text()
         throws JspException

Return the text to be displayed to the user for this checkboxoption (if any).

#### Exceptions

``JspException``
  if an error occurs