← Back to branch summary

~sahana-eden-short-projects/sahana-eden/staging

« back to all changes in this revision

Viewing changes to docs/s3/vita.modules.s3.s3ocr.S3XForms-class.html

  • Committer: Fran Boon
  • Date: 2011-10-13 20:21:49 UTC
  • mfrom: (185.15.289 vita)
  • Revision ID: fran@aidiq.com-20111013202149-rwfv1dr7fgdfr9kr
merge nursix: cleanups

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/s3/vita.modules.s3.s3ocr.S3XForms-class.html
1
 
<?xml version="1.0" encoding="ascii"?>
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">
5
 
<head>
6
 
  <title>vita.modules.s3.s3ocr.S3XForms</title>
7
 
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
8
 
  <script type="text/javascript" src="epydoc.js"></script>
9
 
</head>
10
 
 
11
 
<body bgcolor="white" text="black" link="blue" vlink="#204080"
12
 
      alink="#204080">
13
 
<!-- ==================== NAVIGATION BAR ==================== -->
14
 
<table class="navbar" border="0" width="100%" cellpadding="0"
15
 
       bgcolor="#a0c0ff" cellspacing="0">
16
 
  <tr valign="middle">
17
 
  <!-- Home link -->
18
 
      <th>&nbsp;&nbsp;&nbsp;<a
19
 
        href="vita.modules.s3-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
20
 
 
21
 
  <!-- Tree link -->
22
 
      <th>&nbsp;&nbsp;&nbsp;<a
23
 
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
24
 
 
25
 
  <!-- Index link -->
26
 
      <th>&nbsp;&nbsp;&nbsp;<a
27
 
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
28
 
 
29
 
  <!-- Help link -->
30
 
      <th>&nbsp;&nbsp;&nbsp;<a
31
 
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
32
 
 
33
 
  <!-- Project homepage -->
34
 
      <th class="navbar" align="right" width="100%">
35
 
        <table border="0" cellpadding="0" cellspacing="0">
36
 
          <tr><th class="navbar" align="center"
37
 
            ><a class="navbar" target="_top" href="http://eden.sahanafoundation.org/wiki/S3">S3</a></th>
38
 
          </tr></table></th>
39
 
  </tr>
40
 
</table>
41
 
<table width="100%" cellpadding="0" cellspacing="0">
42
 
  <tr valign="top">
43
 
    <td width="100%">
44
 
      <span class="breadcrumbs">
45
 
        Package&nbsp;vita ::
46
 
        Package&nbsp;modules ::
47
 
        <a href="vita.modules.s3-module.html">Package&nbsp;s3</a> ::
48
 
        <a href="vita.modules.s3.s3ocr-module.html">Module&nbsp;s3ocr</a> ::
49
 
        Class&nbsp;S3XForms
50
 
      </span>
51
 
    </td>
52
 
    <td>
53
 
      <table cellpadding="0" cellspacing="0">
54
 
        <!-- hide/show private -->
55
 
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
56
 
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
57
 
        <tr><td align="right"><span class="options"
58
 
            >[<a href="frames.html" target="_top">frames</a
59
 
            >]&nbsp;|&nbsp;<a href="vita.modules.s3.s3ocr.S3XForms-class.html"
60
 
            target="_top">no&nbsp;frames</a>]</span></td></tr>
61
 
      </table>
62
 
    </td>
63
 
  </tr>
64
 
</table>
65
 
<!-- ==================== CLASS DESCRIPTION ==================== -->
66
 
<h1 class="epydoc">Class S3XForms</h1><p class="nomargin-top"><span class="codelink"><a href="vita.modules.s3.s3ocr-pysrc.html#S3XForms">source&nbsp;code</a></span></p>
67
 
<pre class="base-tree">
68
 
     object --+    
69
 
              |    
70
 
<a href="vita.modules.s3.s3rest.S3Method-class.html">s3rest.S3Method</a> --+
71
 
                  |
72
 
                 <strong class="uidshort">S3XForms</strong>
73
 
</pre>
74
 
 
75
 
<hr />
76
 
<p>Generate XForms and PDFs the s3 way</p>
77
 
 
78
 
<!-- ==================== INSTANCE METHODS ==================== -->
79
 
<a name="section-InstanceMethods"></a>
80
 
<table class="summary" border="1" cellpadding="3"
81
 
       cellspacing="0" width="100%" bgcolor="white">
82
 
<tr bgcolor="#70b0f0" class="table-header">
83
 
  <td colspan="2" class="table-header">
84
 
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
85
 
      <tr valign="top">
86
 
        <td align="left"><span class="table-header">Instance Methods</span></td>
87
 
        <td align="right" valign="top"
