NAME

HTML::Widget::Plugin::Multiselect - widget for multiple selections from a list

VERSION

version 0.204

SYNOPSIS

  $widget_factory->multiselect({
    id      => 'multiopts', # if no name attr given, defaults to id value
    size    => 3,
    values  => [ 'value_1', 'value_3' ],
    options => [
      [ value_1 => 'Display Name 1' ],
      [ value_2 => 'Display Name 2' ],
      [ value_3 => 'Display Name 3' ],
    ],
  });

DESCRIPTION

This plugin provides a select-from-list widget that allows the selection of multiple elements.

METHODS

provided_widgets

This plugin provides the following widgets: multiselect

multiselect

This method returns a multiple-selection-from-list widget. Yup.

In addition to the generic HTML::Widget::Plugin attributes and the HTML::Widget::Plugin::Select attributes, the following are valid arguments:

size

This is the number of elements that should be visible in the widget.

make_option

This method, subclassed from the standard select widget, expects that $value will be an array of selected values.

validate_value

This method checks whether the given value option is valid. It throws an exception if the given values are not all in the list of options.

AUTHOR

Ricardo SIGNES

COPYRIGHT AND LICENSE

This software is copyright (c) 2005 by Ricardo SIGNES.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.