.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "HTML::Widget::Element 3pm"
.TH HTML::Widget::Element 3pm "2023-08-10" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
HTML::Widget::Element \- Element Base Class
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&    my $e = $widget\->element( $type, $name, {disabled => \*(Aqdisabled\*(Aq} );
\&    $e\->name(\*(Aqbar\*(Aq);
\&    $e\->class(\*(Aqfoo\*(Aq);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Element Base Class.
.SH "METHODS"
.IX Header "METHODS"
.SS "new"
.IX Subsection "new"
.SS "attributes"
.IX Subsection "attributes"
.SS "attrs"
.IX Subsection "attrs"
Arguments: \f(CW%attributes\fR
.PP
Arguments: \e%attributes
.PP
Return Value: \f(CW$element\fR
.PP
Arguments: none
.PP
Return Value: \e%attributes
.PP
Accepts either a list of key/value pairs, or a hash-ref.
.PP
.Vb 2
\&    $e\->attributes( $key => $value );
\&    $e\->attributes( { $key => $value } );
.Ve
.PP
Returns the \f(CW$element\fR object, to allow method chaining.
.PP
As of v1.10, passing a hash-ref no longer deletes current 
attributes, instead the attributes are added to the current attributes 
hash.
.PP
This means the attributes hash-ref can no longer be emptied using 
\&\f(CW\*(C`$e\->attributes( { } );\*(C'\fR. Instead, you may use 
\&\f(CW\*(C`%{ $e\->attributes } = ();\*(C'\fR.
.PP
As a special case, if no arguments are passed, the return value is a 
hash-ref of attributes instead of the object reference. This provides 
backwards compatibility to support:
.PP
.Vb 1
\&    $e\->attributes\->{key} = $value;
.Ve
.PP
\&\*(L"attrs\*(R" is an alias for \*(L"attributes\*(R".
.SS "container"
.IX Subsection "container"
Arguments: \e%attributes
.PP
Return Value: \f(CW$container\fR
.PP
Creates a new \f(CW$container_class\fR. Defaults to HTML::Widget::Container.
.SS "id"
.IX Subsection "id"
Arguments: \f(CW$widget\fR
.PP
Return Value: \f(CW$id\fR
.PP
Creates a element id.
.SS "init"
.IX Subsection "init"
Arguments: \f(CW$widget\fR
.PP
Called once when \fBprocess()\fR gets called for the first time.
.SS "mk_error"
.IX Subsection "mk_error"
Arguments: \f(CW$widget\fR, \e@errors
.PP
Return Value: \f(CW$error\fR
.PP
Creates a new HTML::Widget::Error.
.SS "mk_input"
.IX Subsection "mk_input"
Arguments: \f(CW$widget\fR, \e%attributes, \e@errors
.PP
Return Value: \f(CW$input_tag\fR
.PP
Creates a new input tag.
.SS "mk_tag"
.IX Subsection "mk_tag"
Arguments: \f(CW$widget\fR, \f(CW$tagtype\fR, \e%attributes, \e@errors
.PP
Return Value: \f(CW$element_tag\fR
.PP
Creates a new tag.
.SS "mk_label"
.IX Subsection "mk_label"
Arguments: \f(CW$widget\fR, \f(CW$name\fR, \f(CW$comment\fR, \e@errors
.PP
Return Value: \f(CW$label_tag\fR
.PP
Creates a new label tag.
.SS "name"
.IX Subsection "name"
Arguments: \f(CW$name\fR
.PP
Return Value: \f(CW$name\fR
.PP
Contains the element name.
.SS "passive"
.IX Subsection "passive"
Arguments: \f(CW$bool\fR
.PP
Return Value: \f(CW$bool\fR
.PP
Defines if element gets automatically rendered.
.SS "prepare"
.IX Subsection "prepare"
Arguments: \f(CW$widget\fR
.PP
Called whenever \f(CW\*(C`$widget\->process\*(C'\fR gets called, before 
\&\f(CW\*(C`$element\->process\*(C'\fR.
.SS "process"
.IX Subsection "process"
Arguments: \e%params, \e@uploads
.PP
Return Value: \e@errors
.PP
Called whenever \f(CW\*(C`$widget\->process\*(C'\fR is called.
.PP
Returns an arrayref of HTML::Widget::Error objects.
.SS "containerize"
.IX Subsection "containerize"
Arguments: \f(CW$widget\fR, \f(CW$value\fR, \e@errors
.PP
Return Value: \f(CW$container_tag\fR
.PP
Containerize the element, label and error for later rendering. 
Uses HTML::Widget::Container by default, but this can be over-ridden on 
a class or instance basis via \*(L"container_class\*(R".
.SS "container_class"
.IX Subsection "container_class"
Arguments: \f(CW$class\fR
.PP
Return Value: \f(CW$class\fR
.PP
Contains the class to use for contain the element which then get rendered. Defaults to HTML::Widget::Container. \f(CW\*(C`container_class\*(C'\fR can be set at a class or instance level:
.PP
.Vb 2
\&  HTML::Widget::Element\->container_class(\*(AqMy::Container\*(Aq); 
\&  # Override default to custom class
\&  
\&  HTML::Widget::Element::Password\->container_class(undef); 
\&  # Passwords use the default class
\&   
\&  $w\->element(\*(AqTextfield\*(Aq)\->name(\*(Aqfoo\*(Aq)\->container_class\->(\*(AqMy::Other::Container\*(Aq); 
\&  # This element only will use My::Other::Container to render
.Ve
.SS "find_elements"
.IX Subsection "find_elements"
Return Value: \e@elements
.PP
For non-block-container elements, simply returns a one-element list
containing this element.
.SS "new"
.IX Subsection "new"
.SS "allow_filter"
.IX Subsection "allow_filter"
Used by \f(CW\*(C`$widget\->filter_all\*(C'\fR. If false, the filter won't be added.
.PP
Default true.
.SS "allow_constraint"
.IX Subsection "allow_constraint"
Used by \f(CW\*(C`$widget\->constraint_all\*(C'\fR. If false, the filter won't be added.
.PP
Default true.
.SH "AUTHOR"
.IX Header "AUTHOR"
Sebastian Riedel, \f(CW\*(C`sri@oook.de\*(C'\fR
.SH "LICENSE"
.IX Header "LICENSE"
This library is free software, you can redistribute it and/or modify it under
the same terms as Perl itself.