Carl Franks > HTML-FormFu-2.01 > HTML::FormFu::Element::ComboBox

Download:
HTML-FormFu-2.01.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  12
Open  4
Stalled  1
View/Report Bugs
Module Version: 2.01   Source  

NAME ^

HTML::FormFu::Element::ComboBox - Select / Text hybrid

SYNOPSIS ^

    ---
    elements:
      - type: ComboBox
        name: answer
        label: 'Select yes or no, or write an alternative:'
        values:
          - yes
          - no

DESCRIPTION ^

Creates a multi element containing a Select field and a Text field.

A ComboBox element named foo would result in a Select menu named foo_select and a Text field named foo_text. The names can instead be overridden by the name value in "select" and "text".

If a value is submitted for the Text field, this will be used in preference to any submitted value for the Select menu.

You can access the submitted value by using the ComboBox's name:

    my $value = $form->param_value('foo');

METHODS ^

default

If the value matches one of the Select menu's options, that options will be selected. Otherwise, the Text field will use the value as its default.

options

See "options" in HTML::FormFu::Role::Element::Group for details.

values

See "values" in HTML::FormFu::Role::Element::Group for details.

value_range

See "value_range" in HTML::FormFu::Role::Element::Group for details.

empty_first

See "empty_first" in HTML::FormFu::Role::Element::Group for details.

empty_first_label

See "empty_first_label" in HTML::FormFu::Role::Element::Group for details.

select

Arguments: \%setting

Set values effecting the Select menu. Known keys are:

name

Override the auto-generated name of the select menu.

text

Arguments: \%setting

Set values effecting the Text field. Known keys are:

name

Override the auto-generated name of the select menu.

CAVEATS ^

Although this element inherits from HTML::FormFu::Element::Block, its behaviour for the methods filter/filters, constraint/constraints, inflator/inflators, validator/validators and transformer/transformers is more like that of a field element, meaning all processors are added directly to the date element, not to its child elements.

This element's get_elements and get_all_elements are inherited from HTML::FormFu::Element::Block, and so have the same behaviour. However, it overrides the get_fields|HTML::FormFu/get_fields method, such that it returns both itself and its child elements.

SEE ALSO ^

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

HTML::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.

syntax highlighting: