Help-Site Computer Manuals
Software
Hardware
Programming
Networking
  Algorithms & Data Structures   Programming Languages   Revision Control
  Protocols
  Cameras   Computers   Displays   Keyboards & Mice   Motherboards   Networking   Printers & Scanners   Storage
  Windows   Linux & Unix   Mac

/var/sites/help-site.com/auto/tmp/CPAN/9677/HTML-FormFu-0.02002/lib/HTML/FormFu/Element/_Field.pm

/var/sites/help-site.com/auto/tmp/CPAN/9677/HTML-FormFu-0.02002/lib/HTML/FormFu/Element/_Field.pm


NAME

HTML::FormFu::Element::_Field


DESCRIPTION

Base-class for all form-field elements.


METHODS

default

Set the form-field's default value.

default_xml

Arguments: $string

If you don't want the default value to be XML-escaped, use the default_xml method instead of </default>.

default_loc

Arguments: $localization_key

Set the default value using a L10N key.

value

For most fields, value is an alias for default.

For the the HTML::FormFu::Element::Checkbox manpage and the HTML::FormFu::Element::Radio manpage elements, value sets what the value of the field will be if it is checked or selected. If the default is the same as the value, then the field will be checked or selected when rendered.

For the the HTML::FormFu::Element::Radiogroup manpage and the HTML::FormFu::Element::Select manpage elements, the value is ignored: /values or /options provides the equivalent function.

value_xml

Arguments: $string

If you don't want the value to be XML-escaped, use the value_xml method instead of </value>.

value_loc

Arguments: $localization_key

Set the value using a L10N key.

non_param

Arguments: bool

If true, values for this field are never returned by params in the HTML::FormFu manpage, param in the HTML::FormFu manpage and valid in the HTML::FormFu manpage.

This is useful for Submit buttons, when you only use its value as an indicator.

Default Value: false

label

Set a label to communicate the purpose of the form-field to the user.

label_xml

Arguments: $string

If you don't want the label to be XML-escaped, use the label_xml method instead of </label>.

label_loc

Arguments: $localization_key

Set the label using a L10N key.

comment

Set a comment to be displayed along with the form-field.

comment_xml

Arguments: $string

If you don't want the comment to be XML-escaped, use the comment_xml method instead of </comment>.

comment_loc

Arguments: $localization_key

Set the comment using a L10N key.

container_tag

Set which tag-name should be used to contain the various field parts (field, label, comment, errors, etc.).

Default Value: 'span'

javascript

Arguments: [$javascript]

If set, the contents will be rendered within a script tag, within the field's container.

retain_default

If retain_default is true and the form was submitted, but the field didn't have a value submitted, then when the form is redisplayed to the user the field will have it's value set to it's default value , rather than the usual behaviour of having an empty value.

Default Value: false

force_default

If force_default is true and the form was submitted, and the field has a default/value set, then when the form is redisplayed to the user the field will have it's value set to it's default value.

If the default value is being changed after FormFu->process is being called the later default value is respected for rendering, *but* nevertheless the input value doesn't respect that, it will remain the first value.

Default Value: false

reverse_multi

If true, then when the field is used within a Multi block, the field's label should be rendered to the right of the field control

The default value is false, causing the label to be rendered to the left of the field control (or to be explicit: the markup for the label comes before the field control in the source).

Default Value: false

clone

See clone in the HTML::FormFu manpage for details.

deflators

See deflators in the HTML::FormFu manpage for details.

deflator

See deflator in the HTML::FormFu manpage for details.


ATTRIBUTES

comment_attributes

Arguments: [%attributes]

Arguments: [\%attributes]

Attributes added to the comment container.

comment_attributes_xml

Arguments: [%attributes]

Arguments: [\%attributes]

If you don't want the values to be XML-escaped, use the comment_attributes_xml method instead of </comment_attributes>.

add_comment_attributes

add_comment_attrs

See add_attributes in the HTML::FormFu:: manpage for details.

add_comment_attributes_xml

add_comment_attrs_xml

See add_attributes_xml in the HTML::FormFu:: manpage for details.

add_comment_attributes_loc

add_comment_attrs_loc

See add_attributes_loc in the HTML::FormFu:: manpage for details.

del_comment_attributes

del_comment_attrs

See del_attributes in the HTML::FormFu:: manpage for details.

del_comment_attributes_xml

del_comment_attrs_xml

See del_attributes_xml in the HTML::FormFu:: manpage for details.

del_comment_attributes_loc

del_comment_attrs_loc

See del_attributes_loc in the HTML::FormFu:: manpage for details.

container_attributes

Arguments: [%attributes]

Arguments: [\%attributes]

Arguments added to the field's container.

container_attributes_xml

Arguments: [%attributes]

Arguments: [\%attributes]

If you don't want the values to be XML-escaped, use the container_attributes_xml method instead of </container_attributes>.

