.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" 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" ''
'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 turned on, 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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Jifty::Web::Form 3pm"
.TH Jifty::Web::Form 3pm "2011-01-24" "perl v5.14.2" "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"
Jifty::Web::Form \- Tools for rendering and dealing with HTML forms
.SH "METHODS"
.IX Header "METHODS"
.SS "new \s-1ARGS\s0"
.IX Subsection "new ARGS"
Creates a new Jifty::Web::Form.  Arguments:
.IP "id" 4
.IX Item "id"
The \s-1HTML\s0 id attribute given to the form.  This is aliased to name.  That is,
name and id are always equal and changing one changes the other.
.IP "class" 4
.IX Item "class"
The \s-1HTML\s0 class attribute given to the form.
.IP "name" 4
.IX Item "name"
The name given to the form.  This is mostly for naming specific forms
for testing.
.IP "call" 4
.IX Item "call"
All buttons in this form will act as continuation calls for the given
continuation id.
.IP "disable_autocomplete" 4
.IX Item "disable_autocomplete"
Disable \fBbrowser\fR autocomplete for this form.  Jifty autocomplete will still
work.
.SS "\s-1PRIVATE\s0 _init"
.IX Subsection "PRIVATE _init"
Reinitialize this form.
.IP "name" 4
.IX Item "name"
The form name
.IP "call" 4
.IX Item "call"
The continuation id to call
.SS "actions"
.IX Subsection "actions"
Returns a reference to a hash of Jifty::Action objects in this form keyed by moniker.
.PP
If you want to add actions to this form, use \*(L"add_action\*(R"
.SS "name [\s-1VALUE\s0]"
.IX Subsection "name [VALUE]"
Gets or sets the \s-1HTML\s0 name given to the form element.
.SS "call [\s-1CONTID\s0]"
.IX Subsection "call [CONTID]"
Gets or sets the continuation \s-1ID\s0 that will be called for this form.
.SS "is_open [\s-1BOOL\s0]"
.IX Subsection "is_open [BOOL]"
This accessor returns true if Jifty is currently in the middle of rendering a form
(if it's printed a <form> but not yet printed a </form> tag.) Use this in your
components to decide whether to open a form or not if you might be called from a
template that opened the form for you.
.SS "add_action \s-1PARAMHASH\s0"
.IX Subsection "add_action PARAMHASH"
Calls \*(L"new_action\*(R" in Jifty::Web with the paramhash given, and adds it to
the form.
.SS "register_action \s-1ACTION\s0"
.IX Subsection "register_action ACTION"
Adds \f(CW\*(C`ACTION\*(C'\fR as an action for this form. Called so that actions'
form fields can register the action against the form they're being
used in.
.SS "has_action \s-1MONIKER\s0"
.IX Subsection "has_action MONIKER"
If this form has an action whose moniker is \f(CW\*(C`MONIKER\*(C'\fR, returns
it. Otherwise returns undef.
.SS "start"
.IX Subsection "start"
Renders the opening form tag.
.SS "submit \s-1MESSAGE\s0, [\s-1PARAMETERS\s0]"
.IX Subsection "submit MESSAGE, [PARAMETERS]"
Renders a submit button with the text \s-1MESSAGE\s0 on it (which will be
\&\s-1HTML\s0 escaped).  Returns the empty string (for ease of use in
interpolation).  Any extra \s-1PARAMETERS\s0 are passed to
Jifty::Web::Form::Field::Clickable's constructor.
.SS "return \s-1MESSAGE\s0, [\s-1PARAMETERS\s0]"
.IX Subsection "return MESSAGE, [PARAMETERS]"
Renders a return button with the text \s-1MESSAGE\s0 on it (which will be
\&\s-1HTML\s0 escaped).  Returns the empty string (for ease of use in
interpolation).  Any extra \s-1PARAMETERS\s0 are passed to
Jifty::Web::Form::Field::Button's constructor.
.SS "end"
.IX Subsection "end"
Renders the closing form tag (including rendering errors for and
registering all of the actions)  After doing this, it resets its
internal state such that \*(L"start\*(R" may be called again.
.SS "print_action_registration \s-1MONIKER\s0"
.IX Subsection "print_action_registration MONIKER"
Print out the action registration goo for this action _right now_, unless we've already done so.
.SS "next_page \s-1PARAMHASH\s0"
.IX Subsection "next_page PARAMHASH"
Set the page this form should go to on success.  This simply creates a
Jifty::Action::Redirect action; any parameters in the \f(CW\*(C`PARAMHASH\*(C'\fR
are passed as arguments to the Jifty::Action::Redirect action.
.PP
Returns an empty string so it can be included in forms
.SS "\s-1DESTROY\s0"
.IX Subsection "DESTROY"
Checks to ensure that forms that were opened were actually closed,
which is when actions are registered.