CheckboxTag

Class Overview

Databinding-aware JSP tag for rendering an HTML 'input' element with a 'type' of 'checkbox'.

May be used in one of three different approaches depending on the type of the bound value.

Approach One

When the bound value is of type Boolean then the 'input(checkbox)' is marked as 'checked' if the bound value is true. The 'value' attribute corresponds to the resolved value of the value property.

Approach Two

When the bound value is of type Collection then the 'input(checkbox)' is marked as 'checked' if the configured value is present in the bound Collection.

Approach Three

For any other bound value type, the 'input(checkbox)' is marked as 'checked' if the the configured value is equal to the bound value.

Summary

[Expand] Inherited Constants
From class org.springframework.web.servlet.tags.form.AbstractHtmlInputElementTag String ACCESSKEY_ATTRIBUTE The name of the 'accesskey' attribute. String DISABLED_ATTRIBUTE The name of the 'disabled' attribute. String ONBLUR_ATTRIBUTE The name of the 'onblur' attribute. String ONCHANGE_ATTRIBUTE The name of the 'onchange' attribute. String ONFOCUS_ATTRIBUTE The name of the 'onfocus' attribute. String READONLY_ATTRIBUTE The name of the 'readonly' attribute.
From class org.springframework.web.servlet.tags.form.AbstractHtmlElementTag String CLASS_ATTRIBUTE String DIR_ATTRIBUTE String LANG_ATTRIBUTE String ONCLICK_ATTRIBUTE String ONDBLCLICK_ATTRIBUTE String ONKEYDOWN_ATTRIBUTE String ONKEYPRESS_ATTRIBUTE String ONKEYUP_ATTRIBUTE String ONMOUSEDOWN_ATTRIBUTE String ONMOUSEMOVE_ATTRIBUTE String ONMOUSEOUT_ATTRIBUTE String ONMOUSEOVER_ATTRIBUTE String ONMOUSEUP_ATTRIBUTE String STYLE_ATTRIBUTE String TABINDEX_ATTRIBUTE String TITLE_ATTRIBUTE
From class org.springframework.web.servlet.tags.form.AbstractDataBoundFormElementTag String NESTED_PATH_VARIABLE_NAME Name of the exposed path variable within the scope of this tag: "nestedPath".
From class org.springframework.web.servlet.tags.RequestContextAwareTag String REQUEST_CONTEXT_PAGE_ATTRIBUTE javax.servlet.jsp.PageContext attribute for the page-level RequestContext instance.

[Expand] Inherited Fields
From class org.springframework.web.servlet.tags.form.AbstractDataBoundFormElementTag public static final String COMMAND_NAME_VARIABLE_NAME This field is deprecated. as of Spring 2.5, in favor of MODEL_ATTRIBUTE_VARIABLE_NAME
From class org.springframework.web.servlet.tags.RequestContextAwareTag protected final Log logger Logger available to subclasses

Public Constructors
	CheckboxTag()

Protected Methods
int	writeTagContent(TagWriter tagWriter) Renders the 'input(radio)' element with the configured value.
void	writeTagDetails(TagWriter tagWriter) Write the details for the given primary tag: i.e.

