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.
div
fieldset
hr
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 element, this value is used as the name attribute which the field's value is associated with.
name
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.
true
false
This is used by "get_fields" in HTML::FormFu.
See "load_config_file" in HTML::FormFu for details.
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.
type
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".
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".
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"" in " keys.
Arguments: [$id]
Return Value: $id
Get or set the element's DOM id.
Default Value: none
This value identifies which template file should be used by "xhtml" in HTML::FormFu::Render::base to render the element.
This value identifies which template file should be used to render the element when the element is within a multi element.
This value is generally either multi_ltr or multi_rtl depending on whether the field and label should be displayed from left-to-right or right-to-left.
multi_ltr
multi_rtl
Arguments: $render
See "prepare_id" in HTML::FormFu::Element::_Field for details.
See "prepare_attrs" in HTML::FormFu::Element::_Field for details.
Return Value: $render_object
Returns a $render object which can either be printed, or used for more advanced custom rendering.
$render
Using an $element object in string context (for example, printing it) automatically calls "render".
$element
The default base-class of the returned render object is HTML::FormFu::Render::Element.
Returns the HTML::FormFu::Element or HTML::FormFu object that this element is attached to.
Returns the HTML::FormFu object that this element is attached to.
See "clone" in HTML::FormFu for details.
See "render_class" in HTML::FormFu for details.
See "render_class_prefix" in HTML::FormFu for details.
See "render_class_suffix" in HTML::FormFu for details.
See "render_class_args" in HTML::FormFu for details.
See "render_method" in HTML::FormFu for details.
The following are base classes for other elements, and generally needn't be used directly.
Carl Franks, cfranks@cpan.org
cfranks@cpan.org
This library is free software, you can redistribute it and/or modify it under the same terms as Perl itself.
To install HTML::FormFu, copy and paste the appropriate command in to your terminal.
cpanm
cpanm HTML::FormFu
CPAN shell
perl -MCPAN -e shell install HTML::FormFu
For more information on module installation, please visit the detailed CPAN module installation guide.