Please make sure you have read the Tag Syntax document and understand how tag attribute syntax works.
Important

Note that the listkey and listvalue attribute will default to "key" and "value" respectively only when the list attribute is evaluated to a Map or its decendant. Other thing else, will result in listkey and listvalue to be null and not used.

Description

Creates a series of checkboxes from a list. Setup is like <ww:select /> or <ww:radio />, but creates checkbox tags.

Parameters

Name

Required

Default

Type

Description

list true   Object/String Iterable source to populate from. If the list is a Map (key, value), the Map key will become the option "value" parameter and the Map value will become the option body.
listKey false   Object/String Property of list objects to get field value from
listValue false   Object/String Property of list objects to get field content from
theme false   Object/String The theme (other than default) to use for rendering the element
templateDir false   Object/String The template directory (other than default) to used to find the themes and hence the template.
template false   Object/String The template (other than default) to use for rendering the element
cssClass false   Object/String The css class to use for element
cssStyle false   Object/String The css style definitions for element ro use
title false   Object/String Set the html title attribute on rendered html element
disabled false   Object/String Set the html disabled attribute on rendered html element
label false   Object/String Label expression used for rendering a element specific label
labelPosition false left Object/String deprecated.
labelposition false   Object/String define label position of form element (top/left)
requiredposition false   Object/String define required position of required form element (left|right)
name false   Object/String The name to set for element
required false false Boolean If set to true, the rendered element will indicate that input is required
tabindex false   Object/String Set the html tabindex attribute on rendered html element
value false   Object/String Preset the value of input element.
onclick false   Object/String Set the html onclick attribute on rendered html element
ondblclick false   Object/String Set the html ondblclick attribute on rendered html element
onmousedown false   Object/String Set the html onmousedown attribute on rendered html element
onmouseup false   Object/String Set the html onmouseup attribute on rendered html element
onmouseover false   Object/String Set the html onmouseover attribute on rendered html element
onmousemove false   Object/String Set the html onmousemove attribute on rendered html element
onmouseout false   Object/String Set the html onmouseout attribute on rendered html element
onfocus false   Object/String Set the html onfocus attribute on rendered html element
onblur false   Object/String Set the html onblur attribute on rendered html element
onkeypress false   Object/String Set the html onkeypress attribute on rendered html element
onkeydown false   Object/String Set the html onkeydown attribute on rendered html element
onkeyup false   Object/String Set the html onkeyup attribute on rendered html element
onselect false   Object/String Set the html onselect attribute on rendered html element
onchange false   Object/String Set the html onchange attribute on rendered html element
accesskey false   Object/String Set the html accesskey attribute on rendered html ekement
tooltip false String Set the tooltip of this particular component
tooltipConfig false String Set the tooltip configuration
id false   Object/String id for referencing element. For UI and form tags it will be used as HTML id attribute

Examples

<ww:checkboxlist name="foo" list="bar"/>

It is possible to select multiple checkboxes, by handling a List into the value attribute. The List passed into the value attribute could be :-

  • key if the list attribute is passed in is a Map
  • listKey properties if listKey attribute is used
  • entry/entries passed into the list attribute

<ww:checkboxlist name="options" 
                             list="%{#{'FOO':'foo','BAR':'bar','BAZ':'baz','BOO':'boo'}}" 
                             value="%{{'FOO','BAZ'}}" />
                             
<ww:checkboxlist name="options"
                             list="%{{'Foo','Bar','Baz'}}"
                             value="%{{'Foo','Bar'}}" />
                             
 public class MyAction extends ActionSupport {
      public List<Choice> getChoices() {
         .... 
      }
      ....                       
      public List<String> getPreSelectedChoices() {
         // returns a list of Choice.getKey(), which is a String
         ....
      }
 }     
  
 public class Choice {
     public String getKey() { ...}
     public String getDisplayName() { ... }
     ....
 }
 
 <ww:checkboxlist name="myChoice"
                              list="%{choices}"
                              listKey="%{'key'}"
                              listValue="%{'displayName'}"
                              value="%{preSelectedChoices}" />