.\" 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::Container 3pm" .TH HTML::Widget::Container 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::Container \- Container .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& my $container = $form\->element(\*(Aqfoo\*(Aq); \& \& my $field = $container\->field; \& my $error = $container\->error; \& my $label = $container\->label; \& \& my $field_xml = $container\->field_xml; \& my $error_xml = $container\->error_xml; \& my $javascript_xml = $container\->javascript_xml; \& \& my $xml = $container\->as_xml; \& # $xml eq "$container" \& \& my $javascript = $container\->javascript; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Container. .SH "METHODS" .IX Header "METHODS" .SS "as_xml" .IX Subsection "as_xml" Return Value: \f(CW$xml\fR .SS "_build_element" .IX Subsection "_build_element" Arguments: \f(CW$element\fR .PP Return Value: \f(CW@elements\fR .PP Convert \f(CW$element\fR to HTML::Element object. Accepts arrayref. .PP If you wish to change the rendering behaviour of HTML::Widget; specifically, the handling of elements which are array-refs, you can specify \&\*(L"container_class\*(R" in HTML::Widget::Element to a custom class which just overrides this function. .SS "build_single_element" .IX Subsection "build_single_element" Arguments: \f(CW$element\fR .PP Return Value: \f(CW$element\fR .PP Convert \f(CW$element\fR to HTML::Element object. .PP Called by \*(L"_build_element\*(R". .PP If you wish to change the rendering behaviour of HTML::Widget; specifically, the handling of an individual element, you can override this function. .SS "build_element_error" .IX Subsection "build_element_error" Arguments: \f(CW$element\fR .PP Return Value: \f(CW$element\fR .PP Called by \*(L"build_single_element\*(R". .PP If you wish to change how an error is rendered, override this function. .SS "build_element_label" .IX Subsection "build_element_label" Arguments: \f(CW$element\fR, \f(CW$class\fR .PP Return Value: \f(CW$element\fR .PP Called by \*(L"build_single_element\*(R". .PP If you wish to change how an element's label is rendered, override this function. .PP The \f(CW$class\fR argument is the original class of the element, before \&\*(L"build_element_error\*(R" was called. .SS "as_list" .IX Subsection "as_list" Return Value: \f(CW@elements\fR .PP Returns a list of HTML::Element objects. .SS "element" .IX Subsection "element" .SS "field" .IX Subsection "field" Arguments: \f(CW$element\fR .PP \&\*(L"field\*(R" is an alias for \*(L"element\*(R". .SS "element_xml" .IX Subsection "element_xml" .SS "field_xml" .IX Subsection "field_xml" Return Value: \f(CW$xml\fR .PP \&\*(L"field_xml\*(R" is an alias for \*(L"element_xml\*(R". .SS "error" .IX Subsection "error" Arguments: \f(CW$error\fR .PP Return Value: \f(CW$error\fR .SS "error_xml" .IX Subsection "error_xml" Return Value: \f(CW$xml\fR .SS "javascript" .IX Subsection "javascript" .SS "js" .IX Subsection "js" Arguments: \f(CW$javascript\fR .PP Return Value: \f(CW$javascript\fR .PP \&\*(L"js\*(R" is an alias for \*(L"javascript\*(R". .SS "javascript_element" .IX Subsection "javascript_element" Return Value: \f(CW$javascript_element\fR .PP Returns javascript in a script HTML::Element. .SS "javascript_xml" .IX Subsection "javascript_xml" .SS "js_xml" .IX Subsection "js_xml" Return Value: \f(CW$javascript_xml\fR .PP Returns javascript in a script block. .PP \&\*(L"js_xml\*(R" is an alias for \*(L"javascript_xml\*(R". .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.