NAME

Krang::ElementClass::CheckBoxGroup - checkbox group element class

SYNOPSIS

  $class = pkg('ElementClass::CheckBoxGroup')->new(
                     name         => "alignment",
                     columns      => 3,
                     values       => [ 'center', 'left', 'right' ],
                     labels       => { center => "Centered",
                                       left   => "Left Aligned",
                                       right  => "Right Aligned" },
                     # use either values/labels OR list_group
                     list_group   => 'group_name',
                     defaults     => ['center'],
                    );

DESCRIPTION

Provides a checkbox element class.

INTERFACE

All the normal Krang::ElementClass attributes are available, plus:

• values
  
A reference to an array of values for the checkboxes.

This can also be a code reference that will return an array reference. This is really helpful when you don't know ahead of time what possible values might be in the list, or they might change based on other actions. This code reference will be called as a method in the element class with the same arguments that are passed to element class's input_form().

• labels
  
A reference to a hash mapping values to display names.

This can also be a code reference that will return a hash reference. This is really helpful when you don't know ahead of time what possible values might be in the list, or they might change based on other actions. This code reference will be called as a method in the element class with the same arguments that are passed to element class's input_form().

• list_group
  
Use the specified list group for the values and labels. If specified, this will override any values specified in the values and labels attributes. The current implementation uses the ListItems from the first List in the ListGroup. No support for multi-dimensional checkboxes.
• columns
  
You may specify how many columns should be used to display your checkboxes. For example, a two column display:

  [] Opt A    [] Opt E
  [] Opt B    [] Opt F
  [] Opt C    [] Opt G
  [] Opt D

Default is columns == 1.

• defaults
  
Array reference of default checkboxes which should be checked at the time of creation.