NAME

HTML::FormFu::Element::_Group - grouped form field base-class

DESCRIPTION

Base class for HTML::FormFu::Element::Radiogroup and HTML::FormFu::Element::Select fields.

METHODS

options

Arguments: \@options

    ---
    elements:
      - type: Select
        name: foo
        options:
          - [ 01, January ]
          - [ 02, February ]
          - value: 03
            label: March
            attributes:
              style: highlighted
          - [ 04, April ]

Use to set the list of items in the select menu / radiogroup.

It's arguments must be an array-ref of items. Each item may be an array ref of the form [ $value, $label ] or a hash-ref of the form { value => $value, label => $label }. Each hash-ref may also have the keys attributes and label_attributes.

Passing an item containing a group key will, for Select fields, create an optgroup. And for RadioGroup fields, create a sub-group of radiobuttons with a new span block, with the classname subgroup.

An example of Select optgroups:

    ---
    elements:
      - type: Select
        name: foo
        options:
          - label: "group 1"
            group:
              - [1a, 'item 1a']
              - [1b, 'item 1b']
          - label: "group 2"
            group:
              - [2a, 'item 2a']
              - [2b, 'item 2b']

The usage of label_loc instead of label is supported to translate a given string. label_loc is supported for items and option groups.

values

Arguments: \@values

    ---
    elements:
      - type: Radiogroup
        name: foo
        values:
          - jan
          - feb
          - mar
          - apr

A more concise alternative to "options". Use to set the list of values in the select menu / radiogroup.

It's arguments must be an array-ref of values. The labels used are the result of ucfirst($value).

value_range

Arguments: \@values

    ---
    elements:
      - type: Select
        name: foo
        value_range:
          - ""
          - 1
          - 12 

Similar to "values", but the last 2 values are expanded to a range. Any preceeding values are used literally, allowing the common empty first item in select menus.

empty_first

If true, then a blank option will be inserted at the start of the option list (regardless of whether "options", "values" or "value_range" was used to populate the options).

SEE ALSO

Is a sub-class of, and inherits methods from HTML::FormFu::Element::_Field, HTML::FormFu::Element

HTML::FormFu::FormFu

AUTHOR

Carl Franks, cfranks@cpan.org

LICENSE

This library is free software, you can redistribute it and/or modify it under the same terms as Perl itself.