1
<?xml version="1.0" encoding="iso-8859-1"?>
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3
"DTD/xhtml1-transitional.dtd">
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6
<title>twisted.web.woven.form.FormProcessor</title>
7
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
9
<body bgcolor="white" text="black" link="blue" vlink="#204080"
12
<!-- =========== START OF NAVBAR =========== -->
13
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
15
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
16
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
17
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
18
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
19
<th class="navbar" align="right" width="100%">
20
<table border="0" cellpadding="0" cellspacing="0">
21
<tr><th class="navbar" align="center">
23
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
24
</p></th></tr></table>
28
<table width="100%" cellpadding="0" cellspacing="0">
31
<font size="-1"><b class="breadcrumbs">
32
<a href="twisted.html">Package twisted</a> ::
33
<a href="twisted.web.html">Package web</a> ::
34
<a href="twisted.web.woven.html">Package woven</a> ::
35
<a href="twisted.web.woven.form.html">Module form</a> ::
36
Class FormProcessor
39
<td><table cellpadding="0" cellspacing="0">
40
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.web.woven.form.FormProcessor.html" target="_top">no frames</a>]</font></td></tr>
44
<!-- =========== START OF CLASS DESCRIPTION =========== -->
45
<h2 class="class">Class FormProcessor</h2>
47
<pre class="base-tree">
48
<a href="twisted.web.resource.Resource.html"><code>Resource</code></a> --+
56
<!-- =========== START OF METHOD SUMMARY =========== -->
57
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
58
<tr bgcolor="#70b0f0" class="summary">
59
<th colspan="2">Method Summary</th></tr>
60
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
61
<td><code><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>,
62
<span class=summary-sig-arg>formMethod</span>,
63
<span class=summary-sig-arg>callback</span>,
64
<span class=summary-sig-arg>errback</span>)</span></code>
66
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
67
<td><code><a name="errorModelFactory"></a><span class="summary-sig"><span class="summary-sig-name">errorModelFactory</span>(<span class=summary-sig-arg>self</span>,
68
<span class=summary-sig-arg>args</span>,
69
<span class=summary-sig-arg>out</span>,
70
<span class=summary-sig-arg>err</span>)</span></code>
72
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
73
<td><code><a name="errorViewFactory"></a><span class="summary-sig"><span class="summary-sig-name">errorViewFactory</span>(<span class=summary-sig-arg>self</span>,
74
<span class=summary-sig-arg>m</span>)</span></code>
76
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
77
<td><code><span class="summary-sig"><a href="twisted.web.woven.form.FormProcessor.html#getArgs" class="summary-sig-name"><code>getArgs</code></a>(<span class=summary-sig-arg>self</span>,
78
<span class=summary-sig-arg>request</span>)</span></code>
80
Return the formmethod.Arguments.</td></tr>
81
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
82
<td><code><a name="mangle_single"></a><span class="summary-sig"><span class="summary-sig-name">mangle_boolean</span>(<span class=summary-sig-arg>self</span>,
83
<span class=summary-sig-arg>args</span>)</span></code>
85
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
86
<td><code><a name="mangle_multi"></a><span class="summary-sig"><span class="summary-sig-name">mangle_checkgroup</span>(<span class=summary-sig-arg>self</span>,
87
<span class=summary-sig-arg>args</span>)</span></code>
89
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
90
<td><code><a name="mangle_single"></a><span class="summary-sig"><span class="summary-sig-name">mangle_choice</span>(<span class=summary-sig-arg>self</span>,
91
<span class=summary-sig-arg>args</span>)</span></code>
93
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
94
<td><code><a name="mangle_single"></a><span class="summary-sig"><span class="summary-sig-name">mangle_file</span>(<span class=summary-sig-arg>self</span>,
95
<span class=summary-sig-arg>args</span>)</span></code>
97
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
98
<td><code><a name="mangle_multi"></a><span class="summary-sig"><span class="summary-sig-name">mangle_flags</span>(<span class=summary-sig-arg>self</span>,
99
<span class=summary-sig-arg>args</span>)</span></code>
101
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
102
<td><code><a name="mangle_single"></a><span class="summary-sig"><span class="summary-sig-name">mangle_float</span>(<span class=summary-sig-arg>self</span>,
103
<span class=summary-sig-arg>args</span>)</span></code>
105
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
106
<td><code><a name="mangle_single"></a><span class="summary-sig"><span class="summary-sig-name">mangle_hidden</span>(<span class=summary-sig-arg>self</span>,
107
<span class=summary-sig-arg>args</span>)</span></code>
109
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
110
<td><code><a name="mangle_single"></a><span class="summary-sig"><span class="summary-sig-name">mangle_integer</span>(<span class=summary-sig-arg>self</span>,
111
<span class=summary-sig-arg>args</span>)</span></code>
113
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
114
<td><code><a name="mangle_single"></a><span class="summary-sig"><span class="summary-sig-name">mangle_integerrange</span>(<span class=summary-sig-arg>self</span>,
115
<span class=summary-sig-arg>args</span>)</span></code>
117
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
118
<td><code><a name="mangle_multi"></a><span class="summary-sig"><span class="summary-sig-name">mangle_multi</span>(<span class=summary-sig-arg>self</span>,
119
<span class=summary-sig-arg>args</span>)</span></code>
121
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
122
<td><code><a name="mangle_single"></a><span class="summary-sig"><span class="summary-sig-name">mangle_password</span>(<span class=summary-sig-arg>self</span>,
123
<span class=summary-sig-arg>args</span>)</span></code>
125
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
126
<td><code><a name="mangle_single"></a><span class="summary-sig"><span class="summary-sig-name">mangle_radiogroup</span>(<span class=summary-sig-arg>self</span>,
127
<span class=summary-sig-arg>args</span>)</span></code>
129
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
130
<td><code><a name="mangle_single"></a><span class="summary-sig"><span class="summary-sig-name">mangle_single</span>(<span class=summary-sig-arg>self</span>,
131
<span class=summary-sig-arg>args</span>)</span></code>
133
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
134
<td><code><a name="mangle_single"></a><span class="summary-sig"><span class="summary-sig-name">mangle_string</span>(<span class=summary-sig-arg>self</span>,
135
<span class=summary-sig-arg>args</span>)</span></code>
137
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
138
<td><code><a name="mangle_single"></a><span class="summary-sig"><span class="summary-sig-name">mangle_submit</span>(<span class=summary-sig-arg>self</span>,
139
<span class=summary-sig-arg>args</span>)</span></code>
141
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
142
<td><code><a name="mangle_single"></a><span class="summary-sig"><span class="summary-sig-name">mangle_text</span>(<span class=summary-sig-arg>self</span>,
143
<span class=summary-sig-arg>args</span>)</span></code>
145
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
146
<td><code><a name="modelFactory"></a><span class="summary-sig"><span class="summary-sig-name">modelFactory</span>(<span class=summary-sig-arg>self</span>,
147
<span class=summary-sig-arg>outObj</span>)</span></code>
149
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
150
<td><code><span class="summary-sig"><a href="twisted.web.woven.form.FormProcessor.html#render" class="summary-sig-name"><code>render</code></a>(<span class=summary-sig-arg>self</span>,
151
<span class=summary-sig-arg>request</span>)</span></code>
153
Render a given resource.</td></tr>
154
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
155
<td><code><a name="viewFactory"></a><span class="summary-sig"><span class="summary-sig-name">viewFactory</span>(<span class=summary-sig-arg>self</span>,
156
<span class=summary-sig-arg>model</span>)</span></code>
158
<tr bgcolor="#e8f0f8" class="group">
159
<th colspan="2"> Inherited from Resource</th></tr>
160
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
161
<td><code><span class="summary-sig"><a href="twisted.web.resource.Resource.html#delEntity" class="summary-sig-name"><code>delEntity</code></a>(<span class=summary-sig-arg>self</span>,
162
<span class=summary-sig-arg>name</span>)</span></code>
164
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
165
<td><code><span class="summary-sig"><a href="twisted.web.resource.Resource.html#getChild" class="summary-sig-name"><code>getChild</code></a>(<span class=summary-sig-arg>self</span>,
166
<span class=summary-sig-arg>path</span>,
167
<span class=summary-sig-arg>request</span>)</span></code>
169
Retrieve a 'child' resource from me.</td></tr>
170
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
171
<td><code><span class="summary-sig"><a href="twisted.web.resource.Resource.html#getChildForRequest" class="summary-sig-name"><code>getChildForRequest</code></a>(<span class=summary-sig-arg>self</span>,
172
<span class=summary-sig-arg>request</span>)</span></code>
174
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
175
<td><code><span class="summary-sig"><a href="twisted.web.resource.Resource.html#getChildWithDefault" class="summary-sig-name"><code>getChildWithDefault</code></a>(<span class=summary-sig-arg>self</span>,
176
<span class=summary-sig-arg>path</span>,
177
<span class=summary-sig-arg>request</span>)</span></code>
179
Retrieve a static or dynamically generated child resource from me.</td></tr>
180
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
181
<td><code><span class="summary-sig"><a href="twisted.web.resource.Resource.html#getDynamicEntity" class="summary-sig-name"><code>getDynamicEntity</code></a>(<span class=summary-sig-arg>self</span>,
182
<span class=summary-sig-arg>name</span>,
183
<span class=summary-sig-arg>request</span>)</span></code>
185
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
186
<td><code><span class="summary-sig"><a href="twisted.web.resource.Resource.html#getStaticEntity" class="summary-sig-name"><code>getStaticEntity</code></a>(<span class=summary-sig-arg>self</span>,
187
<span class=summary-sig-arg>name</span>)</span></code>
189
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
190
<td><code><span class="summary-sig"><a href="twisted.web.resource.Resource.html#listDynamicEntities" class="summary-sig-name"><code>listDynamicEntities</code></a>(<span class=summary-sig-arg>self</span>,
191
<span class=summary-sig-arg>request</span>)</span></code>
193
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
194
<td><code><span class="summary-sig"><a href="twisted.web.resource.Resource.html#listDynamicNames" class="summary-sig-name"><code>listDynamicNames</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
196
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
197
<td><code><span class="summary-sig"><a href="twisted.web.resource.Resource.html#listEntities" class="summary-sig-name"><code>listEntities</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
199
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
200
<td><code><span class="summary-sig"><a href="twisted.web.resource.Resource.html#listNames" class="summary-sig-name"><code>listNames</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
202
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
203
<td><code><span class="summary-sig"><a href="twisted.web.resource.Resource.html#listStaticEntities" class="summary-sig-name"><code>listStaticEntities</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
205
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
206
<td><code><span class="summary-sig"><a href="twisted.web.resource.Resource.html#listStaticNames" class="summary-sig-name"><code>listStaticNames</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
208
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
209
<td><code><span class="summary-sig"><a href="twisted.web.resource.Resource.html#putChild" class="summary-sig-name"><code>putChild</code></a>(<span class=summary-sig-arg>self</span>,
210
<span class=summary-sig-arg>path</span>,
211
<span class=summary-sig-arg>child</span>)</span></code>
213
Register a static child.</td></tr>
214
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
215
<td><code><span class="summary-sig"><a href="twisted.web.resource.Resource.html#reallyPutEntity" class="summary-sig-name"><code>reallyPutEntity</code></a>(<span class=summary-sig-arg>self</span>,
216
<span class=summary-sig-arg>name</span>,
217
<span class=summary-sig-arg>entity</span>)</span></code>
219
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
220
<td><code><span class="summary-sig"><a href="twisted.web.resource.Resource.html#render_HEAD" class="summary-sig-name"><code>render_HEAD</code></a>(<span class=summary-sig-arg>self</span>,
221
<span class=summary-sig-arg>request</span>)</span></code>
223
Default handling of HEAD method.</td></tr>
227
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
228
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
229
<tr bgcolor="#70b0f0" class="summary">
230
<th colspan="2">Class Variable Summary</th></tr>
231
<tr bgcolor="#e8f0f8" class="group">
232
<th colspan="2"> Inherited from Resource</th></tr>
233
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td>
234
<td><b><a href="twisted.web.resource.Resource.html#__implements__"><code>__implements__</code></a></b> = <span title="(<class twisted.web.resource.IResource at 0x8450e44>,)"><code>(<class twisted.web.resource.IResource <span class="variable-ellipsis">...</span></code>
236
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
237
<td><b><a href="twisted.web.resource.Resource.html#isLeaf"><code>isLeaf</code></a></b> = <span title="0">0 </span></td></tr>
238
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
239
<td><b><a href="twisted.web.resource.Resource.html#server"><code>server</code></a></b> = <span title="None">None </span></td></tr>
243
<!-- =========== START OF METHOD DETAILS =========== -->
244
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
245
<tr bgcolor="#70b0f0" class="details">
246
<th colspan="2">Method Details</th></tr>
249
<a name="getArgs"></a>
250
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
251
<h3><span class="sig"><span class="sig-name">getArgs</span>(<span class=sig-arg>self</span>,
252
<span class=sig-arg>request</span>)</span>
254
<p>Return the formmethod.Arguments.</p>
255
Overridable hook to allow pre-processing, e.g. if we want to enable
256
on them depending on one of the inputs.
261
<a name="render"></a>
262
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
263
<h3><span class="sig"><span class="sig-name">render</span>(<span class=sig-arg>self</span>,
264
<span class=sig-arg>request</span>)</span>
266
<p>Render a given resource. See <a
267
href="twisted.web.resource.IResource.html"
268
class="link"><code>IResource</code></a>'s render method.</p>
269
<p>I delegate to methods of self with the form 'render_METHOD' where
270
METHOD is the HTTP that was used to make the request. Examples:
271
render_GET, render_HEAD, render_POST, and so on. Generally you should
272
implement those methods instead of overriding this one.</p>
273
<p>render_METHOD methods are expected to return a string which will be
274
the rendered page, unless the return value is
275
twisted.web.server.NOT_DONE_YET, in which case it is this class's
276
responsibility to write the results to request.write(data), then call
277
request.finish().</p>
278
Old code that overrides render() directly is likewise expected to
279
return a string or NOT_DONE_YET.
281
<dl><dt><b>Overrides:</b></dt>
282
<dd><a href="twisted.web.resource.Resource.html#render"><code>twisted.web.resource.Resource.render</code></a> <i>(inherited documentation)</i>
290
<!-- =========== START OF NAVBAR =========== -->
291
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
293
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
294
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
295
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
296
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
297
<th class="navbar" align="right" width="100%">
298
<table border="0" cellpadding="0" cellspacing="0">
299
<tr><th class="navbar" align="center">
301
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
302
</p></th></tr></table>
307
<table border="0" cellpadding="0" cellspacing="0" width="100%">
309
<td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:07:44 2004</font></td>
310
<td align="right"><a href="http://epydoc.sourceforge.net"
311
><font size="-2">http://epydoc.sf.net</font></a></td>