NAME

Krang::ElementClass::ListBox - list box element class

SYNOPSIS

  $class = pkg('ElementClass::ListBox')->new(name         => "color",
                                             size         => 1,
                     values       => [ 'red', 'white', 'blue' ],
                     labels       => { red   => "Red",
                                       white => "White",
                                       blue  => "Blue" }.
                     default      => [ 'white' ],
                    );

DESCRIPTION

Provides a list menu element class. Otherwise known as a select box in HTML, but differentiated from Krang::ElementClass::ListBox by the fact that it never allows more than one option to be selected.

Elements using this class must contain references to arrays in data(), even if multiple is 0.

INTERFACE

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

• size
  
The size of the select box on the edit screen. Defaults to 5. Setting this to 1 will create a popup menu, but it's better to use Krang::ElementClass::PopupMenu for that.
• multiple
  
Set to true to allow multiple items to be selected at once. Default to 0. You must set size greater than 1 if you set multiple true.
• values
  
A reference to an array of values for the select box.

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().