[Expand] Inherited Methods
From class org.springframework.web.servlet.tags.form.AbstractSingleCheckedElementTag Object getLabel() Get the value of the 'label' attribute. Object getValue() Get the value of the 'value' attribute. void setLabel(Object label) Set the value of the 'label' attribute. void setValue(Object value) Set the value of the 'value' attribute. int writeTagContent(TagWriter tagWriter) Renders the 'input(radio)' element with the configured value. abstract void writeTagDetails(TagWriter tagWriter) Write the details for the given primary tag: i.e.
From class org.springframework.web.servlet.tags.form.AbstractCheckedElementTag String autogenerateId() Return a unique ID for the bound name within the current PageContext. void renderFromBoolean(Boolean boundValue, TagWriter tagWriter) Render the 'input(checkbox)' with the supplied value, marking the 'input' element as 'checked' if the supplied Boolean is true. void renderFromValue(Object value, TagWriter tagWriter) Render the 'input(checkbox)' with the supplied value, marking the 'input' element as 'checked' if the supplied value matches the bound value. void renderFromValue(Object item, Object value, TagWriter tagWriter) Render the 'input(checkbox)' with the supplied value, marking the 'input' element as 'checked' if the supplied value matches the bound value. abstract int writeTagContent(TagWriter tagWriter) Writes the 'input' element to the supplied TagWriter, marking it as 'checked' if appropriate.
From class org.springframework.web.servlet.tags.form.AbstractHtmlInputElementTag String getAccesskey() Get the value of the 'accesskey' attribute. String getDisabled() Get the value of the 'disabled' attribute. String getOnblur() Get the value of the 'onblur' attribute. String getOnchange() Get the value of the 'onchange' attribute. String getOnfocus() Get the value of the 'onfocus' attribute. String getReadonly() Gets the value of the 'readonly' attribute. boolean isDisabled() Is the current HTML tag disabled? boolean isReadonly() Is the current HTML tag readonly? Note: some AbstractHtmlInputElementTag subclasses (such a those for checkboxes and radiobuttons) may contain readonly attributes, but are not affected by them since their values don't change (only their status does.) void setAccesskey(String accesskey) Set the value of the 'accesskey' attribute. void setDisabled(String disabled) Set the value of the 'disabled' attribute. void setOnblur(String onblur) Set the value of the 'onblur' attribute. void setOnchange(String onchange) Set the value of the 'onchange' attribute. void setOnfocus(String onfocus) Set the value of the 'onfocus' attribute. void setReadonly(String readonly) Sets the value of the 'readonly' attribute. void writeOptionalAttributes(TagWriter tagWriter) Adds input-specific optional attributes as defined by this base class.
From class org.springframework.web.servlet.tags.form.AbstractHtmlElementTag String getCssClass() Get the value of the 'class' attribute. String getCssErrorClass() The CSS class to use when the field bound to a particular tag has errors. String getCssStyle() Get the value of the 'style' attribute. String getDir() Get the value of the 'dir' attribute. Map<String, Object> getDynamicAttributes() Get the map of dynamic attributes. String getLang() Get the value of the 'lang' attribute. String getOnclick() Get the value of the 'onclick' attribute. String getOndblclick() Get the value of the 'ondblclick' attribute. String getOnkeydown() Get the value of the 'onkeydown' attribute. String getOnkeypress() Get the value of the 'onkeypress' attribute. String getOnkeyup() Get the value of the 'onkeyup' attribute. String getOnmousedown() Get the value of the 'onmousedown' attribute. String getOnmousemove() Get the value of the 'onmousemove' attribute. String getOnmouseout() Get the value of the 'onmouseout' attribute. String getOnmouseover() Get the value of the 'onmouseover' attribute. String getOnmouseup() Get the value of the 'onmouseup' attribute. String getTabindex() Get the value of the 'tabindex' attribute. String getTitle() Get the value of the 'title' attribute. String resolveCssClass() Gets the appropriate CSS class to use based on the state of the current BindStatus object. void setCssClass(String cssClass) Set the value of the 'class' attribute. void setCssErrorClass(String cssErrorClass) The CSS class to use when the field bound to a particular tag has errors. void setCssStyle(String cssStyle) Set the value of the 'style' attribute. void setDir(String dir) Set the value of the 'dir' attribute. void setDynamicAttribute(String uri, String localName, Object value) void setLang(String lang) Set the value of the 'lang' attribute. void setOnclick(String onclick) Set the value of the 'onclick' attribute. void setOndblclick(String ondblclick) Set the value of the 'ondblclick' attribute. void setOnkeydown(String onkeydown) Set the value of the 'onkeydown' attribute. void setOnkeypress(String onkeypress) Set the value of the 'onkeypress' attribute. void setOnkeyup(String onkeyup) Set the value of the 'onkeyup' attribute. void setOnmousedown(String onmousedown) Set the value of the 'onmousedown' attribute. void setOnmousemove(String onmousemove) Set the value of the 'onmousemove' attribute. void setOnmouseout(String onmouseout) Set the value of the 'onmouseout' attribute. void setOnmouseover(String onmouseover) Set the value of the 'onmouseover' attribute. void setOnmouseup(String onmouseup) Set the value of the 'onmouseup' attribute. void setTabindex(String tabindex) Set the value of the 'tabindex' attribute. void setTitle(String title) Set the value of the 'title' attribute. void writeDefaultAttributes(TagWriter tagWriter) Writes the default attributes configured via this base class to the supplied TagWriter. void writeOptionalAttributes(TagWriter tagWriter) Writes the optional attributes configured via this base class to the supplied TagWriter.
From class org.springframework.web.servlet.tags.form.AbstractDataBoundFormElementTag String autogenerateId() Autogenerate the 'id' attribute value for this tag. String convertToDisplayString(Object value) Get a display String for the given value, converted by a PropertyEditor that the BindStatus may have registered for the value's Class. void doFinally() Disposes of the BindStatus instance. BindStatus getBindStatus() Get the BindStatus for this tag. final Object getBoundValue() Get the bound value. final PropertyEditor getEditor() Exposes the PropertyEditor for EditorAwareTag. String getId() Get the value of the 'id' attribute. String getName() Get the value for the HTML 'name' attribute. String getNestedPath() Get the value of the nested path that may have been exposed by the NestedPathTag. final String getPath() Get the resolved property path for the form object. PropertyEditor getPropertyEditor() Get the PropertyEditor, if any, in use for value bound to this tag. String getPropertyPath() Build the property path for this tag, including the nested path but not prefixed with the name of the form attribute. String resolveId() Determine the 'id' attribute value for this tag, autogenerating one if none specified. void setId(String id) Set the value of the 'id' attribute. void setPath(String path) Set the property path from the form object. void writeDefaultAttributes(TagWriter tagWriter) Writes the default set of attributes to the supplied TagWriter.
From class org.springframework.web.servlet.tags.form.AbstractFormTag TagWriter createTagWriter() Create the TagWriter which all output will be written to. final int doStartTagInternal() Provide a simple template method that calls createTagWriter() and passes the created TagWriter to the writeTagContent(TagWriter) method. Object evaluate(String attributeName, Object value) Evaluate the supplied value for the supplied attribute name. boolean evaluateBoolean(String attributeName, String value) Evaluate the supplied value for the supplied attribute name. String getDisplayString(Object value, PropertyEditor propertyEditor) Get the display value of the supplied Object, HTML escaped as required. String getDisplayString(Object value) Get the display value of the supplied Object, HTML escaped as required. boolean isDefaultHtmlEscape() Overridden to default to true in case of no explicit default given. final void writeOptionalAttribute(TagWriter tagWriter, String attributeName, String value) Optionally writes the supplied value under the supplied attribute name into the supplied TagWriter. abstract int writeTagContent(TagWriter tagWriter) Subclasses should implement this method to perform tag content rendering.
From class org.springframework.web.servlet.tags.HtmlEscapingAwareTag boolean isDefaultHtmlEscape() Return the applicable default HTML escape setting for this tag. boolean isHtmlEscape() Return the HTML escaping setting for this tag, or the default setting if not overridden. void setHtmlEscape(String htmlEscape) Set HTML escaping for this tag, as boolean value.
From class org.springframework.web.servlet.tags.RequestContextAwareTag void doCatch(Throwable throwable) void doFinally() final int doStartTag() Create and expose the current RequestContext. abstract int doStartTagInternal() Called by doStartTag to perform the actual work. final RequestContext getRequestContext() Return the current RequestContext.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface org.springframework.web.servlet.tags.EditorAwareTag abstract PropertyEditor getEditor() Retrieve the PropertyEditor for the property that this tag is currently bound to.