Class Checklist

  • All Implemented Interfaces:
    ClientElement, Field

    public class Checklist
    extends AbstractField
    A list of checkboxes, allowing selection of multiple items in a list. For an alternative component that can be used for similar purposes, see Palette.
    See Also:
    Form, Palette
    Component Parameters 
    NameTypeFlagsDefaultDefault Prefix
    clientIdString  literal
    Used to explicitly set the client-side id of the element for this component. Normally this is not bound (or null) and is used to generate a unique client-id based on the component's id. In some cases, when creating client-side behaviors, it is useful to explicitly set a unique id for an element using this parameter. Certain values, such as "submit", "method", "reset", etc., will cause client-side conflicts and are not allowed; using such will cause a runtime exception.
    encoderorg.apache.tapestry5.ValueEncoderRequired, Not Null prop
    A ValueEncoder used to convert server-side objects (provided from the "source" parameter) into unique client-side strings (typically IDs) and back. Note: this component does NOT support ValueEncoders configured to be provided automatically by Tapestry.
    ensureClientIdUniquebooleanSince 5.4 prop
    A rarely used option that indicates that the actual client id should start with the clientId parameter (if non-null) but should still pass that Id through to generate the final id. An example of this are the components used inside a org.apache.tapestry5.corelib.components.BeanEditor which will specify a clientId (based on the property name) but still require that it be unique. Defaults to false.
    modelorg.apache.tapestry5.SelectModelRequired prop
    Model used to define the values and labels used when rendering the checklist.
    selectedjava.util.ListRequired prop
    The list of selected values from the org.apache.tapestry5.SelectModel. This will be updated when the form is submitted. If the value for the parameter is null, a new list will be created, otherwise the existing list will be cleared. If unbound, defaults to a property of the container matching this component's id.
    validateorg.apache.tapestry5.FieldValidator  validate
    The object that will perform input validation. The validate binding prefix is generally used to provide this object in a declarative fashion.


    For this example, we'll implement a page from an e-commerce order wizard; the page collects information about special handling for the order:

    Now let's see how the component can be used.

    public enum SpecialHandling

    In this contrived example, the possible types of special handling are defined using an enum. It's more likely, in the real world, that this would be defined in terms of a database entity.


    <html xmlns:t="">
            <h1>Special Handling</h1>
                <t:checklist t:id="handling" encoder="encoder" model="model"/>
                <input type="submit" value="Continue"/>

    Here we are able to omit the selected parameter (the list of selected items) because the Checklist component's id matches a property of the page.

    The model parameter will define the available options that can be selected. The encoder parameter will define how to translate server side values (the enum values) into client side strings and back.

    public class OrderHandling {
        private List<SpecialHandling> handling;
        private Messages messages;
        public ValueEncoder getEncoder() {
            return new EnumValueEncoder(SpecialHandling.class);
        public SelectModel getModel() {
            return new EnumSelectModel(SpecialHandling.class, messages);

    Tapestry has built-in public classes that help convert enum types into value encoders and select models.

    Injecting a Messages object gives a component access to its own message catalog.

    The Checklist component will read the handling property when rendering (it's ok for it to be null). When the form is submitted, it will create a new List and update the handling property.


    The Checklist component can be customized through CSS. Following CSS rules are used:

    Each checkbox and its label is enclosed by a div element whose css attribute is set to t-checklist-row.
    • Method Detail

      • processSubmission

        protected void processSubmission​(String controlName)
        Description copied from class: AbstractField
        Method implemented by subclasses to actually do the work of processing the submission of the form. The element's controlName property will already have been set. This method is only invoked if the field is not disabled.
        Specified by:
        processSubmission in class AbstractField
        controlName - the control name of the rendered element (used to find the correct parameter in the request)
      • isRequired

        public boolean isRequired()
        Description copied from class: AbstractField
        Returns false; most components do not support declarative validation.
        Specified by:
        isRequired in interface Field
        isRequired in class AbstractField
        true if a non-blank value is required for the field