88
 
         ><span class="options">[<a href="#section-InstanceMethods"
89
 
         class="privatelink" onclick="toggle_private();"
90
 
         >hide private</a>]</span></td>
91
 
      </tr>
92
 
    </table>
93
 
  </td>
94
 
</tr>
95
 
<tr>
96
 
    <td width="15%" align="right" valign="top" class="summary">
97
 
      <span class="summary-type">&nbsp;</span>
98
 
    </td><td class="summary">
99
 
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
100
 
        <tr>
101
 
          <td><span class="summary-sig"><a href="vita.modules.s3.s3ocr.S3XForms-class.html#apply_method" class="summary-sig-name">apply_method</a>(<span class="summary-sig-arg">self</span>,
102
 
        <span class="summary-sig-arg">r</span>,
103
 
        <span class="summary-sig-arg">**attr</span>)</span><br />
104
 
      S3Method's abstract method</td>
105
 
          <td align="right" valign="top">
106
 
            <span class="codelink"><a href="vita.modules.s3.s3ocr-pysrc.html#S3XForms.apply_method">source&nbsp;code</a></span>
107
 
            
108
 
          </td>
109
 
        </tr>
110
 
      </table>
111
 
      
112
 
    </td>
113
 
  </tr>
114
 
<tr>
115
 
    <td width="15%" align="right" valign="top" class="summary">
116
 
      <span class="summary-type">&nbsp;</span>
117
 
    </td><td class="summary">
118
 
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
119
 
        <tr>
120
 
          <td><span class="summary-sig"><a href="vita.modules.s3.s3ocr.S3XForms-class.html#xforms_create" class="summary-sig-name">xforms_create</a>(<span class="summary-sig-arg">self</span>)</span><br />
121
 
      Generate Valid XML for XForms</td>
122
 
          <td align="right" valign="top">
123
 
            <span class="codelink"><a href="vita.modules.s3.s3ocr-pysrc.html#S3XForms.xforms_create">source&nbsp;code</a></span>
124
 
            
125
 
          </td>
126
 
        </tr>
127
 
      </table>
128
 
      
129
 
    </td>
130
 
  </tr>
131
 
<tr class="private">
132
 
    <td width="15%" align="right" valign="top" class="summary">
133
 
      <span class="summary-type">&nbsp;</span>
134
 
    </td><td class="summary">
135
 
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
136
 
        <tr>
137
 
          <td><span class="summary-sig"><a href="vita.modules.s3.s3ocr.S3XForms-class.html#_get_fields" class="summary-sig-name" onclick="show_private();">_get_fields</a>(<span class="summary-sig-arg">self</span>)</span><br />
138
 
      Generate fields for the resource</td>
139
 
          <td align="right" valign="top">
140
 
            <span class="codelink"><a href="vita.modules.s3.s3ocr-pysrc.html#S3XForms._get_fields">source&nbsp;code</a></span>
141
 
            
142
 
          </td>
143
 
        </tr>
144
 
      </table>
145
 
      
146
 
    </td>
147
 
  </tr>
148
 
<tr class="private">
149
 
    <td width="15%" align="right" valign="top" class="summary">
150
 
      <span class="summary-type">&nbsp;</span>
151
 
    </td><td class="summary">
152
 
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
153
 
        <tr>
154
 
          <td><span class="summary-sig"><a href="vita.modules.s3.s3ocr.S3XForms-class.html#_generate_instance" class="summary-sig-name" onclick="show_private();">_generate_instance</a>(<span class="summary-sig-arg">self</span>,
155
 
        <span class="summary-sig-arg">fields</span>,
156
 
        <span class="summary-sig-arg">instance</span>)</span><br />
157
 
      Generates etree for instance for the resource</td>
158
 
          <td align="right" valign="top">
159
 
            <span class="codelink"><a href="vita.modules.s3.s3ocr-pysrc.html#S3XForms._generate_instance">source&nbsp;code</a></span>
160
 
            
161
 
          </td>
162
 
        </tr>
163
 
      </table>
164
 
      
165
 
    </td>
166
 
  </tr>
167
 
<tr class="private">
168
 
    <td width="15%" align="right" valign="top" class="summary">
169
 
      <span class="summary-type">&nbsp;</span>
170
 
    </td><td class="summary">
171
 
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
172
 
        <tr>
173
 
          <td><span class="summary-sig"><a href="vita.modules.s3.s3ocr.S3XForms-class.html#_generate_bindings" class="summary-sig-name" onclick="show_private();">_generate_bindings</a>(<span class="summary-sig-arg">self</span>,
174
 
        <span class="summary-sig-arg">fields</span>,
175
 
        <span class="summary-sig-arg">model</span>)</span><br />
176
 
      Generates etree for bindings for the resource</td>
