HTML::FormFu::Element - Element Base Class

    ---
    elements:
      - type: Text
        name: username
        constraints:
          - type: Required

      - type: Password
        name: password
        constraints:
          - type: Required
          - type: Equal
            others: repeat-password

      - type: Password
        name: repeat-password

      - type: Submit

Elements are the basic building block of all forms. Elements may be logical form-fields, blocks such as divs and fieldsets, non-blocks such as hrs and other special elements such as tables.

For simple, automatic handling of fieldsets see the auto_fieldset in HTML::FormFu setting.

See deflators in HTML::FormFu for details of Deflators.

See FORM LOGIC AND VALIDATION in HTML::FormFu for details of Filters, Constraints, Inflators, Validators and Transformers.

For field (HTML::FormFu::Element::_Field) element, this value is used as the name attribute which the field's value is associated with.

For all elements, the name value can be useful for identifying and retrieving specific elements.

Return Value: boolean

Returns true or false depending on whether the element is a logical form-field.

This is used by get_fields in HTML::FormFu.

Arguments: $filename

Arguments: \@filenames

Populate an element using a config file:

    ---
    elements:
      - type: Block
        load_config_file: 'elements.yml'

See load_config_file in HTML::FormFu for further details.

Arguments: $filestem

Arguments: \@filestems

Like load_config_file, but you shouldn't include the file extension in the passed string. This allows you to change your config-file type, without having to change the code that loads the files.

Arguments: $directory_name

config_file_path defines where configuration files will be searched for, if an absolute path is not given to load_config_file.

Default Value: not defined

This method is a special 'inherited accessor', which means it can be set on the form, a block element or a single element. When the value is read, if no value is defined it automatically traverses the element's hierarchy of parents, through any block elements and up to the form, searching for a defined value.

See config_callback in HTML::FormFu for details.

See populate in HTML::FormFu for details.

See stash in HTML::FormFu for details.

Returns the type argument originally used to create the element.

See render_processed_value in HTML::FormFu for details.

See force_errors in HTML::FormFu for details.

See specific element types for which tag attributes are added to.

Arguments: [%attributes]

Arguments: [\%attributes]

Return Value: $form

See attributes in HTML::FormFu for details.

attrs is an alias for attributes.

See attributes_xml in HTML::FormFu for details.

attrs_xml is an alias for attributes_xml.

Arguments: [%attributes]

Arguments: [\%attributes]

Return Value: $form

See add_attributes in HTML::FormFu for details.

add_attrs is an alias for add_attributes.

See add_attributes_xml in HTML::FormFu for details.

add_attrs_xml is an alias for add_attributes_xml.

Arguments: [%attributes]

Arguments: [\%attributes]

Return Value: $form

See del_attributes in HTML::FormFu for details.

del_attrs is an alias for del_attributes.

See del_attributes_xml in HTML::FormFu for details.

del_attrs_xml is an alias for del_attributes_xml.

The following methods are shortcuts for accessing attributes keys.

Arguments: [$id]

Return Value: $id

Get or set the element's DOM id.

Default Value: none

See HTML::FormFu::Model for further details and available models.

Arguments: \%config

This value identifies which template file should be used by render to render the element.

Arguments: $render

See prepare_id in HTML::FormFu::Element::_Field for details.

Arguments: $render

See prepare_attrs in HTML::FormFu::Element::_Field for details.

Return Value: $string

Returns the block element or form object that this element is attached to.

Arguments: \%options

    my $repeatable = $field->get_parent({ type => 'Repeatable' });

Traverses the parent hierarchy, returning the first parent that matches the supplied options.

Returns the HTML::FormFu object that the constraint's field is attached to.

See clone in HTML::FormFu for details.

See tt_args in HTML::FormFu for details.

See render_method in HTML::FormFu for details.

HTML::FormFu::Element::Button

HTML::FormFu::Element::Checkbox

HTML::FormFu::Element::Checkboxgroup

HTML::FormFu::Element::ComboBox

HTML::FormFu::Element::ContentButton

HTML::FormFu::Element::Date

HTML::FormFu::Element::File

HTML::FormFu::Element::Hidden

HTML::FormFu::Element::Image

HTML::FormFu::Element::Number

HTML::FormFu::Element::Password

HTML::FormFu::Element::Radio

HTML::FormFu::Element::Radiogroup

HTML::FormFu::Element::Reset

HTML::FormFu::Element::Select

HTML::FormFu::Element::Submit

HTML::FormFu::Element::Textarea

HTML::FormFu::Element::Text

HTML::FormFu::Element::Blank

HTML::FormFu::Element::Block

HTML::FormFu::Element::Fieldset

HTML::FormFu::Element::Hr

HTML::FormFu::Element::Label

HTML::FormFu::Element::Multi

HTML::FormFu::Element::Repeatable

HTML::FormFu::Element::SimpleTable

HTML::FormFu::Element::Src

The following are base classes for other elements, and generally needn't be used directly.

HTML::FormFu::Element::_Field

HTML::FormFu::Element::_Group

HTML::FormFu::Element::_Input

HTML::FormFu::Element::_MultiElement

HTML::FormFu::Element::_MultiSelect

HTML::FormFu::Element::_MultiText

HTML::FormFu::Element::_NonBlock

Has been removed; use default_args instead.

Carl Franks, cfranks@cpan.org

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