com.opensymphony.webwork.components
Class Checkbox

java.lang.Object
  extended by com.opensymphony.webwork.components.Component
      extended by com.opensymphony.webwork.components.UIBean
          extended by com.opensymphony.webwork.components.Checkbox

public class Checkbox
extends UIBean

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

Examples

 
 FREEMARKER:
 <@ww.checkbox label="checkbox" name="checkboxField1" value="aBoolean" fieldValue="true" />

 JSP:
 <ww: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" />

 
 

Since:
2.2
Version:
$Revision: 2961 $
Author:
Patrick Lightbody, Rene Gielen

Field Summary
protected  String fieldValue
           
static String TEMPLATE
           
 
Fields inherited from class com.opensymphony.webwork.components.UIBean
accesskey, cssClass, cssStyle, disabled, label, labelPosition, name, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onmousedown, onmousemove, onmouseout, onmouseover, onmouseup, onselect, request, required, requiredposition, response, tabindex, template, templateDir, templateSuffix, theme, title, tooltip, tooltipConfig, value
 
Fields inherited from class com.opensymphony.webwork.components.Component
COMPONENT_STACK, id, parameters, stack
 
Constructor Summary
Checkbox(OgnlValueStack stack, HttpServletRequest request, HttpServletResponse response)
           
 
Method Summary
protected  void evaluateExtraParams()
           
protected  String getDefaultTemplate()
          A contract that requires each concrete UI Tag to specify which template should be used as a default.
protected  Class getValueClassType()
           
 void setFieldValue(String fieldValue)
          The actual HTML value attribute of the checkbox.
 
Methods inherited from class com.opensymphony.webwork.components.UIBean
addFormParameter, buildTemplateName, enableAncestorFormCustomOnsubmit, end, escape, evaluateNameValue, evaluateParams, getTemplate, getTemplateDir, getTheme, getTooltipConfig, mergeTemplate, populateComponentHtmlId, setAccesskey, setCssClass, setCssStyle, setDisabled, setLabel, setLabelposition, setLabelPosition, setName, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setRequired, setRequiredposition, setTabindex, setTemplate, setTemplateDir, setTheme, setTitle, setTooltip, setTooltipConfig, setValue
 
Methods inherited from class com.opensymphony.webwork.components.Component
addAllParameters, addParameter, altSyntax, copyParams, determineActionURL, determineNamespace, end, fieldError, findAncestor, findString, findString, findValue, findValue, findValue, getComponentStack, getId, getParameters, getStack, popComponentStack, setId, start, toString, usesBody
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TEMPLATE

public static final String TEMPLATE
See Also:
Constant Field Values

fieldValue

protected String fieldValue
Constructor Detail

Checkbox

public Checkbox(OgnlValueStack stack,
                HttpServletRequest request,
                HttpServletResponse response)
Method Detail

getDefaultTemplate

protected String getDefaultTemplate()
Description copied from class: UIBean
A contract that requires each concrete UI Tag to specify which template should be used as a default. For example, the CheckboxTab might return "checkbox.vm" while the RadioTag might return "radio.vm". This value not begin with a '/' unless you intend to make the path absolute rather than relative to the current theme.

Specified by:
getDefaultTemplate in class UIBean
Returns:
The name of the template to be used as the default.

evaluateExtraParams

protected void evaluateExtraParams()
Overrides:
evaluateExtraParams in class UIBean

getValueClassType

protected Class getValueClassType()
Overrides:
getValueClassType in class UIBean

setFieldValue

public void setFieldValue(String fieldValue)
The actual HTML value attribute of the checkbox.


WebWork Project Page