177
 
          <td align="right" valign="top">
178
 
            <span class="codelink"><a href="vita.modules.s3.s3ocr-pysrc.html#S3XForms._generate_bindings">source&nbsp;code</a></span>
179
 
            
180
 
          </td>
181
 
        </tr>
182
 
      </table>
183
 
      
184
 
    </td>
185
 
  </tr>
186
 
<tr class="private">
187
 
    <td width="15%" align="right" valign="top" class="summary">
188
 
      <span class="summary-type">&nbsp;</span>
189
 
    </td><td class="summary">
190
 
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
191
 
        <tr>
192
 
          <td><span class="summary-sig"><a href="vita.modules.s3.s3ocr.S3XForms-class.html#_generate_controllers" class="summary-sig-name" onclick="show_private();">_generate_controllers</a>(<span class="summary-sig-arg">self</span>,
193
 
        <span class="summary-sig-arg">fields</span>,
194
 
        <span class="summary-sig-arg">body</span>)</span><br />
195
 
      Generates etree for conntrollers and translation values for the 
196
 
      resource</td>
197
 
          <td align="right" valign="top">
198
 
            <span class="codelink"><a href="vita.modules.s3.s3ocr-pysrc.html#S3XForms._generate_controllers">source&nbsp;code</a></span>
199
 
            
200
 
          </td>
201
 
        </tr>
202
 
      </table>
203
 
      
204
 
    </td>
205
 
  </tr>
206
 
<tr class="private">
207
 
    <td width="15%" align="right" valign="top" class="summary">
208
 
      <span class="summary-type">&nbsp;</span>
209
 
    </td><td class="summary">
210
 
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
211
 
        <tr>
212
 
          <td><span class="summary-sig"><a href="vita.modules.s3.s3ocr.S3XForms-class.html#_get_str" class="summary-sig-name" onclick="show_private();">_get_str</a>(<span class="summary-sig-arg">self</span>,
213
 
        <span class="summary-sig-arg">obj</span>)</span></td>
214
 
          <td align="right" valign="top">
215
 
            <span class="codelink"><a href="vita.modules.s3.s3ocr-pysrc.html#S3XForms._get_str">source&nbsp;code</a></span>
216
 
            
217
 
          </td>
218
 
        </tr>
219
 
      </table>
220
 
      
221
 
    </td>
222
 
  </tr>
223
 
<tr class="private">
224
 
    <td width="15%" align="right" valign="top" class="summary">
225
 
      <span class="summary-type">&nbsp;</span>
226
 
    </td><td class="summary">
227
 
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
228
 
        <tr>
229
 
          <td><span class="summary-sig"><a href="vita.modules.s3.s3ocr.S3XForms-class.html#_textvalue" class="summary-sig-name" onclick="show_private();">_textvalue</a>(<span class="summary-sig-arg">self</span>,
230
 
        <span class="summary-sig-arg">textid</span>,
231
 
        <span class="summary-sig-arg">valuetext</span>)</span><br />
232
 
      simple helper function</td>
233
 
          <td align="right" valign="top">
234
 
            <span class="codelink"><a href="vita.modules.s3.s3ocr-pysrc.html#S3XForms._textvalue">source&nbsp;code</a></span>
235
 
            
236
 
          </td>
237
 
        </tr>
238
 
      </table>
239
 
      
240
 
    </td>
241
 
  </tr>
242
 
<tr class="private">
243
 
    <td width="15%" align="right" valign="top" class="summary">
244
 
      <span class="summary-type">&nbsp;</span>
245
 
    </td><td class="summary">
246
 
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
247
 
        <tr>
248
 
          <td><span class="summary-sig"><a href="vita.modules.s3.s3ocr.S3XForms-class.html#_itemlabelvalue" class="summary-sig-name" onclick="show_private();">_itemlabelvalue</a>(<span class="summary-sig-arg">self</span>,
249
 
        <span class="summary-sig-arg">valuetext</span>,
250
 
        <span class="summary-sig-arg">labeltext</span>=<span class="summary-sig-default">None</span>,
251
 
        <span class="summary-sig-arg">labelref</span>=<span class="summary-sig-default">None</span>)</span><br />
252
 
      simple helper function</td>
253
 
          <td align="right" valign="top">
254
 
            <span class="codelink"><a href="vita.modules.s3.s3ocr-pysrc.html#S3XForms._itemlabelvalue">source&nbsp;code</a></span>
255
 
            
256
 
          </td>
257
 
        </tr>
258
 
      </table>
259
 
      
260
 
    </td>
261
 
  </tr>
262
 
<tr class="private">
263
 
    <td width="15%" align="right" valign="top" class="summary">
264
 
      <span class="summary-type">&nbsp;</span>
