Apache Struts 2 Documentation > Home > Guides > Tag Developers Guide > Struts Tags > Tag Reference > UI Tag Reference > checkbox
Apache Struts 2 Documentation
checkbox
Edit Page   Browse Space   Add Page   Add News
Added by digi9ten, last edited by Don Brown on Jan 06, 2007  (view change)
Please make sure you have read the Tag Syntax document and understand how tag attribute syntax works.

Description

Renders an HTML input element of type checkbox, populated by the specified property from the ValueStack.

Parameters

Name

Required

Default

Evaluated

Type

Description
accesskey false true String Set the html accesskey attribute on rendered html element
cssClass false true String The css class to use for element
cssStyle false true String The css style definitions for element ro use
disabled false true String Set the html disabled attribute on rendered html element
fieldValue false true true String The actual HTML value attribute of the checkbox.
id false true String id for referencing element. For UI and form tags it will be used as HTML id attribute
key false true String Set the key (name, value, label) for this particular component
label false true String Label expression used for rendering a element specific label
labelposition false true String Define label position of form element (top/left)
name false true String The name to set for element
onblur false true String Set the html onblur attribute on rendered html element
onchange false true String Set the html onchange attribute on rendered html element
onclick false true String Set the html onclick attribute on rendered html element
ondblclick false true String Set the html ondblclick attribute on rendered html element
onfocus false true String Set the html onfocus attribute on rendered html element
onkeydown false true String Set the html onkeydown attribute on rendered html element
onkeypress false true String Set the html onkeypress attribute on rendered html element
onkeyup false true String Set the html onkeyup attribute on rendered html element
onmousedown false true String Set the html onmousedown attribute on rendered html element
onmousemove false true String Set the html onmousemove attribute on rendered html element
onmouseout false true String Set the html onmouseout attribute on rendered html element
onmouseover false true String Set the html onmouseover attribute on rendered html element
onmouseup false true String Set the html onmouseup attribute on rendered html element
onselect false true String Set the html onselect attribute on rendered html element
required false false true Boolean If set to true, the rendered element will indicate that input is required
requiredposition false true String Define required position of required form element (left|right)
tabindex false true String Set the html tabindex attribute on rendered html element
template false true String The template (other than default) to use for rendering the element
templateDir false true String The template directory.
theme false true String The theme (other than default) to use for rendering the element
title false true String Set the html title attribute on rendered html element
tooltip false true String Set the tooltip of this particular component
tooltipConfig false true String Set the tooltip configuration
value false true String Preset the value of input element.

Examples

JSP:
<s:checkbox label="checkbox test" name="checkboxField1" value="aBoolean" fieldValue="true"/>

Velocity:
#tag( Checkbox "label=checkbox test" "name=checkboxField1" "value=aBoolean" )

Resulting HTML (simple template, aBoolean == true):
<input type="checkbox" name="checkboxField1" value="true" checked="checked" />
Generated by Atlassian Confluence (Version: 2.2.9 Build: 527 Sep 07, 2006) AutoExport Plugin (Version: Unknown - PluginManager Error)