org.springframework.web.servlet.tags.form

Class CheckboxTag

  • All Implemented Interfaces:
    java.io.Serializable, DynamicAttributes, IterationTag, JspTag, Tag, TryCatchFinally, EditorAwareTag


    public class CheckboxTag
    extends AbstractSingleCheckedElementTag
    The <checkbox> tag renders an HTML 'input' tag with type '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 configured value is equal to the bound value.

    Attribute Summary
    Attribute Required? Runtime Expression? Description

    accesskey

    false

    true

    HTML Standard Attribute

    cssClass

    false

    true

    HTML Optional Attribute

    cssErrorClass

    false

    true

    HTML Optional Attribute. Used when the bound field has errors.

    cssStyle

    false

    true

    HTML Optional Attribute

    dir

    false

    true

    HTML Standard Attribute

    disabled

    false

    true

    HTML Optional Attribute. Setting the value of this attribute to 'true' will disable the HTML element.

    htmlEscape

    false

    true

    Enable/disable HTML escaping of rendered values.

    id

    false

    true

    HTML Standard Attribute

    label

    false

    true

    Value to be displayed as part of the tag

    lang

    false

    true

    HTML Standard Attribute

    onblur

    false

    true

    HTML Event Attribute

    onchange

    false

    true

    HTML Event Attribute

    onclick

    false

    true

    HTML Event Attribute

    ondblclick

    false

    true

    HTML Event Attribute

    onfocus

    false

    true

    HTML Event Attribute

    onkeydown

    false

    true

    HTML Event Attribute

    onkeypress

    false

    true

    HTML Event Attribute

    onkeyup

    false

    true

    HTML Event Attribute

    onmousedown

    false

    true

    HTML Event Attribute

    onmousemove

    false

    true

    HTML Event Attribute

    onmouseout

    false

    true

    HTML Event Attribute

    onmouseover

    false

    true

    HTML Event Attribute

    onmouseup

    false

    true

    HTML Event Attribute

    path

    true

    true

    Path to property for data binding

    tabindex

    false

    true

    HTML Standard Attribute

    title

    false

    true

    HTML Standard Attribute

    value

    false

    true

    HTML Optional Attribute

    Since:
    2.0
    Author:
    Rob Harrop, Juergen Hoeller
    See Also:
    Serialized Form