265
 
    </td><td class="summary">
266
 
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
267
 
        <tr>
268
 
          <td><span class="summary-sig"><a href="vita.modules.s3.s3ocr.S3XForms-class.html#_get_controller" class="summary-sig-name" onclick="show_private();">_get_controller</a>(<span class="summary-sig-arg">self</span>,
269
 
        <span class="summary-sig-arg">controller_name</span>,
270
 
        <span class="summary-sig-arg">kargs</span>,
271
 
        <span class="summary-sig-arg">ref</span>=<span class="summary-sig-default">&quot;&quot;</span>,
272
 
        <span class="summary-sig-arg">labeltext</span>=<span class="summary-sig-default">&quot;&quot;</span>,
273
 
        <span class="summary-sig-arg">readonly</span>=<span class="summary-sig-default">&quot;&quot;</span>,
274
 
        <span class="summary-sig-arg">default</span>=<span class="summary-sig-default">&quot;&quot;</span>,
275
 
        <span class="summary-sig-arg">items_list</span>=<span class="summary-sig-default">[]</span>,
276
 
        <span class="summary-sig-arg">hintref</span>=<span class="summary-sig-default">&quot;&quot;</span>,
277
 
        <span class="summary-sig-arg">labelref</span>=<span class="summary-sig-default">&quot;&quot;</span>)</span><br />
278
 
      simple helper function</td>
279
 
          <td align="right" valign="top">
280
 
            <span class="codelink"><a href="vita.modules.s3.s3ocr-pysrc.html#S3XForms._get_controller">source&nbsp;code</a></span>
281
 
            
282
 
          </td>
283
 
        </tr>
284
 
      </table>
285
 
      
286
 
    </td>
287
 
  </tr>
288
 
<tr>
289
 
    <td width="15%" align="right" valign="top" class="summary">
290
 
      <span class="summary-type">&nbsp;</span>
291
 
    </td><td class="summary">
292
 
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
293
 
        <tr>
294
 
          <td><span class="summary-sig"><a href="vita.modules.s3.s3ocr.S3XForms-class.html#pdf_manager" class="summary-sig-name">pdf_manager</a>(<span class="summary-sig-arg">self</span>)</span><br />
295
 
      Generate PDFs for the resource</td>
296
 
          <td align="right" valign="top">
297
 
            <span class="codelink"><a href="vita.modules.s3.s3ocr-pysrc.html#S3XForms.pdf_manager">source&nbsp;code</a></span>
298
 
            
299
 
          </td>
300
 
        </tr>
301
 
      </table>
302
 
      
303
 
    </td>
304
 
  </tr>
305
 
<tr class="private">
306
 
    <td width="15%" align="right" valign="top" class="summary">
307
 
      <span class="summary-type">&nbsp;</span>
308
 
    </td><td class="summary">
309
 
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
310
 
        <tr>
311
 
          <td><span class="summary-sig"><a href="vita.modules.s3.s3ocr.S3XForms-class.html#_uses_requirement" class="summary-sig-name" onclick="show_private();">_uses_requirement</a>(<span class="summary-sig-arg">self</span>,
312
 
        <span class="summary-sig-arg">requirement</span>,
313
 
        <span class="summary-sig-arg">field</span>)</span><br />
314
 
      Check if a given database field uses the specified requirement 
315
 
      (IS_IN_SET, IS_INT_IN_RANGE, etc)</td>
316
 
          <td align="right" valign="top">
317
 
            <span class="codelink"><a href="vita.modules.s3.s3ocr-pysrc.html#S3XForms._uses_requirement">source&nbsp;code</a></span>
318
 
            
319
 
          </td>
320
 
        </tr>
321
 
      </table>
322
 
      
323
 
    </td>
324
 
  </tr>
325
 
  <tr>
326
 
    <td colspan="2" class="summary">
327
 
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="vita.modules.s3.s3rest.S3Method-class.html">s3rest.S3Method</a></code></b>:
328
 
      <code><a href="vita.modules.s3.s3rest.S3Method-class.html#__call__">__call__</a></code>
329
 
      </p>
330
 
    <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="vita.modules.s3.s3rest.S3Method-class.html">s3rest.S3Method</a></code></b> (private):
331
 
      <code><a href="vita.modules.s3.s3rest.S3Method-class.html#_config" onclick="show_private();">_config</a></code>
332
 
      </p></div>
333
 
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
334
 
      <code>__delattr__</code>,
335
 
      <code>__format__</code>,
336
 
      <code>__getattribute__</code>,
337
 
      <code>__hash__</code>,
338
 
      <code>__init__</code>,
339
 
      <code>__new__</code>,
340
 
      <code>__reduce__</code>,
341
 
      <code>__reduce_ex__</code>,
