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


HTML-FormFu documentation  | view source Contained in the HTML-FormFu distribution.

Index


NAME

Top

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

SYNOPSIS

Top

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




DESCRIPTION

Top

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

Top

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::Element::_Group for details.

values

See values in HTML::FormFu::Element::_Group for details.

value_range

See value_range in HTML::FormFu::Element::_Group for details.

empty_first

See empty_first in HTML::FormFu::Element::_Group for details.

empty_first_label

See empty_first_label in HTML::FormFu::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

Top

Although this element inherits from HTML::FormFu::Element::Block, its behaviour for the methods filters|HTML::FormFu/filters in filter (filters|HTML::FormFu/filters in filter), constraints|HTML::FormFu/constraints in constraint (constraints|HTML::FormFu/constraints in constraint), inflators|HTML::FormFu/inflators in inflator (inflators|HTML::FormFu/inflators in inflator), validators|HTML::FormFu/validators in validator (validators|HTML::FormFu/validators in validator) and transformers|HTML::FormFu/transformers in transformer (transformers|HTML::FormFu/transformers in transformer) is more like that of a field element (HTML::FormFu::Element::_Field), 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

Top

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

HTML::FormFu

AUTHOR

Top

Carl Franks, cfranks@cpan.org

LICENSE

Top

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


HTML-FormFu documentation  | view source Contained in the HTML-FormFu distribution.