|
1 |
|
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
|
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
4 |
|
5 <html xmlns="http://www.w3.org/1999/xhtml"> |
|
6 <head> |
|
7 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
|
8 <title>pyams_content.shared.form package — PyAMS User Guide 0.1.0 documentation</title> |
|
9 <link rel="stylesheet" href="_static/pyramid.css" type="text/css" /> |
|
10 <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> |
|
11 <script type="text/javascript"> |
|
12 var DOCUMENTATION_OPTIONS = { |
|
13 URL_ROOT: './', |
|
14 VERSION: '0.1.0', |
|
15 COLLAPSE_INDEX: false, |
|
16 FILE_SUFFIX: '.html', |
|
17 HAS_SOURCE: true, |
|
18 SOURCELINK_SUFFIX: '.txt' |
|
19 }; |
|
20 </script> |
|
21 <script type="text/javascript" src="_static/jquery.js"></script> |
|
22 <script type="text/javascript" src="_static/underscore.js"></script> |
|
23 <script type="text/javascript" src="_static/doctools.js"></script> |
|
24 <link rel="index" title="Index" href="genindex.html" /> |
|
25 <link rel="search" title="Search" href="search.html" /> |
|
26 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Neuton&subset=latin" type="text/css" media="screen" charset="utf-8" /> |
|
27 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Nobile:regular,italic,bold,bolditalic&subset=latin" type="text/css" media="screen" charset="utf-8" /> |
|
28 <!--[if lte IE 6]> |
|
29 <link rel="stylesheet" href="_static/ie6.css" type="text/css" media="screen" charset="utf-8" /> |
|
30 <![endif]--> |
|
31 |
|
32 </head> |
|
33 <body> |
|
34 |
|
35 <div class="related" role="navigation" aria-label="related navigation"> |
|
36 <h3>Navigation</h3> |
|
37 <ul> |
|
38 <li class="right" style="margin-right: 10px"> |
|
39 <a href="genindex.html" title="General Index" |
|
40 accesskey="I">index</a></li> |
|
41 <li class="right" > |
|
42 <a href="py-modindex.html" title="Python Module Index" |
|
43 >modules</a> |</li> |
|
44 <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> »</li> |
|
45 </ul> |
|
46 </div> |
|
47 |
|
48 <div class="document"> |
|
49 <div class="documentwrapper"> |
|
50 <div class="bodywrapper"> |
|
51 <div class="body" role="main"> |
|
52 |
|
53 <div class="section" id="pyams-content-shared-form-package"> |
|
54 <h1>pyams_content.shared.form package<a class="headerlink" href="#pyams-content-shared-form-package" title="Permalink to this headline">¶</a></h1> |
|
55 <div class="section" id="subpackages"> |
|
56 <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2> |
|
57 <div class="toctree-wrapper compound"> |
|
58 <ul> |
|
59 <li class="toctree-l1"><a class="reference internal" href="pyams_content.shared.form.interfaces.html">pyams_content.shared.form.interfaces package</a><ul> |
|
60 <li class="toctree-l2"><a class="reference internal" href="pyams_content.shared.form.interfaces.html#module-pyams_content.shared.form.interfaces">Module contents</a></li> |
|
61 </ul> |
|
62 </li> |
|
63 <li class="toctree-l1"><a class="reference internal" href="pyams_content.shared.form.zmi.html">pyams_content.shared.form.zmi package</a><ul> |
|
64 <li class="toctree-l2"><a class="reference internal" href="pyams_content.shared.form.zmi.html#submodules">Submodules</a></li> |
|
65 <li class="toctree-l2"><a class="reference internal" href="pyams_content.shared.form.zmi.html#module-pyams_content.shared.form.zmi.field">pyams_content.shared.form.zmi.field module</a></li> |
|
66 <li class="toctree-l2"><a class="reference internal" href="pyams_content.shared.form.zmi.html#module-pyams_content.shared.form.zmi.preview">pyams_content.shared.form.zmi.preview module</a></li> |
|
67 <li class="toctree-l2"><a class="reference internal" href="pyams_content.shared.form.zmi.html#module-pyams_content.shared.form.zmi.properties">pyams_content.shared.form.zmi.properties module</a></li> |
|
68 <li class="toctree-l2"><a class="reference internal" href="pyams_content.shared.form.zmi.html#module-pyams_content.shared.form.zmi">Module contents</a></li> |
|
69 </ul> |
|
70 </li> |
|
71 </ul> |
|
72 </div> |
|
73 </div> |
|
74 <div class="section" id="submodules"> |
|
75 <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> |
|
76 </div> |
|
77 <div class="section" id="module-pyams_content.shared.form.field"> |
|
78 <span id="pyams-content-shared-form-field-module"></span><h2>pyams_content.shared.form.field module<a class="headerlink" href="#module-pyams_content.shared.form.field" title="Permalink to this headline">¶</a></h2> |
|
79 <dl class="class"> |
|
80 <dt id="pyams_content.shared.form.field.BaseFormFieldFactory"> |
|
81 <em class="property">class </em><code class="descclassname">pyams_content.shared.form.field.</code><code class="descname">BaseFormFieldFactory</code><a class="headerlink" href="#pyams_content.shared.form.field.BaseFormFieldFactory" title="Permalink to this definition">¶</a></dt> |
|
82 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
83 <p>Base form field factory</p> |
|
84 <dl class="attribute"> |
|
85 <dt id="pyams_content.shared.form.field.BaseFormFieldFactory.field_factory"> |
|
86 <code class="descname">field_factory</code><em class="property"> = None</em><a class="headerlink" href="#pyams_content.shared.form.field.BaseFormFieldFactory.field_factory" title="Permalink to this definition">¶</a></dt> |
|
87 <dd></dd></dl> |
|
88 |
|
89 <dl class="method"> |
|
90 <dt id="pyams_content.shared.form.field.BaseFormFieldFactory.get_schema_field"> |
|
91 <code class="descname">get_schema_field</code><span class="sig-paren">(</span><em>field</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.form.field.BaseFormFieldFactory.get_schema_field" title="Permalink to this definition">¶</a></dt> |
|
92 <dd></dd></dl> |
|
93 |
|
94 </dd></dl> |
|
95 |
|
96 <dl class="class"> |
|
97 <dt id="pyams_content.shared.form.field.BooleanFieldFactory"> |
|
98 <em class="property">class </em><code class="descclassname">pyams_content.shared.form.field.</code><code class="descname">BooleanFieldFactory</code><a class="headerlink" href="#pyams_content.shared.form.field.BooleanFieldFactory" title="Permalink to this definition">¶</a></dt> |
|
99 <dd><p>Bases: <a class="reference internal" href="#pyams_content.shared.form.field.BaseFormFieldFactory" title="pyams_content.shared.form.field.BaseFormFieldFactory"><code class="xref py py-class docutils literal"><span class="pre">pyams_content.shared.form.field.BaseFormFieldFactory</span></code></a></p> |
|
100 <p>Boolean field factory</p> |
|
101 <dl class="attribute"> |
|
102 <dt id="pyams_content.shared.form.field.BooleanFieldFactory.field_factory"> |
|
103 <code class="descname">field_factory</code><a class="headerlink" href="#pyams_content.shared.form.field.BooleanFieldFactory.field_factory" title="Permalink to this definition">¶</a></dt> |
|
104 <dd><p>alias of <code class="xref py py-class docutils literal"><span class="pre">Bool</span></code></p> |
|
105 </dd></dl> |
|
106 |
|
107 <dl class="attribute"> |
|
108 <dt id="pyams_content.shared.form.field.BooleanFieldFactory.label"> |
|
109 <code class="descname">label</code><em class="property"> = 'Boolean'</em><a class="headerlink" href="#pyams_content.shared.form.field.BooleanFieldFactory.label" title="Permalink to this definition">¶</a></dt> |
|
110 <dd></dd></dl> |
|
111 |
|
112 <dl class="attribute"> |
|
113 <dt id="pyams_content.shared.form.field.BooleanFieldFactory.weight"> |
|
114 <code class="descname">weight</code><em class="property"> = 3</em><a class="headerlink" href="#pyams_content.shared.form.field.BooleanFieldFactory.weight" title="Permalink to this definition">¶</a></dt> |
|
115 <dd></dd></dl> |
|
116 |
|
117 </dd></dl> |
|
118 |
|
119 <dl class="class"> |
|
120 <dt id="pyams_content.shared.form.field.ChoiceFieldFactory"> |
|
121 <em class="property">class </em><code class="descclassname">pyams_content.shared.form.field.</code><code class="descname">ChoiceFieldFactory</code><a class="headerlink" href="#pyams_content.shared.form.field.ChoiceFieldFactory" title="Permalink to this definition">¶</a></dt> |
|
122 <dd><p>Bases: <a class="reference internal" href="#pyams_content.shared.form.field.ValuesFieldFactory" title="pyams_content.shared.form.field.ValuesFieldFactory"><code class="xref py py-class docutils literal"><span class="pre">pyams_content.shared.form.field.ValuesFieldFactory</span></code></a></p> |
|
123 <p>Choice field factory</p> |
|
124 <dl class="attribute"> |
|
125 <dt id="pyams_content.shared.form.field.ChoiceFieldFactory.field_factory"> |
|
126 <code class="descname">field_factory</code><a class="headerlink" href="#pyams_content.shared.form.field.ChoiceFieldFactory.field_factory" title="Permalink to this definition">¶</a></dt> |
|
127 <dd><p>alias of <code class="xref py py-class docutils literal"><span class="pre">Choice</span></code></p> |
|
128 </dd></dl> |
|
129 |
|
130 <dl class="method"> |
|
131 <dt id="pyams_content.shared.form.field.ChoiceFieldFactory.get_schema_field"> |
|
132 <code class="descname">get_schema_field</code><span class="sig-paren">(</span><em>field</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.form.field.ChoiceFieldFactory.get_schema_field" title="Permalink to this definition">¶</a></dt> |
|
133 <dd></dd></dl> |
|
134 |
|
135 <dl class="attribute"> |
|
136 <dt id="pyams_content.shared.form.field.ChoiceFieldFactory.label"> |
|
137 <code class="descname">label</code><em class="property"> = 'Choice'</em><a class="headerlink" href="#pyams_content.shared.form.field.ChoiceFieldFactory.label" title="Permalink to this definition">¶</a></dt> |
|
138 <dd></dd></dl> |
|
139 |
|
140 <dl class="attribute"> |
|
141 <dt id="pyams_content.shared.form.field.ChoiceFieldFactory.weight"> |
|
142 <code class="descname">weight</code><em class="property"> = 20</em><a class="headerlink" href="#pyams_content.shared.form.field.ChoiceFieldFactory.weight" title="Permalink to this definition">¶</a></dt> |
|
143 <dd></dd></dl> |
|
144 |
|
145 </dd></dl> |
|
146 |
|
147 <dl class="class"> |
|
148 <dt id="pyams_content.shared.form.field.DateFieldFactory"> |
|
149 <em class="property">class </em><code class="descclassname">pyams_content.shared.form.field.</code><code class="descname">DateFieldFactory</code><a class="headerlink" href="#pyams_content.shared.form.field.DateFieldFactory" title="Permalink to this definition">¶</a></dt> |
|
150 <dd><p>Bases: <a class="reference internal" href="#pyams_content.shared.form.field.BaseFormFieldFactory" title="pyams_content.shared.form.field.BaseFormFieldFactory"><code class="xref py py-class docutils literal"><span class="pre">pyams_content.shared.form.field.BaseFormFieldFactory</span></code></a></p> |
|
151 <p>Date field factory</p> |
|
152 <dl class="attribute"> |
|
153 <dt id="pyams_content.shared.form.field.DateFieldFactory.field_factory"> |
|
154 <code class="descname">field_factory</code><a class="headerlink" href="#pyams_content.shared.form.field.DateFieldFactory.field_factory" title="Permalink to this definition">¶</a></dt> |
|
155 <dd><p>alias of <code class="xref py py-class docutils literal"><span class="pre">Date</span></code></p> |
|
156 </dd></dl> |
|
157 |
|
158 <dl class="attribute"> |
|
159 <dt id="pyams_content.shared.form.field.DateFieldFactory.label"> |
|
160 <code class="descname">label</code><em class="property"> = 'Date'</em><a class="headerlink" href="#pyams_content.shared.form.field.DateFieldFactory.label" title="Permalink to this definition">¶</a></dt> |
|
161 <dd></dd></dl> |
|
162 |
|
163 <dl class="attribute"> |
|
164 <dt id="pyams_content.shared.form.field.DateFieldFactory.weight"> |
|
165 <code class="descname">weight</code><em class="property"> = 15</em><a class="headerlink" href="#pyams_content.shared.form.field.DateFieldFactory.weight" title="Permalink to this definition">¶</a></dt> |
|
166 <dd></dd></dl> |
|
167 |
|
168 </dd></dl> |
|
169 |
|
170 <dl class="class"> |
|
171 <dt id="pyams_content.shared.form.field.DecimalFieldFactory"> |
|
172 <em class="property">class </em><code class="descclassname">pyams_content.shared.form.field.</code><code class="descname">DecimalFieldFactory</code><a class="headerlink" href="#pyams_content.shared.form.field.DecimalFieldFactory" title="Permalink to this definition">¶</a></dt> |
|
173 <dd><p>Bases: <a class="reference internal" href="#pyams_content.shared.form.field.BaseFormFieldFactory" title="pyams_content.shared.form.field.BaseFormFieldFactory"><code class="xref py py-class docutils literal"><span class="pre">pyams_content.shared.form.field.BaseFormFieldFactory</span></code></a></p> |
|
174 <p>Decimal field factory</p> |
|
175 <dl class="attribute"> |
|
176 <dt id="pyams_content.shared.form.field.DecimalFieldFactory.field_factory"> |
|
177 <code class="descname">field_factory</code><a class="headerlink" href="#pyams_content.shared.form.field.DecimalFieldFactory.field_factory" title="Permalink to this definition">¶</a></dt> |
|
178 <dd><p>alias of <code class="xref py py-class docutils literal"><span class="pre">Decimal</span></code></p> |
|
179 </dd></dl> |
|
180 |
|
181 <dl class="attribute"> |
|
182 <dt id="pyams_content.shared.form.field.DecimalFieldFactory.label"> |
|
183 <code class="descname">label</code><em class="property"> = 'Decimal'</em><a class="headerlink" href="#pyams_content.shared.form.field.DecimalFieldFactory.label" title="Permalink to this definition">¶</a></dt> |
|
184 <dd></dd></dl> |
|
185 |
|
186 <dl class="attribute"> |
|
187 <dt id="pyams_content.shared.form.field.DecimalFieldFactory.weight"> |
|
188 <code class="descname">weight</code><em class="property"> = 5</em><a class="headerlink" href="#pyams_content.shared.form.field.DecimalFieldFactory.weight" title="Permalink to this definition">¶</a></dt> |
|
189 <dd></dd></dl> |
|
190 |
|
191 </dd></dl> |
|
192 |
|
193 <dl class="class"> |
|
194 <dt id="pyams_content.shared.form.field.FormField"> |
|
195 <em class="property">class </em><code class="descclassname">pyams_content.shared.form.field.</code><code class="descname">FormField</code><a class="headerlink" href="#pyams_content.shared.form.field.FormField" title="Permalink to this definition">¶</a></dt> |
|
196 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">persistent.Persistent</span></code>, <code class="xref py py-class docutils literal"><span class="pre">zope.container.contained.Contained</span></code></p> |
|
197 <p>Form field definition persistent class</p> |
|
198 <dl class="attribute"> |
|
199 <dt id="pyams_content.shared.form.field.FormField.default"> |
|
200 <code class="descname">default</code><a class="headerlink" href="#pyams_content.shared.form.field.FormField.default" title="Permalink to this definition">¶</a></dt> |
|
201 <dd><p>Computed attributes based on schema fields</p> |
|
202 <p>Field properties provide default values, data validation and error messages |
|
203 based on data found in field meta-data.</p> |
|
204 <p>Note that FieldProperties cannot be used with slots. They can only |
|
205 be used for attributes stored in instance dictionaries.</p> |
|
206 </dd></dl> |
|
207 |
|
208 <dl class="attribute"> |
|
209 <dt id="pyams_content.shared.form.field.FormField.description"> |
|
210 <code class="descname">description</code><a class="headerlink" href="#pyams_content.shared.form.field.FormField.description" title="Permalink to this definition">¶</a></dt> |
|
211 <dd><p>Computed attributes based on schema fields</p> |
|
212 <p>Field properties provide default values, data validation and error messages |
|
213 based on data found in field meta-data.</p> |
|
214 <p>Note that FieldProperties cannot be used with slots. They can only |
|
215 be used for attributes stored in instance dictionaries.</p> |
|
216 </dd></dl> |
|
217 |
|
218 <dl class="attribute"> |
|
219 <dt id="pyams_content.shared.form.field.FormField.field_type"> |
|
220 <code class="descname">field_type</code><a class="headerlink" href="#pyams_content.shared.form.field.FormField.field_type" title="Permalink to this definition">¶</a></dt> |
|
221 <dd><p>Computed attributes based on schema fields</p> |
|
222 <p>Field properties provide default values, data validation and error messages |
|
223 based on data found in field meta-data.</p> |
|
224 <p>Note that FieldProperties cannot be used with slots. They can only |
|
225 be used for attributes stored in instance dictionaries.</p> |
|
226 </dd></dl> |
|
227 |
|
228 <dl class="attribute"> |
|
229 <dt id="pyams_content.shared.form.field.FormField.label"> |
|
230 <code class="descname">label</code><a class="headerlink" href="#pyams_content.shared.form.field.FormField.label" title="Permalink to this definition">¶</a></dt> |
|
231 <dd><p>Computed attributes based on schema fields</p> |
|
232 <p>Field properties provide default values, data validation and error messages |
|
233 based on data found in field meta-data.</p> |
|
234 <p>Note that FieldProperties cannot be used with slots. They can only |
|
235 be used for attributes stored in instance dictionaries.</p> |
|
236 </dd></dl> |
|
237 |
|
238 <dl class="attribute"> |
|
239 <dt id="pyams_content.shared.form.field.FormField.name"> |
|
240 <code class="descname">name</code><a class="headerlink" href="#pyams_content.shared.form.field.FormField.name" title="Permalink to this definition">¶</a></dt> |
|
241 <dd><p>Computed attributes based on schema fields</p> |
|
242 <p>Field properties provide default values, data validation and error messages |
|
243 based on data found in field meta-data.</p> |
|
244 <p>Note that FieldProperties cannot be used with slots. They can only |
|
245 be used for attributes stored in instance dictionaries.</p> |
|
246 </dd></dl> |
|
247 |
|
248 <dl class="attribute"> |
|
249 <dt id="pyams_content.shared.form.field.FormField.placeholder"> |
|
250 <code class="descname">placeholder</code><a class="headerlink" href="#pyams_content.shared.form.field.FormField.placeholder" title="Permalink to this definition">¶</a></dt> |
|
251 <dd><p>Computed attributes based on schema fields</p> |
|
252 <p>Field properties provide default values, data validation and error messages |
|
253 based on data found in field meta-data.</p> |
|
254 <p>Note that FieldProperties cannot be used with slots. They can only |
|
255 be used for attributes stored in instance dictionaries.</p> |
|
256 </dd></dl> |
|
257 |
|
258 <dl class="attribute"> |
|
259 <dt id="pyams_content.shared.form.field.FormField.required"> |
|
260 <code class="descname">required</code><a class="headerlink" href="#pyams_content.shared.form.field.FormField.required" title="Permalink to this definition">¶</a></dt> |
|
261 <dd><p>Computed attributes based on schema fields</p> |
|
262 <p>Field properties provide default values, data validation and error messages |
|
263 based on data found in field meta-data.</p> |
|
264 <p>Note that FieldProperties cannot be used with slots. They can only |
|
265 be used for attributes stored in instance dictionaries.</p> |
|
266 </dd></dl> |
|
267 |
|
268 <dl class="attribute"> |
|
269 <dt id="pyams_content.shared.form.field.FormField.values"> |
|
270 <code class="descname">values</code><a class="headerlink" href="#pyams_content.shared.form.field.FormField.values" title="Permalink to this definition">¶</a></dt> |
|
271 <dd><p>Computed attributes based on schema fields</p> |
|
272 <p>Field properties provide default values, data validation and error messages |
|
273 based on data found in field meta-data.</p> |
|
274 <p>Note that FieldProperties cannot be used with slots. They can only |
|
275 be used for attributes stored in instance dictionaries.</p> |
|
276 </dd></dl> |
|
277 |
|
278 <dl class="attribute"> |
|
279 <dt id="pyams_content.shared.form.field.FormField.visible"> |
|
280 <code class="descname">visible</code><a class="headerlink" href="#pyams_content.shared.form.field.FormField.visible" title="Permalink to this definition">¶</a></dt> |
|
281 <dd><p>Computed attributes based on schema fields</p> |
|
282 <p>Field properties provide default values, data validation and error messages |
|
283 based on data found in field meta-data.</p> |
|
284 <p>Note that FieldProperties cannot be used with slots. They can only |
|
285 be used for attributes stored in instance dictionaries.</p> |
|
286 </dd></dl> |
|
287 |
|
288 </dd></dl> |
|
289 |
|
290 <dl class="class"> |
|
291 <dt id="pyams_content.shared.form.field.FormFieldContainer"> |
|
292 <em class="property">class </em><code class="descclassname">pyams_content.shared.form.field.</code><code class="descname">FormFieldContainer</code><a class="headerlink" href="#pyams_content.shared.form.field.FormFieldContainer" title="Permalink to this definition">¶</a></dt> |
|
293 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.container.ordered.OrderedContainer</span></code></p> |
|
294 <p>Form fields container persistent class</p> |
|
295 <dl class="method"> |
|
296 <dt id="pyams_content.shared.form.field.FormFieldContainer.get_fields"> |
|
297 <code class="descname">get_fields</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.form.field.FormFieldContainer.get_fields" title="Permalink to this definition">¶</a></dt> |
|
298 <dd></dd></dl> |
|
299 |
|
300 </dd></dl> |
|
301 |
|
302 <dl class="function"> |
|
303 <dt id="pyams_content.shared.form.field.FormFieldContainerFactory"> |
|
304 <code class="descclassname">pyams_content.shared.form.field.</code><code class="descname">FormFieldContainerFactory</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.form.field.FormFieldContainerFactory" title="Permalink to this definition">¶</a></dt> |
|
305 <dd><p>Form fields container factory</p> |
|
306 </dd></dl> |
|
307 |
|
308 <dl class="class"> |
|
309 <dt id="pyams_content.shared.form.field.FormFieldContainerNamespace"> |
|
310 <em class="property">class </em><code class="descclassname">pyams_content.shared.form.field.</code><code class="descname">FormFieldContainerNamespace</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.form.field.FormFieldContainerNamespace" title="Permalink to this definition">¶</a></dt> |
|
311 <dd><p>Bases: <a class="reference internal" href="pyams_utils.html#pyams_utils.adapter.ContextAdapter" title="pyams_utils.adapter.ContextAdapter"><code class="xref py py-class docutils literal"><span class="pre">pyams_utils.adapter.ContextAdapter</span></code></a></p> |
|
312 <p>Form fields container ++fields++ namespace</p> |
|
313 <dl class="method"> |
|
314 <dt id="pyams_content.shared.form.field.FormFieldContainerNamespace.traverse"> |
|
315 <code class="descname">traverse</code><span class="sig-paren">(</span><em>name</em>, <em>firtherpath=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.form.field.FormFieldContainerNamespace.traverse" title="Permalink to this definition">¶</a></dt> |
|
316 <dd></dd></dl> |
|
317 |
|
318 </dd></dl> |
|
319 |
|
320 <dl class="class"> |
|
321 <dt id="pyams_content.shared.form.field.FormFieldTypesVocabulary"> |
|
322 <em class="property">class </em><code class="descclassname">pyams_content.shared.form.field.</code><code class="descname">FormFieldTypesVocabulary</code><span class="sig-paren">(</span><em>context</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.form.field.FormFieldTypesVocabulary" title="Permalink to this definition">¶</a></dt> |
|
323 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.componentvocabulary.vocabulary.UtilityVocabulary</span></code></p> |
|
324 <p>Form field types vocabulary</p> |
|
325 <dl class="attribute"> |
|
326 <dt id="pyams_content.shared.form.field.FormFieldTypesVocabulary.interface"> |
|
327 <code class="descname">interface</code><em class="property"> = <InterfaceClass pyams_content.shared.form.interfaces.IFormFieldFactory></em><a class="headerlink" href="#pyams_content.shared.form.field.FormFieldTypesVocabulary.interface" title="Permalink to this definition">¶</a></dt> |
|
328 <dd></dd></dl> |
|
329 |
|
330 </dd></dl> |
|
331 |
|
332 <dl class="class"> |
|
333 <dt id="pyams_content.shared.form.field.FormFieldsContainerSublocations"> |
|
334 <em class="property">class </em><code class="descclassname">pyams_content.shared.form.field.</code><code class="descname">FormFieldsContainerSublocations</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.form.field.FormFieldsContainerSublocations" title="Permalink to this definition">¶</a></dt> |
|
335 <dd><p>Bases: <a class="reference internal" href="pyams_utils.html#pyams_utils.adapter.ContextAdapter" title="pyams_utils.adapter.ContextAdapter"><code class="xref py py-class docutils literal"><span class="pre">pyams_utils.adapter.ContextAdapter</span></code></a></p> |
|
336 <p>Form fields container sub-locations adapter</p> |
|
337 <dl class="method"> |
|
338 <dt id="pyams_content.shared.form.field.FormFieldsContainerSublocations.sublocations"> |
|
339 <code class="descname">sublocations</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.form.field.FormFieldsContainerSublocations.sublocations" title="Permalink to this definition">¶</a></dt> |
|
340 <dd></dd></dl> |
|
341 |
|
342 </dd></dl> |
|
343 |
|
344 <dl class="class"> |
|
345 <dt id="pyams_content.shared.form.field.IntegerFieldFactory"> |
|
346 <em class="property">class </em><code class="descclassname">pyams_content.shared.form.field.</code><code class="descname">IntegerFieldFactory</code><a class="headerlink" href="#pyams_content.shared.form.field.IntegerFieldFactory" title="Permalink to this definition">¶</a></dt> |
|
347 <dd><p>Bases: <a class="reference internal" href="#pyams_content.shared.form.field.BaseFormFieldFactory" title="pyams_content.shared.form.field.BaseFormFieldFactory"><code class="xref py py-class docutils literal"><span class="pre">pyams_content.shared.form.field.BaseFormFieldFactory</span></code></a></p> |
|
348 <p>Integer field factory</p> |
|
349 <dl class="attribute"> |
|
350 <dt id="pyams_content.shared.form.field.IntegerFieldFactory.field_factory"> |
|
351 <code class="descname">field_factory</code><a class="headerlink" href="#pyams_content.shared.form.field.IntegerFieldFactory.field_factory" title="Permalink to this definition">¶</a></dt> |
|
352 <dd><p>alias of <code class="xref py py-class docutils literal"><span class="pre">Int</span></code></p> |
|
353 </dd></dl> |
|
354 |
|
355 <dl class="attribute"> |
|
356 <dt id="pyams_content.shared.form.field.IntegerFieldFactory.label"> |
|
357 <code class="descname">label</code><em class="property"> = 'Integer'</em><a class="headerlink" href="#pyams_content.shared.form.field.IntegerFieldFactory.label" title="Permalink to this definition">¶</a></dt> |
|
358 <dd></dd></dl> |
|
359 |
|
360 <dl class="attribute"> |
|
361 <dt id="pyams_content.shared.form.field.IntegerFieldFactory.weight"> |
|
362 <code class="descname">weight</code><em class="property"> = 4</em><a class="headerlink" href="#pyams_content.shared.form.field.IntegerFieldFactory.weight" title="Permalink to this definition">¶</a></dt> |
|
363 <dd></dd></dl> |
|
364 |
|
365 </dd></dl> |
|
366 |
|
367 <dl class="class"> |
|
368 <dt id="pyams_content.shared.form.field.ListFieldFactory"> |
|
369 <em class="property">class </em><code class="descclassname">pyams_content.shared.form.field.</code><code class="descname">ListFieldFactory</code><a class="headerlink" href="#pyams_content.shared.form.field.ListFieldFactory" title="Permalink to this definition">¶</a></dt> |
|
370 <dd><p>Bases: <a class="reference internal" href="#pyams_content.shared.form.field.ValuesFieldFactory" title="pyams_content.shared.form.field.ValuesFieldFactory"><code class="xref py py-class docutils literal"><span class="pre">pyams_content.shared.form.field.ValuesFieldFactory</span></code></a></p> |
|
371 <p>List field factory</p> |
|
372 <dl class="attribute"> |
|
373 <dt id="pyams_content.shared.form.field.ListFieldFactory.field_factory"> |
|
374 <code class="descname">field_factory</code><a class="headerlink" href="#pyams_content.shared.form.field.ListFieldFactory.field_factory" title="Permalink to this definition">¶</a></dt> |
|
375 <dd><p>alias of <code class="xref py py-class docutils literal"><span class="pre">List</span></code></p> |
|
376 </dd></dl> |
|
377 |
|
378 <dl class="method"> |
|
379 <dt id="pyams_content.shared.form.field.ListFieldFactory.get_schema_field"> |
|
380 <code class="descname">get_schema_field</code><span class="sig-paren">(</span><em>field</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.form.field.ListFieldFactory.get_schema_field" title="Permalink to this definition">¶</a></dt> |
|
381 <dd></dd></dl> |
|
382 |
|
383 <dl class="attribute"> |
|
384 <dt id="pyams_content.shared.form.field.ListFieldFactory.label"> |
|
385 <code class="descname">label</code><em class="property"> = 'List'</em><a class="headerlink" href="#pyams_content.shared.form.field.ListFieldFactory.label" title="Permalink to this definition">¶</a></dt> |
|
386 <dd></dd></dl> |
|
387 |
|
388 <dl class="attribute"> |
|
389 <dt id="pyams_content.shared.form.field.ListFieldFactory.weight"> |
|
390 <code class="descname">weight</code><em class="property"> = 51</em><a class="headerlink" href="#pyams_content.shared.form.field.ListFieldFactory.weight" title="Permalink to this definition">¶</a></dt> |
|
391 <dd></dd></dl> |
|
392 |
|
393 </dd></dl> |
|
394 |
|
395 <dl class="class"> |
|
396 <dt id="pyams_content.shared.form.field.MailFieldFactory"> |
|
397 <em class="property">class </em><code class="descclassname">pyams_content.shared.form.field.</code><code class="descname">MailFieldFactory</code><a class="headerlink" href="#pyams_content.shared.form.field.MailFieldFactory" title="Permalink to this definition">¶</a></dt> |
|
398 <dd><p>Bases: <a class="reference internal" href="#pyams_content.shared.form.field.BaseFormFieldFactory" title="pyams_content.shared.form.field.BaseFormFieldFactory"><code class="xref py py-class docutils literal"><span class="pre">pyams_content.shared.form.field.BaseFormFieldFactory</span></code></a></p> |
|
399 <p>Mail field factory</p> |
|
400 <dl class="attribute"> |
|
401 <dt id="pyams_content.shared.form.field.MailFieldFactory.field_factory"> |
|
402 <code class="descname">field_factory</code><a class="headerlink" href="#pyams_content.shared.form.field.MailFieldFactory.field_factory" title="Permalink to this definition">¶</a></dt> |
|
403 <dd><p>alias of <code class="xref py py-class docutils literal"><span class="pre">MailAddressField</span></code></p> |
|
404 </dd></dl> |
|
405 |
|
406 <dl class="attribute"> |
|
407 <dt id="pyams_content.shared.form.field.MailFieldFactory.label"> |
|
408 <code class="descname">label</code><em class="property"> = 'E-mail address'</em><a class="headerlink" href="#pyams_content.shared.form.field.MailFieldFactory.label" title="Permalink to this definition">¶</a></dt> |
|
409 <dd></dd></dl> |
|
410 |
|
411 <dl class="attribute"> |
|
412 <dt id="pyams_content.shared.form.field.MailFieldFactory.weight"> |
|
413 <code class="descname">weight</code><em class="property"> = 10</em><a class="headerlink" href="#pyams_content.shared.form.field.MailFieldFactory.weight" title="Permalink to this definition">¶</a></dt> |
|
414 <dd></dd></dl> |
|
415 |
|
416 </dd></dl> |
|
417 |
|
418 <dl class="class"> |
|
419 <dt id="pyams_content.shared.form.field.TextFieldFactory"> |
|
420 <em class="property">class </em><code class="descclassname">pyams_content.shared.form.field.</code><code class="descname">TextFieldFactory</code><a class="headerlink" href="#pyams_content.shared.form.field.TextFieldFactory" title="Permalink to this definition">¶</a></dt> |
|
421 <dd><p>Bases: <a class="reference internal" href="#pyams_content.shared.form.field.BaseFormFieldFactory" title="pyams_content.shared.form.field.BaseFormFieldFactory"><code class="xref py py-class docutils literal"><span class="pre">pyams_content.shared.form.field.BaseFormFieldFactory</span></code></a></p> |
|
422 <p>Text field factory</p> |
|
423 <dl class="attribute"> |
|
424 <dt id="pyams_content.shared.form.field.TextFieldFactory.field_factory"> |
|
425 <code class="descname">field_factory</code><a class="headerlink" href="#pyams_content.shared.form.field.TextFieldFactory.field_factory" title="Permalink to this definition">¶</a></dt> |
|
426 <dd><p>alias of <code class="xref py py-class docutils literal"><span class="pre">Text</span></code></p> |
|
427 </dd></dl> |
|
428 |
|
429 <dl class="attribute"> |
|
430 <dt id="pyams_content.shared.form.field.TextFieldFactory.label"> |
|
431 <code class="descname">label</code><em class="property"> = 'Multi-lines text'</em><a class="headerlink" href="#pyams_content.shared.form.field.TextFieldFactory.label" title="Permalink to this definition">¶</a></dt> |
|
432 <dd></dd></dl> |
|
433 |
|
434 <dl class="attribute"> |
|
435 <dt id="pyams_content.shared.form.field.TextFieldFactory.weight"> |
|
436 <code class="descname">weight</code><em class="property"> = 2</em><a class="headerlink" href="#pyams_content.shared.form.field.TextFieldFactory.weight" title="Permalink to this definition">¶</a></dt> |
|
437 <dd></dd></dl> |
|
438 |
|
439 </dd></dl> |
|
440 |
|
441 <dl class="class"> |
|
442 <dt id="pyams_content.shared.form.field.TextLineFieldFactory"> |
|
443 <em class="property">class </em><code class="descclassname">pyams_content.shared.form.field.</code><code class="descname">TextLineFieldFactory</code><a class="headerlink" href="#pyams_content.shared.form.field.TextLineFieldFactory" title="Permalink to this definition">¶</a></dt> |
|
444 <dd><p>Bases: <a class="reference internal" href="#pyams_content.shared.form.field.BaseFormFieldFactory" title="pyams_content.shared.form.field.BaseFormFieldFactory"><code class="xref py py-class docutils literal"><span class="pre">pyams_content.shared.form.field.BaseFormFieldFactory</span></code></a></p> |
|
445 <p>Textline field factory</p> |
|
446 <dl class="attribute"> |
|
447 <dt id="pyams_content.shared.form.field.TextLineFieldFactory.field_factory"> |
|
448 <code class="descname">field_factory</code><a class="headerlink" href="#pyams_content.shared.form.field.TextLineFieldFactory.field_factory" title="Permalink to this definition">¶</a></dt> |
|
449 <dd><p>alias of <code class="xref py py-class docutils literal"><span class="pre">TextLine</span></code></p> |
|
450 </dd></dl> |
|
451 |
|
452 <dl class="attribute"> |
|
453 <dt id="pyams_content.shared.form.field.TextLineFieldFactory.label"> |
|
454 <code class="descname">label</code><em class="property"> = 'Text'</em><a class="headerlink" href="#pyams_content.shared.form.field.TextLineFieldFactory.label" title="Permalink to this definition">¶</a></dt> |
|
455 <dd></dd></dl> |
|
456 |
|
457 <dl class="attribute"> |
|
458 <dt id="pyams_content.shared.form.field.TextLineFieldFactory.weight"> |
|
459 <code class="descname">weight</code><em class="property"> = 1</em><a class="headerlink" href="#pyams_content.shared.form.field.TextLineFieldFactory.weight" title="Permalink to this definition">¶</a></dt> |
|
460 <dd></dd></dl> |
|
461 |
|
462 </dd></dl> |
|
463 |
|
464 <dl class="class"> |
|
465 <dt id="pyams_content.shared.form.field.URIFieldFactory"> |
|
466 <em class="property">class </em><code class="descclassname">pyams_content.shared.form.field.</code><code class="descname">URIFieldFactory</code><a class="headerlink" href="#pyams_content.shared.form.field.URIFieldFactory" title="Permalink to this definition">¶</a></dt> |
|
467 <dd><p>Bases: <a class="reference internal" href="#pyams_content.shared.form.field.BaseFormFieldFactory" title="pyams_content.shared.form.field.BaseFormFieldFactory"><code class="xref py py-class docutils literal"><span class="pre">pyams_content.shared.form.field.BaseFormFieldFactory</span></code></a></p> |
|
468 <p>URI field factory</p> |
|
469 <dl class="attribute"> |
|
470 <dt id="pyams_content.shared.form.field.URIFieldFactory.field_factory"> |
|
471 <code class="descname">field_factory</code><a class="headerlink" href="#pyams_content.shared.form.field.URIFieldFactory.field_factory" title="Permalink to this definition">¶</a></dt> |
|
472 <dd><p>alias of <code class="xref py py-class docutils literal"><span class="pre">URI</span></code></p> |
|
473 </dd></dl> |
|
474 |
|
475 <dl class="attribute"> |
|
476 <dt id="pyams_content.shared.form.field.URIFieldFactory.label"> |
|
477 <code class="descname">label</code><em class="property"> = 'URI'</em><a class="headerlink" href="#pyams_content.shared.form.field.URIFieldFactory.label" title="Permalink to this definition">¶</a></dt> |
|
478 <dd></dd></dl> |
|
479 |
|
480 <dl class="attribute"> |
|
481 <dt id="pyams_content.shared.form.field.URIFieldFactory.weight"> |
|
482 <code class="descname">weight</code><em class="property"> = 11</em><a class="headerlink" href="#pyams_content.shared.form.field.URIFieldFactory.weight" title="Permalink to this definition">¶</a></dt> |
|
483 <dd></dd></dl> |
|
484 |
|
485 </dd></dl> |
|
486 |
|
487 <dl class="class"> |
|
488 <dt id="pyams_content.shared.form.field.ValuesFieldFactory"> |
|
489 <em class="property">class </em><code class="descclassname">pyams_content.shared.form.field.</code><code class="descname">ValuesFieldFactory</code><a class="headerlink" href="#pyams_content.shared.form.field.ValuesFieldFactory" title="Permalink to this definition">¶</a></dt> |
|
490 <dd><p>Bases: <a class="reference internal" href="#pyams_content.shared.form.field.BaseFormFieldFactory" title="pyams_content.shared.form.field.BaseFormFieldFactory"><code class="xref py py-class docutils literal"><span class="pre">pyams_content.shared.form.field.BaseFormFieldFactory</span></code></a></p> |
|
491 <p>Values-based field factory</p> |
|
492 </dd></dl> |
|
493 |
|
494 </div> |
|
495 <div class="section" id="module-pyams_content.shared.form.handler"> |
|
496 <span id="pyams-content-shared-form-handler-module"></span><h2>pyams_content.shared.form.handler module<a class="headerlink" href="#module-pyams_content.shared.form.handler" title="Permalink to this headline">¶</a></h2> |
|
497 <dl class="class"> |
|
498 <dt id="pyams_content.shared.form.handler.FormHandlersVocabulary"> |
|
499 <em class="property">class </em><code class="descclassname">pyams_content.shared.form.handler.</code><code class="descname">FormHandlersVocabulary</code><span class="sig-paren">(</span><em>context</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.form.handler.FormHandlersVocabulary" title="Permalink to this definition">¶</a></dt> |
|
500 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.componentvocabulary.vocabulary.UtilityVocabulary</span></code></p> |
|
501 <p>Form handlers vocabulary</p> |
|
502 <dl class="attribute"> |
|
503 <dt id="pyams_content.shared.form.handler.FormHandlersVocabulary.interface"> |
|
504 <code class="descname">interface</code><em class="property"> = <InterfaceClass pyams_content.shared.form.interfaces.IFormHandler></em><a class="headerlink" href="#pyams_content.shared.form.handler.FormHandlersVocabulary.interface" title="Permalink to this definition">¶</a></dt> |
|
505 <dd></dd></dl> |
|
506 |
|
507 </dd></dl> |
|
508 |
|
509 <dl class="class"> |
|
510 <dt id="pyams_content.shared.form.handler.MailtoFormHandler"> |
|
511 <em class="property">class </em><code class="descclassname">pyams_content.shared.form.handler.</code><code class="descname">MailtoFormHandler</code><a class="headerlink" href="#pyams_content.shared.form.handler.MailtoFormHandler" title="Permalink to this definition">¶</a></dt> |
|
512 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
513 <p>Mailto form handler</p> |
|
514 <dl class="method"> |
|
515 <dt id="pyams_content.shared.form.handler.MailtoFormHandler.handle"> |
|
516 <code class="descname">handle</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.form.handler.MailtoFormHandler.handle" title="Permalink to this definition">¶</a></dt> |
|
517 <dd></dd></dl> |
|
518 |
|
519 <dl class="attribute"> |
|
520 <dt id="pyams_content.shared.form.handler.MailtoFormHandler.handler_info"> |
|
521 <code class="descname">handler_info</code><em class="property"> = <InterfaceClass pyams_content.shared.form.interfaces.IMailtoHandlerInfo></em><a class="headerlink" href="#pyams_content.shared.form.handler.MailtoFormHandler.handler_info" title="Permalink to this definition">¶</a></dt> |
|
522 <dd></dd></dl> |
|
523 |
|
524 <dl class="attribute"> |
|
525 <dt id="pyams_content.shared.form.handler.MailtoFormHandler.label"> |
|
526 <code class="descname">label</code><em class="property"> = 'Mailto form handler'</em><a class="headerlink" href="#pyams_content.shared.form.handler.MailtoFormHandler.label" title="Permalink to this definition">¶</a></dt> |
|
527 <dd></dd></dl> |
|
528 |
|
529 <dl class="attribute"> |
|
530 <dt id="pyams_content.shared.form.handler.MailtoFormHandler.target_interface"> |
|
531 <code class="descname">target_interface</code><em class="property"> = <InterfaceClass pyams_content.shared.form.interfaces.IMailtoHandlerTarget></em><a class="headerlink" href="#pyams_content.shared.form.handler.MailtoFormHandler.target_interface" title="Permalink to this definition">¶</a></dt> |
|
532 <dd></dd></dl> |
|
533 |
|
534 </dd></dl> |
|
535 |
|
536 <dl class="class"> |
|
537 <dt id="pyams_content.shared.form.handler.MailtoFormHandlerInfo"> |
|
538 <em class="property">class </em><code class="descclassname">pyams_content.shared.form.handler.</code><code class="descname">MailtoFormHandlerInfo</code><a class="headerlink" href="#pyams_content.shared.form.handler.MailtoFormHandlerInfo" title="Permalink to this definition">¶</a></dt> |
|
539 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">persistent.Persistent</span></code></p> |
|
540 <p>Mailto form handler persistent info</p> |
|
541 <dl class="attribute"> |
|
542 <dt id="pyams_content.shared.form.handler.MailtoFormHandlerInfo.source_address"> |
|
543 <code class="descname">source_address</code><a class="headerlink" href="#pyams_content.shared.form.handler.MailtoFormHandlerInfo.source_address" title="Permalink to this definition">¶</a></dt> |
|
544 <dd><p>Computed attributes based on schema fields</p> |
|
545 <p>Field properties provide default values, data validation and error messages |
|
546 based on data found in field meta-data.</p> |
|
547 <p>Note that FieldProperties cannot be used with slots. They can only |
|
548 be used for attributes stored in instance dictionaries.</p> |
|
549 </dd></dl> |
|
550 |
|
551 <dl class="attribute"> |
|
552 <dt id="pyams_content.shared.form.handler.MailtoFormHandlerInfo.source_name"> |
|
553 <code class="descname">source_name</code><a class="headerlink" href="#pyams_content.shared.form.handler.MailtoFormHandlerInfo.source_name" title="Permalink to this definition">¶</a></dt> |
|
554 <dd><p>Computed attributes based on schema fields</p> |
|
555 <p>Field properties provide default values, data validation and error messages |
|
556 based on data found in field meta-data.</p> |
|
557 <p>Note that FieldProperties cannot be used with slots. They can only |
|
558 be used for attributes stored in instance dictionaries.</p> |
|
559 </dd></dl> |
|
560 |
|
561 <dl class="attribute"> |
|
562 <dt id="pyams_content.shared.form.handler.MailtoFormHandlerInfo.target_address"> |
|
563 <code class="descname">target_address</code><a class="headerlink" href="#pyams_content.shared.form.handler.MailtoFormHandlerInfo.target_address" title="Permalink to this definition">¶</a></dt> |
|
564 <dd><p>Computed attributes based on schema fields</p> |
|
565 <p>Field properties provide default values, data validation and error messages |
|
566 based on data found in field meta-data.</p> |
|
567 <p>Note that FieldProperties cannot be used with slots. They can only |
|
568 be used for attributes stored in instance dictionaries.</p> |
|
569 </dd></dl> |
|
570 |
|
571 <dl class="attribute"> |
|
572 <dt id="pyams_content.shared.form.handler.MailtoFormHandlerInfo.target_name"> |
|
573 <code class="descname">target_name</code><a class="headerlink" href="#pyams_content.shared.form.handler.MailtoFormHandlerInfo.target_name" title="Permalink to this definition">¶</a></dt> |
|
574 <dd><p>Computed attributes based on schema fields</p> |
|
575 <p>Field properties provide default values, data validation and error messages |
|
576 based on data found in field meta-data.</p> |
|
577 <p>Note that FieldProperties cannot be used with slots. They can only |
|
578 be used for attributes stored in instance dictionaries.</p> |
|
579 </dd></dl> |
|
580 |
|
581 </dd></dl> |
|
582 |
|
583 <dl class="function"> |
|
584 <dt id="pyams_content.shared.form.handler.mailto_form_handler_factory"> |
|
585 <code class="descclassname">pyams_content.shared.form.handler.</code><code class="descname">mailto_form_handler_factory</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.form.handler.mailto_form_handler_factory" title="Permalink to this definition">¶</a></dt> |
|
586 <dd><p>Mailto form handler factory</p> |
|
587 </dd></dl> |
|
588 |
|
589 </div> |
|
590 <div class="section" id="module-pyams_content.shared.form.manager"> |
|
591 <span id="pyams-content-shared-form-manager-module"></span><h2>pyams_content.shared.form.manager module<a class="headerlink" href="#module-pyams_content.shared.form.manager" title="Permalink to this headline">¶</a></h2> |
|
592 <dl class="class"> |
|
593 <dt id="pyams_content.shared.form.manager.FormsManager"> |
|
594 <em class="property">class </em><code class="descclassname">pyams_content.shared.form.manager.</code><code class="descname">FormsManager</code><a class="headerlink" href="#pyams_content.shared.form.manager.FormsManager" title="Permalink to this definition">¶</a></dt> |
|
595 <dd><p>Bases: <a class="reference internal" href="pyams_content.shared.common.html#pyams_content.shared.common.manager.SharedTool" title="pyams_content.shared.common.manager.SharedTool"><code class="xref py py-class docutils literal"><span class="pre">pyams_content.shared.common.manager.SharedTool</span></code></a></p> |
|
596 <p>Forms manager class</p> |
|
597 <dl class="attribute"> |
|
598 <dt id="pyams_content.shared.form.manager.FormsManager.shared_content_factory"> |
|
599 <code class="descname">shared_content_factory</code><a class="headerlink" href="#pyams_content.shared.form.manager.FormsManager.shared_content_factory" title="Permalink to this definition">¶</a></dt> |
|
600 <dd><p>alias of <code class="xref py py-class docutils literal"><span class="pre">Form</span></code></p> |
|
601 </dd></dl> |
|
602 |
|
603 <dl class="attribute"> |
|
604 <dt id="pyams_content.shared.form.manager.FormsManager.shared_content_type"> |
|
605 <code class="descname">shared_content_type</code><em class="property"> = 'form'</em><a class="headerlink" href="#pyams_content.shared.form.manager.FormsManager.shared_content_type" title="Permalink to this definition">¶</a></dt> |
|
606 <dd></dd></dl> |
|
607 |
|
608 </dd></dl> |
|
609 |
|
610 <dl class="function"> |
|
611 <dt id="pyams_content.shared.form.manager.handle_added_forms_manager"> |
|
612 <code class="descclassname">pyams_content.shared.form.manager.</code><code class="descname">handle_added_forms_manager</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.form.manager.handle_added_forms_manager" title="Permalink to this definition">¶</a></dt> |
|
613 <dd><p>Register forms manager when added</p> |
|
614 </dd></dl> |
|
615 |
|
616 </div> |
|
617 <div class="section" id="module-pyams_content.shared.form"> |
|
618 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyams_content.shared.form" title="Permalink to this headline">¶</a></h2> |
|
619 <dl class="class"> |
|
620 <dt id="pyams_content.shared.form.Form"> |
|
621 <em class="property">class </em><code class="descclassname">pyams_content.shared.form.</code><code class="descname">Form</code><a class="headerlink" href="#pyams_content.shared.form.Form" title="Permalink to this definition">¶</a></dt> |
|
622 <dd><p>Bases: <a class="reference internal" href="pyams_content.shared.common.html#pyams_content.shared.common.SharedContent" title="pyams_content.shared.common.SharedContent"><code class="xref py py-class docutils literal"><span class="pre">pyams_content.shared.common.SharedContent</span></code></a></p> |
|
623 <p>Workflow managed form class</p> |
|
624 <dl class="attribute"> |
|
625 <dt id="pyams_content.shared.form.Form.content_class"> |
|
626 <code class="descname">content_class</code><a class="headerlink" href="#pyams_content.shared.form.Form.content_class" title="Permalink to this definition">¶</a></dt> |
|
627 <dd><p>alias of <a class="reference internal" href="#pyams_content.shared.form.WfForm" title="pyams_content.shared.form.WfForm"><code class="xref py py-class docutils literal"><span class="pre">WfForm</span></code></a></p> |
|
628 </dd></dl> |
|
629 |
|
630 </dd></dl> |
|
631 |
|
632 <dl class="class"> |
|
633 <dt id="pyams_content.shared.form.WfForm"> |
|
634 <em class="property">class </em><code class="descclassname">pyams_content.shared.form.</code><code class="descname">WfForm</code><a class="headerlink" href="#pyams_content.shared.form.WfForm" title="Permalink to this definition">¶</a></dt> |
|
635 <dd><p>Bases: <a class="reference internal" href="pyams_content.shared.common.html#pyams_content.shared.common.WfSharedContent" title="pyams_content.shared.common.WfSharedContent"><code class="xref py py-class docutils literal"><span class="pre">pyams_content.shared.common.WfSharedContent</span></code></a></p> |
|
636 <p>Base form</p> |
|
637 <dl class="attribute"> |
|
638 <dt id="pyams_content.shared.form.WfForm.auth_only"> |
|
639 <code class="descname">auth_only</code><a class="headerlink" href="#pyams_content.shared.form.WfForm.auth_only" title="Permalink to this definition">¶</a></dt> |
|
640 <dd><p>Computed attributes based on schema fields</p> |
|
641 <p>Field properties provide default values, data validation and error messages |
|
642 based on data found in field meta-data.</p> |
|
643 <p>Note that FieldProperties cannot be used with slots. They can only |
|
644 be used for attributes stored in instance dictionaries.</p> |
|
645 </dd></dl> |
|
646 |
|
647 <dl class="attribute"> |
|
648 <dt id="pyams_content.shared.form.WfForm.content_name"> |
|
649 <code class="descname">content_name</code><em class="property"> = 'Form'</em><a class="headerlink" href="#pyams_content.shared.form.WfForm.content_name" title="Permalink to this definition">¶</a></dt> |
|
650 <dd></dd></dl> |
|
651 |
|
652 <dl class="attribute"> |
|
653 <dt id="pyams_content.shared.form.WfForm.content_type"> |
|
654 <code class="descname">content_type</code><em class="property"> = 'form'</em><a class="headerlink" href="#pyams_content.shared.form.WfForm.content_type" title="Permalink to this definition">¶</a></dt> |
|
655 <dd></dd></dl> |
|
656 |
|
657 <dl class="attribute"> |
|
658 <dt id="pyams_content.shared.form.WfForm.handler"> |
|
659 <code class="descname">handler</code><a class="headerlink" href="#pyams_content.shared.form.WfForm.handler" title="Permalink to this definition">¶</a></dt> |
|
660 <dd></dd></dl> |
|
661 |
|
662 <dl class="attribute"> |
|
663 <dt id="pyams_content.shared.form.WfForm.header"> |
|
664 <code class="descname">header</code><a class="headerlink" href="#pyams_content.shared.form.WfForm.header" title="Permalink to this definition">¶</a></dt> |
|
665 <dd><p>Computed attributes based on schema fields</p> |
|
666 <p>Field properties provide default values, data validation and error messages |
|
667 based on data found in field meta-data.</p> |
|
668 <p>Note that FieldProperties cannot be used with slots. They can only |
|
669 be used for attributes stored in instance dictionaries.</p> |
|
670 </dd></dl> |
|
671 |
|
672 <dl class="method"> |
|
673 <dt id="pyams_content.shared.form.WfForm.query_handler"> |
|
674 <code class="descname">query_handler</code><span class="sig-paren">(</span><em>handler=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.form.WfForm.query_handler" title="Permalink to this definition">¶</a></dt> |
|
675 <dd></dd></dl> |
|
676 |
|
677 <dl class="attribute"> |
|
678 <dt id="pyams_content.shared.form.WfForm.submit_label"> |
|
679 <code class="descname">submit_label</code><a class="headerlink" href="#pyams_content.shared.form.WfForm.submit_label" title="Permalink to this definition">¶</a></dt> |
|
680 <dd><p>Computed attributes based on schema fields</p> |
|
681 <p>Field properties provide default values, data validation and error messages |
|
682 based on data found in field meta-data.</p> |
|
683 <p>Note that FieldProperties cannot be used with slots. They can only |
|
684 be used for attributes stored in instance dictionaries.</p> |
|
685 </dd></dl> |
|
686 |
|
687 <dl class="attribute"> |
|
688 <dt id="pyams_content.shared.form.WfForm.use_captcha"> |
|
689 <code class="descname">use_captcha</code><a class="headerlink" href="#pyams_content.shared.form.WfForm.use_captcha" title="Permalink to this definition">¶</a></dt> |
|
690 <dd><p>Computed attributes based on schema fields</p> |
|
691 <p>Field properties provide default values, data validation and error messages |
|
692 based on data found in field meta-data.</p> |
|
693 <p>Note that FieldProperties cannot be used with slots. They can only |
|
694 be used for attributes stored in instance dictionaries.</p> |
|
695 </dd></dl> |
|
696 |
|
697 <dl class="attribute"> |
|
698 <dt id="pyams_content.shared.form.WfForm.user_title"> |
|
699 <code class="descname">user_title</code><a class="headerlink" href="#pyams_content.shared.form.WfForm.user_title" title="Permalink to this definition">¶</a></dt> |
|
700 <dd><p>Computed attributes based on schema fields</p> |
|
701 <p>Field properties provide default values, data validation and error messages |
|
702 based on data found in field meta-data.</p> |
|
703 <p>Note that FieldProperties cannot be used with slots. They can only |
|
704 be used for attributes stored in instance dictionaries.</p> |
|
705 </dd></dl> |
|
706 |
|
707 </dd></dl> |
|
708 |
|
709 <dl class="class"> |
|
710 <dt id="pyams_content.shared.form.WfFormContentChecker"> |
|
711 <em class="property">class </em><code class="descclassname">pyams_content.shared.form.</code><code class="descname">WfFormContentChecker</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.form.WfFormContentChecker" title="Permalink to this definition">¶</a></dt> |
|
712 <dd><p>Bases: <a class="reference internal" href="pyams_content.shared.common.html#pyams_content.shared.common.WfSharedContentChecker" title="pyams_content.shared.common.WfSharedContentChecker"><code class="xref py py-class docutils literal"><span class="pre">pyams_content.shared.common.WfSharedContentChecker</span></code></a></p> |
|
713 <p>Form content checker</p> |
|
714 <dl class="method"> |
|
715 <dt id="pyams_content.shared.form.WfFormContentChecker.inner_check"> |
|
716 <code class="descname">inner_check</code><span class="sig-paren">(</span><em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content.shared.form.WfFormContentChecker.inner_check" title="Permalink to this definition">¶</a></dt> |
|
717 <dd></dd></dl> |
|
718 |
|
719 </dd></dl> |
|
720 |
|
721 </div> |
|
722 </div> |
|
723 |
|
724 |
|
725 </div> |
|
726 </div> |
|
727 </div> |
|
728 <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> |
|
729 <div class="sphinxsidebarwrapper"> |
|
730 <h3><a href="index.html">Table Of Contents</a></h3> |
|
731 <ul> |
|
732 <li><a class="reference internal" href="#">pyams_content.shared.form package</a><ul> |
|
733 <li><a class="reference internal" href="#subpackages">Subpackages</a></li> |
|
734 <li><a class="reference internal" href="#submodules">Submodules</a></li> |
|
735 <li><a class="reference internal" href="#module-pyams_content.shared.form.field">pyams_content.shared.form.field module</a></li> |
|
736 <li><a class="reference internal" href="#module-pyams_content.shared.form.handler">pyams_content.shared.form.handler module</a></li> |
|
737 <li><a class="reference internal" href="#module-pyams_content.shared.form.manager">pyams_content.shared.form.manager module</a></li> |
|
738 <li><a class="reference internal" href="#module-pyams_content.shared.form">Module contents</a></li> |
|
739 </ul> |
|
740 </li> |
|
741 </ul> |
|
742 |
|
743 <div id="searchbox" style="display: none" role="search"> |
|
744 <h3>Quick search</h3> |
|
745 <form class="search" action="search.html" method="get"> |
|
746 <div><input type="text" name="q" /></div> |
|
747 <div><input type="submit" value="Go" /></div> |
|
748 <input type="hidden" name="check_keywords" value="yes" /> |
|
749 <input type="hidden" name="area" value="default" /> |
|
750 </form> |
|
751 </div> |
|
752 <script type="text/javascript">$('#searchbox').show(0);</script> |
|
753 </div> |
|
754 </div> |
|
755 <div class="clearer"></div> |
|
756 </div> |
|
757 <div class="related" role="navigation" aria-label="related navigation"> |
|
758 <h3>Navigation</h3> |
|
759 <ul> |
|
760 <li class="right" style="margin-right: 10px"> |
|
761 <a href="genindex.html" title="General Index" |
|
762 >index</a></li> |
|
763 <li class="right" > |
|
764 <a href="py-modindex.html" title="Python Module Index" |
|
765 >modules</a> |</li> |
|
766 <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> »</li> |
|
767 </ul> |
|
768 </div> |
|
769 <div class="footer" role="contentinfo"> |
|
770 © Copyright 2017, Thierry Florac. |
|
771 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5. |
|
772 </div> |
|
773 </body> |
|
774 </html> |