342
 
      <code>__repr__</code>,
343
 
      <code>__setattr__</code>,
344
 
      <code>__sizeof__</code>,
345
 
      <code>__str__</code>,
346
 
      <code>__subclasshook__</code>
347
 
      </p>
348
 
    </td>
349
 
  </tr>
350
 
</table>
351
 
<!-- ==================== STATIC METHODS ==================== -->
352
 
<a name="section-StaticMethods"></a>
353
 
<table class="summary" border="1" cellpadding="3"
354
 
       cellspacing="0" width="100%" bgcolor="white">
355
 
<tr bgcolor="#70b0f0" class="table-header">
356
 
  <td colspan="2" class="table-header">
357
 
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
358
 
      <tr valign="top">
359
 
        <td align="left"><span class="table-header">Static Methods</span></td>
360
 
        <td align="right" valign="top"
361
 
         ><span class="options">[<a href="#section-StaticMethods"
362
 
         class="privatelink" onclick="toggle_private();"
363
 
         >hide private</a>]</span></td>
364
 
      </tr>
365
 
    </table>
366
 
  </td>
367
 
</tr>
368
 
  <tr>
369
 
    <td colspan="2" class="summary">
370
 
    <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="vita.modules.s3.s3rest.S3Method-class.html">s3rest.S3Method</a></code></b> (private):
371
 
      <code><a href="vita.modules.s3.s3rest.S3Method-class.html#_extend_view" onclick="show_private();">_extend_view</a></code>,
372
 
      <code><a href="vita.modules.s3.s3rest.S3Method-class.html#_record_id" onclick="show_private();">_record_id</a></code>,
373
 
      <code><a href="vita.modules.s3.s3rest.S3Method-class.html#_view" onclick="show_private();">_view</a></code>
374
 
      </p></div>
375
 
    </td>
376
 
  </tr>
377
 
</table>
378
 
<!-- ==================== PROPERTIES ==================== -->
379
 
<a name="section-Properties"></a>
380
 
<table class="summary" border="1" cellpadding="3"
381
 
       cellspacing="0" width="100%" bgcolor="white">
382
 
<tr bgcolor="#70b0f0" class="table-header">
383
 
  <td colspan="2" class="table-header">
384
 
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
385
 
      <tr valign="top">
386
 
        <td align="left"><span class="table-header">Properties</span></td>
387
 
        <td align="right" valign="top"
388
 
         ><span class="options">[<a href="#section-Properties"
389
 
         class="privatelink" onclick="toggle_private();"
390
 
         >hide private</a>]</span></td>
391
 
      </tr>
392
 
    </table>
393
 
  </td>
394
 
</tr>
395
 
  <tr>
396
 
    <td colspan="2" class="summary">
397
 
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
398
 
      <code>__class__</code>
399
 
      </p>
400
 
    </td>
401
 
  </tr>
402
 
</table>
403
 
<!-- ==================== METHOD DETAILS ==================== -->
404
 
<a name="section-MethodDetails"></a>
405
 
<table class="details" border="1" cellpadding="3"
406
 
       cellspacing="0" width="100%" bgcolor="white">
407
 
<tr bgcolor="#70b0f0" class="table-header">
408
 
  <td colspan="2" class="table-header">
409
 
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
410
 
      <tr valign="top">
411
 
        <td align="left"><span class="table-header">Method Details</span></td>
412
 
        <td align="right" valign="top"
413
 
         ><span class="options">[<a href="#section-MethodDetails"
414
 
         class="privatelink" onclick="toggle_private();"
415
 
         >hide private</a>]</span></td>
416
 
      </tr>
417
 
    </table>
418
 
  </td>
419
 
</tr>
420
 
</table>
421
 
<a name="apply_method"></a>
422
 
<div>
423
 
<table class="details" border="1" cellpadding="3"
424
 
       cellspacing="0" width="100%" bgcolor="white">
425
 
<tr><td>
426
 
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
427
 
  <tr valign="top"><td>
428
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">apply_method</span>(<span class="sig-arg">self</span>,
429
 
        <span class="sig-arg">r</span>,
430
 
        <span class="sig-arg">**attr</span>)</span>
431
 
  </h3>
432
 
  </td><td align="right" valign="top"
433
 
    ><span class="codelink"><a href="vita.modules.s3.s3ocr-pysrc.html#S3XForms.apply_method">source&nbsp;code</a></span>&nbsp;
434
 
    </td>
435
 
  </tr></table>
436
 
  
437
 
  <p>S3Method's abstract method</p>
438
 
  <dl class="fields">
439
 
    <dt>Parameters:</dt>
440
 
    <dd><ul class="nomargin-top">
441
 
        <li><strong class="pname"><code>r</code></strong> - the S3Request</li>