add_container_attributes

add_container_attrs

See add_attributes in the HTML::FormFu:: manpage for details.

add_container_attributes_xml

add_container_attrs_xml

See add_attributes_xml in the HTML::FormFu:: manpage for details.

add_container_attributes_loc

add_container_attrs_loc

See add_attributes_loc in the HTML::FormFu:: manpage for details.

del_container_attributes

del_container_attrs

See del_attributes in the HTML::FormFu:: manpage for details.

del_container_attributes_xml

del_container_attrs_xml

See del_attributes_xml in the HTML::FormFu:: manpage for details.

del_container_attributes_loc

del_container_attrs_loc

See del_attributes_loc in the HTML::FormFu:: manpage for details.

label_attributes

Arguments: [%attributes]

Arguments: [\%attributes]

Attributes added to the label container.

label_attributes_xml

Arguments: [%attributes]

Arguments: [\%attributes]

If you don't want the values to be XML-escaped, use the label_attributes_xml method instead of </label_attributes>.

add_label_attributes

add_label_attrs

See add_attributes in the HTML::FormFu:: manpage for details.

add_label_attributes_xml

add_label_attrs_xml

See add_attributes_xml in the HTML::FormFu:: manpage for details.

add_label_attributes_loc

add_label_attrs_loc

See add_attributes_loc in the HTML::FormFu:: manpage for details.

del_label_attributes

del_label_attrs

See del_attributes in the HTML::FormFu:: manpage for details.

del_label_attributes_xml

del_label_attrs_xml

See del_attributes_xml in the HTML::FormFu:: manpage for details.

del_label_attributes_loc

del_label_attrs_loc

See del_attributes_loc in the HTML::FormFu:: manpage for details.


FORM LOGIC AND VALIDATION

filters

See filters in the HTML::FormFu manpage for details.

filter

See filter in the HTML::FormFu manpage for details.

constraints

See constraints in the HTML::FormFu manpage for details.

constraint

See constraint in the HTML::FormFu manpage for details.

inflators

See inflators in the HTML::FormFu manpage for details.

inflator

See inflator in the HTML::FormFu manpage for details.

validators

See validators in the HTML::FormFu manpage for details.

validator

See validator in the HTML::FormFu manpage for details.

transformers

See transformers in the HTML::FormFu manpage for details.

transformer

See transformer in the HTML::FormFu manpage for details.


CSS CLASSES

auto_id

See auto_id in the HTML::FormFu manpage for details.

auto_label

See auto_label in the HTML::FormFu manpage for details.

auto_error_class

See auto_error_class in the HTML::FormFu manpage for details.

auto_error_message

See auto_error_message in the HTML::FormFu manpage for details.

auto_constraint_class

See auto_constraint_class in the HTML::FormFu manpage for details.

auto_inflator_class

See auto_inflator_class in the HTML::FormFu manpage for details.

auto_validator_class

See auto_validator_class in the HTML::FormFu manpage for details.

auto_transformer_class

See auto_transformer_class in the HTML::FormFu manpage for details.


RENDERING

field_filename

The template filename to be used for just the form field - not including the display of any container, label, errors, etc.

Must be set by more specific field classes.

label_filename

The template filename to be used to render the label.

Must be set by more specific field classes.


ERROR HANDLING

get_errors

See get_errors in the HTML::FormFu manpage for details.

add_error

clear_errors

See clear_errors in the HTML::FormFu manpage for details.


INTROSPECTION

get_deflators

See get_deflators in the HTML::FormFu manpage for details.

get_deflator

See get_deflator in the HTML::FormFu manpage for details.

get_filters

See get_filters in the HTML::FormFu manpage for details.

get_filter

See get_filter in the HTML::FormFu manpage for details.

get_constraints

See get_constraints in the HTML::FormFu manpage for details.

get_constraint

See get_constraint in the HTML::FormFu manpage for details.

get_inflators

See get_inflators in the HTML::FormFu manpage for details.

get_inflator

See get_inflator in the HTML::FormFu manpage for details.

get_validators

See get_validators in the HTML::FormFu manpage for details.

get_validator

See get_validator in the HTML::FormFu manpage for details.

get_transformers

See get_transformers in the HTML::FormFu manpage for details.

get_transformer

See get_transformer in the HTML::FormFu manpage for details.

get_errors

See get_errors in the HTML::FormFu manpage for details.

clear_errors

See clear_errors in the HTML::FormFu manpage for details.


SEE ALSO

Base-class for the HTML::FormFu::Element::_Group manpage, the HTML::FormFu::Element::_Input manpage, the HTML::FormFu::Element::Multi manpage, the HTML::FormFu::Element::ContentButton manpage, the HTML::FormFu::Element::Textarea manpage.

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

the HTML::FormFu::FormFu manpage


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.

Programminig
Wy
Wy
yW
Wy
Programming
Wy
Wy
Wy
Wy