442
 
        <li><strong class="pname"><code>attr</code></strong> - dictionary of parameters for the method handler</li>
443
 
    </ul></dd>
444
 
    <dt>Returns:</dt>
445
 
        <dd>output object to send to the view</dd>
446
 
    <dt>Overrides:
447
 
        <a href="vita.modules.s3.s3rest.S3Method-class.html#apply_method">s3rest.S3Method.apply_method</a>
448
 
    </dt>
449
 
  </dl>
450
 
</td></tr></table>
451
 
</div>
452
 
<a name="xforms_create"></a>
453
 
<div>
454
 
<table class="details" border="1" cellpadding="3"
455
 
       cellspacing="0" width="100%" bgcolor="white">
456
 
<tr><td>
457
 
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
458
 
  <tr valign="top"><td>
459
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">xforms_create</span>(<span class="sig-arg">self</span>)</span>
460
 
  </h3>
461
 
  </td><td align="right" valign="top"
462
 
    ><span class="codelink"><a href="vita.modules.s3.s3ocr-pysrc.html#S3XForms.xforms_create">source&nbsp;code</a></span>&nbsp;
463
 
    </td>
464
 
  </tr></table>
465
 
  
466
 
  <p>Generate Valid XML for XForms</p>
467
 
  <dl class="fields">
468
 
  </dl>
469
 
</td></tr></table>
470
 
</div>
471
 
<a name="_get_fields"></a>
472
 
<div class="private">
473
 
<table class="details" border="1" cellpadding="3"
474
 
       cellspacing="0" width="100%" bgcolor="white">
475
 
<tr><td>
476
 
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
477
 
  <tr valign="top"><td>
478
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_get_fields</span>(<span class="sig-arg">self</span>)</span>
479
 
  </h3>
480
 
  </td><td align="right" valign="top"
481
 
    ><span class="codelink"><a href="vita.modules.s3.s3ocr-pysrc.html#S3XForms._get_fields">source&nbsp;code</a></span>&nbsp;
482
 
    </td>
483
 
  </tr></table>
484
 
  
485
 
  <p>Generate fields for the resource</p>
486
 
  <dl class="fields">
487
 
  </dl>
488
 
</td></tr></table>
489
 
</div>
490
 
<a name="_generate_instance"></a>
491
 
<div class="private">
492
 
<table class="details" border="1" cellpadding="3"
493
 
       cellspacing="0" width="100%" bgcolor="white">
494
 
<tr><td>
495
 
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
496
 
  <tr valign="top"><td>
497
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_generate_instance</span>(<span class="sig-arg">self</span>,
498
 
        <span class="sig-arg">fields</span>,
499
 
        <span class="sig-arg">instance</span>)</span>
500
 
  </h3>
501
 
  </td><td align="right" valign="top"
502
 
    ><span class="codelink"><a href="vita.modules.s3.s3ocr-pysrc.html#S3XForms._generate_instance">source&nbsp;code</a></span>&nbsp;
503
 
    </td>
504
 
  </tr></table>
505
 
  
506
 
  <p>Generates etree for instance for the resource</p>
507
 
  <dl class="fields">
508
 
  </dl>
509
 
</td></tr></table>
510
 
</div>
511
 
<a name="_generate_bindings"></a>
512
 
<div class="private">
513
 
<table class="details" border="1" cellpadding="3"
514
 
       cellspacing="0" width="100%" bgcolor="white">
515
 
<tr><td>
516
 
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
517
 
  <tr valign="top"><td>
518
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_generate_bindings</span>(<span class="sig-arg">self</span>,
519
 
        <span class="sig-arg">fields</span>,
520
 
        <span class="sig-arg">model</span>)</span>
521
 
  </h3>
522
 
  </td><td align="right" valign="top"
523
 
    ><span class="codelink"><a href="vita.modules.s3.s3ocr-pysrc.html#S3XForms._generate_bindings">source&nbsp;code</a></span>&nbsp;
524
 
    </td>
525
 
  </tr></table>
526
 
  
527
 
  <p>Generates etree for bindings for the resource</p>
528
 
  <dl class="fields">
529
 
  </dl>
530
 
</td></tr></table>
531
 
</div>
532
 
<a name="_generate_controllers"></a>
533
 
<div class="private">
534
 
<table class="details" border="1" cellpadding="3"
535
 
       cellspacing="0" width="100%" bgcolor="white">
536
 
<tr><td>
537
 
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
538
 
  <tr valign="top"><td>
539
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_generate_controllers</span>(<span class="sig-arg">self</span>,
540
 
        <span class="sig-arg">fields</span>,
541
 
        <span class="sig-arg">body</span>)</span>
542
 
  </h3>
543
 
  </td><td align="right" valign="top"
544
 
    ><span class="codelink"><a href="vita.modules.s3.s3ocr-pysrc.html#S3XForms._generate_controllers">source&nbsp;code</a></span>&nbsp;
545
 
    </td>
546
 
  </tr></table>
547
 
  
548
 
  <p>Generates etree for conntrollers and translation values for the 
549
 
  resource</p>
550
 
  <dl class="fields">
551
 
  </dl>
552
 
</td></tr></table>
553
 
</div>
554
 
<a name="_get_str"></a>
555
 
<div class="private">
556
 
<table class="details" border="1" cellpadding="3"
557
 
       cellspacing="0" width="100%" bgcolor="white">
558
 
<tr><td>
559
 
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
560
 
  <tr valign="top"><td>
561
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_get_str</span>(<span class="sig-arg">self</span>,
562
 
        <span class="sig-arg">obj</span>)</span>
563
 
  </h3>
564
 
  </td><td align="right" valign="top"
565
 
    ><span class="codelink"><a href="vita.modules.s3.s3ocr-pysrc.html#S3XForms._get_str">source&nbsp;code</a></span>&nbsp;
566
 
    </td>
567
 
  </tr></table>
568
 
  
569
 
  
570
 
  <dl class="fields">
571
 
  </dl>
572
 
</td></tr></table>
573
 
</div>
574
 
<a name="_textvalue"></a>
575
 
<div class="private">
576
 
<table class="details" border="1" cellpadding="3"
577
 
       cellspacing="0" width="100%" bgcolor="white">
578
 
<tr><td>
579
 
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
580
 
  <tr valign="top"><td>
581
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_textvalue</span>(<span class="sig-arg">self</span>,
582
 
        <span class="sig-arg">textid</span>,
583
 
        <span class="sig-arg">valuetext</span>)</span>
584
 
  </h3>
585
 
  </td><td align="right" valign="top"
586
 
    ><span class="codelink"><a href="vita.modules.s3.s3ocr-pysrc.html#S3XForms._textvalue">source&nbsp;code</a></span>&nbsp;
587
 
    </td>
588
 
  </tr></table>
589
 
  
590
 
  <p>simple helper function</p>
591
 
  <dl class="fields">
592
 
  </dl>
593
 
</td></tr></table>
594
 
</div>
595
 
<a name="_itemlabelvalue"></a>
596
 
<div class="private">
597
 
<table class="details" border="1" cellpadding="3"
598
 
       cellspacing="0" width="100%" bgcolor="white">
599
 
<tr><td>
600
 
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
601
 
  <tr valign="top"><td>
602
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_itemlabelvalue</span>(<span class="sig-arg">self</span>,
603
 
        <span class="sig-arg">valuetext</span>,
604
 
        <span class="sig-arg">labeltext</span>=<span class="sig-default">None</span>,
605
 
        <span class="sig-arg">labelref</span>=<span class="sig-default">None</span>)</span>
606
 
  </h3>
607
 
  </td><td align="right" valign="top"
608
 
    ><span class="codelink"><a href="vita.modules.s3.s3ocr-pysrc.html#S3XForms._itemlabelvalue">source&nbsp;code</a></span>&nbsp;
609
 
    </td>
610
 
  </tr></table>
611
 
  
612
 
  <p>simple helper function</p>
613
 
  <dl class="fields">
614
 
  </dl>
615
 
</td></tr></table>
616
 
</div>
617
 
<a name="_get_controller"></a>
618
 
<div class="private">
619
 
<table class="details" border="1" cellpadding="3"
620
 
       cellspacing="0" width="100%" bgcolor="white">
621
 
<tr><td>
622
 
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
623
 
  <tr valign="top"><td>
624
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_get_controller</span>(<span class="sig-arg">self</span>,
625
 
        <span class="sig-arg">controller_name</span>,
626
 
        <span class="sig-arg">kargs</span>,
627
 
        <span class="sig-arg">ref</span>=<span class="sig-default">&quot;&quot;</span>,
628
 
        <span class="sig-arg">labeltext</span>=<span class="sig-default">&quot;&quot;</span>,
629
 
        <span class="sig-arg">readonly</span>=<span class="sig-default">&quot;&quot;</span>,
630
 
        <span class="sig-arg">default</span>=<span class="sig-default">&quot;&quot;</span>,
631
 
        <span class="sig-arg">items_list</span>=<span class="sig-default">[]</span>,
632
 
        <span class="sig-arg">hintref</span>=<span class="sig-default">&quot;&quot;</span>,
633
 
        <span class="sig-arg">labelref</span>=<span class="sig-default">&quot;&quot;</span>)</span>
634
 
  </h3>
635
 
  </td><td align="right" valign="top"
636
 
    ><span class="codelink"><a href="vita.modules.s3.s3ocr-pysrc.html#S3XForms._get_controller">source&nbsp;code</a></span>&nbsp;
637
 
    </td>
638
 
  </tr></table>
639
 
  
640
 
  <p>simple helper function</p>
641
 
  <dl class="fields">
642
 
  </dl>
643
 
</td></tr></table>
644
 
</div>
645
 
<a name="pdf_manager"></a>
646
 
<div>
647
 
<table class="details" border="1" cellpadding="3"
648
 
       cellspacing="0" width="100%" bgcolor="white">
649
 
<tr><td>
650
 
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
651
 
  <tr valign="top"><td>
652
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">pdf_manager</span>(<span class="sig-arg">self</span>)</span>
653
 
  </h3>
654
 
  </td><td align="right" valign="top"
655
 
    ><span class="codelink"><a href="vita.modules.s3.s3ocr-pysrc.html#S3XForms.pdf_manager">source&nbsp;code</a></span>&nbsp;
656
 
    </td>
657
 
  </tr></table>
658
 
  
659
 
  <p>Generate PDFs for the resource</p>
660
 
  <dl class="fields">
661
 
  </dl>
662
 
<div class="fields">      <p><strong>To Do:</strong>
663
 
        ocr implementation would require if (no pdf) : generate + store(db) + 
664
 
    deliver elif (pdf exists) : retrive(db) + deliver
665
 
      </p>
666
 
</div></td></tr></table>
667
 
</div>
668
 
<a name="_uses_requirement"></a>
669
 
<div class="private">
670
 
<table class="details" border="1" cellpadding="3"
671
 
       cellspacing="0" width="100%" bgcolor="white">
672
 
<tr><td>
673
 
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
674
 
  <tr valign="top"><td>
675
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_uses_requirement</span>(<span class="sig-arg">self</span>,
676
 
        <span class="sig-arg">requirement</span>,
677
 
        <span class="sig-arg">field</span>)</span>
678
 
  </h3>
679
 
  </td><td align="right" valign="top"
680
 
    ><span class="codelink"><a href="vita.modules.s3.s3ocr-pysrc.html#S3XForms._uses_requirement">source&nbsp;code</a></span>&nbsp;
681
 
    </td>
682
 
  </tr></table>
683
 
  
684
 
  <p>Check if a given database field uses the specified requirement 
685
 
  (IS_IN_SET, IS_INT_IN_RANGE, etc)</p>
686
 
  <dl class="fields">
687
 
  </dl>
688
 
</td></tr></table>
689
 
</div>
690
 
<br />
691
 
<!-- ==================== NAVIGATION BAR ==================== -->
692
 
<table class="navbar" border="0" width="100%" cellpadding="0"
693
 
       bgcolor="#a0c0ff" cellspacing="0">
694
 
  <tr valign="middle">
695
 
  <!-- Home link -->
696
 
      <th>&nbsp;&nbsp;&nbsp;<a
697
 
        href="vita.modules.s3-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
698
 
 
699
 
  <!-- Tree link -->
700
 
      <th>&nbsp;&nbsp;&nbsp;<a
701
 
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
702
 
 
703
 
  <!-- Index link -->
704
 
      <th>&nbsp;&nbsp;&nbsp;<a
705
 
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
706
 
 
707
 
  <!-- Help link -->
708
 
      <th>&nbsp;&nbsp;&nbsp;<a
709
 
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
710
 
 
711
 
  <!-- Project homepage -->
712
 
      <th class="navbar" align="right" width="100%">
713
 
        <table border="0" cellpadding="0" cellspacing="0">
714
 
          <tr><th class="navbar" align="center"
715
 
            ><a class="navbar" target="_top" href="http://eden.sahanafoundation.org/wiki/S3">S3</a></th>
716
 
          </tr></table></th>
717
 
  </tr>
718
 
</table>
719
 
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
720
 
  <tr>
721
 
    <td align="left" class="footer">
722
 
    Generated by Epydoc 3.0.1 on Tue Mar 29 14:25:41 2011
723
 
    </td>
724
 
    <td align="right" class="footer">
725
 
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
726
 
        >http://epydoc.sourceforge.net</a>
727
 
    </td>
728
 
  </tr>
729
 
</table>
730
 
 
731
 
<script type="text/javascript">
732
 
  <!--
733
 
  // Private objects are initially displayed (because if
734
 
  // javascript is turned off then we want them to be
735
 
  // visible); but by default, we want to hide them.  So hide
736
 
  // them unless we have a cookie that says to show them.
737
 
  checkCookie();
738
 
  // -->
739
 
</script>
740
 
</body>
741
 
</html>