| author | Nicolas Chauvat <nicolas.chauvat@logilab.fr> |
| Tue, 20 Apr 2010 15:33:09 +0200 | |
| branch | stable |
| changeset 5350 | 49c065ae225e |
| parent 4743 | 026a89520184 |
| child 5368 | d321e4b62a10 |
| permissions | -rw-r--r-- |
|
1714
a721966779be
new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff
changeset
|
1 |
Form construction |
|
a721966779be
new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff
changeset
|
2 |
------------------ |
|
4743
026a89520184
[book] a few autoclasses for renderers, misc tweaks
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
4465
diff
changeset
|
3 |
|
|
026a89520184
[book] a few autoclasses for renderers, misc tweaks
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
4465
diff
changeset
|
4 |
CubicWeb provides usual form/field/widget/renderer abstraction to |
|
5350
49c065ae225e
[doc] replace c-c with cubicweb-ctl
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
4743
diff
changeset
|
5 |
provide some generic building blocks which will greatly help you in |
|
4743
026a89520184
[book] a few autoclasses for renderers, misc tweaks
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
4465
diff
changeset
|
6 |
building forms properly integrated with CubicWeb (coherent display, |
|
026a89520184
[book] a few autoclasses for renderers, misc tweaks
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
4465
diff
changeset
|
7 |
error handling, etc...). |
|
1714
a721966779be
new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff
changeset
|
8 |
|
|
4743
026a89520184
[book] a few autoclasses for renderers, misc tweaks
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
4465
diff
changeset
|
9 |
A form basically only holds a set of fields, and has te be bound to a |
|
026a89520184
[book] a few autoclasses for renderers, misc tweaks
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
4465
diff
changeset
|
10 |
renderer which is responsible to layout them. Each field is bound to a |
|
026a89520184
[book] a few autoclasses for renderers, misc tweaks
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
4465
diff
changeset
|
11 |
widget that will be used to fill in value(s) for that field (at form |
|
026a89520184
[book] a few autoclasses for renderers, misc tweaks
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
4465
diff
changeset
|
12 |
generation time) and 'decode' (fetch and give a proper Python type to) |
|
026a89520184
[book] a few autoclasses for renderers, misc tweaks
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
4465
diff
changeset
|
13 |
values sent back by the browser. |
|
4443
83ff2bb898a5
start documenting forms
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2172
diff
changeset
|
14 |
|
|
83ff2bb898a5
start documenting forms
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2172
diff
changeset
|
15 |
The Field class and basic fields |
|
83ff2bb898a5
start documenting forms
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2172
diff
changeset
|
16 |
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
83ff2bb898a5
start documenting forms
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2172
diff
changeset
|
17 |
|
|
4465
18fb359f5c7a
fix wrong autoclass inclusion
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4443
diff
changeset
|
18 |
.. autoclass:: cubicweb.web.formfields.Field |
|
4443
83ff2bb898a5
start documenting forms
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2172
diff
changeset
|
19 |
|
|
83ff2bb898a5
start documenting forms
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2172
diff
changeset
|
20 |
Existing field types are: |
|
1714
a721966779be
new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff
changeset
|
21 |
|
|
4465
18fb359f5c7a
fix wrong autoclass inclusion
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4443
diff
changeset
|
22 |
.. autoclass:: cubicweb.web.formfields.StringField |
|
18fb359f5c7a
fix wrong autoclass inclusion
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4443
diff
changeset
|
23 |
.. autoclass:: cubicweb.web.formfields.PasswordField |
|
18fb359f5c7a
fix wrong autoclass inclusion
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4443
diff
changeset
|
24 |
.. autoclass:: cubicweb.web.formfields.RichTextField |
|
18fb359f5c7a
fix wrong autoclass inclusion
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4443
diff
changeset
|
25 |
.. autoclass:: cubicweb.web.formfields.FileField |
|
18fb359f5c7a
fix wrong autoclass inclusion
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4443
diff
changeset
|
26 |
.. autoclass:: cubicweb.web.formfields.EditableFileField |
|
18fb359f5c7a
fix wrong autoclass inclusion
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4443
diff
changeset
|
27 |
.. autoclass:: cubicweb.web.formfields.IntField |
|
18fb359f5c7a
fix wrong autoclass inclusion
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4443
diff
changeset
|
28 |
.. autoclass:: cubicweb.web.formfields.BooleanField |
|
18fb359f5c7a
fix wrong autoclass inclusion
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4443
diff
changeset
|
29 |
.. autoclass:: cubicweb.web.formfields.FloatField |
|
18fb359f5c7a
fix wrong autoclass inclusion
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4443
diff
changeset
|
30 |
.. autoclass:: cubicweb.web.formfields.DateField |
|
18fb359f5c7a
fix wrong autoclass inclusion
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4443
diff
changeset
|
31 |
.. autoclass:: cubicweb.web.formfields.DateTimeField |
|
18fb359f5c7a
fix wrong autoclass inclusion
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4443
diff
changeset
|
32 |
.. autoclass:: cubicweb.web.formfields.TimeField |
|
18fb359f5c7a
fix wrong autoclass inclusion
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4443
diff
changeset
|
33 |
.. autoclass:: cubicweb.web.formfields.RelationField |
|
18fb359f5c7a
fix wrong autoclass inclusion
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4443
diff
changeset
|
34 |
.. autoclass:: cubicweb.web.formfields.CompoundField |
|
1714
a721966779be
new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff
changeset
|
35 |
|
|
a721966779be
new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff
changeset
|
36 |
|
|
a721966779be
new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff
changeset
|
37 |
Widgets |
|
a721966779be
new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff
changeset
|
38 |
~~~~~~~ |
|
4443
83ff2bb898a5
start documenting forms
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2172
diff
changeset
|
39 |
Base class for widget is :class:cubicweb.web.formwidgets.FieldWidget class. |
|
83ff2bb898a5
start documenting forms
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2172
diff
changeset
|
40 |
|
|
83ff2bb898a5
start documenting forms
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2172
diff
changeset
|
41 |
Existing widget types are: |
|
4465
18fb359f5c7a
fix wrong autoclass inclusion
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4443
diff
changeset
|
42 |
|
|
18fb359f5c7a
fix wrong autoclass inclusion
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4443
diff
changeset
|
43 |
.. autoclass:: cubicweb.web.formwidgets.HiddenInput |
|
18fb359f5c7a
fix wrong autoclass inclusion
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4443
diff
changeset
|
44 |
.. autoclass:: cubicweb.web.formwidgets.TextInput |
|
18fb359f5c7a
fix wrong autoclass inclusion
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4443
diff
changeset
|
45 |
.. autoclass:: cubicweb.web.formwidgets.PasswordInput |
|
18fb359f5c7a
fix wrong autoclass inclusion
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4443
diff
changeset
|
46 |
.. autoclass:: cubicweb.web.formwidgets.PasswordSingleInput |
|
18fb359f5c7a
fix wrong autoclass inclusion
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4443
diff
changeset
|
47 |
.. autoclass:: cubicweb.web.formwidgets.FileInput |
|
18fb359f5c7a
fix wrong autoclass inclusion
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4443
diff
changeset
|
48 |
.. autoclass:: cubicweb.web.formwidgets.ButtonInput |
|
18fb359f5c7a
fix wrong autoclass inclusion
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4443
diff
changeset
|
49 |
.. autoclass:: cubicweb.web.formwidgets.TextArea |
|
18fb359f5c7a
fix wrong autoclass inclusion
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4443
diff
changeset
|
50 |
.. autoclass:: cubicweb.web.formwidgets.FCKEditor |
|
18fb359f5c7a
fix wrong autoclass inclusion
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4443
diff
changeset
|
51 |
.. autoclass:: cubicweb.web.formwidgets.Select |
|
18fb359f5c7a
fix wrong autoclass inclusion
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4443
diff
changeset
|
52 |
.. autoclass:: cubicweb.web.formwidgets.CheckBox |
|
18fb359f5c7a
fix wrong autoclass inclusion
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4443
diff
changeset
|
53 |
.. autoclass:: cubicweb.web.formwidgets.Radio |
|
18fb359f5c7a
fix wrong autoclass inclusion
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4443
diff
changeset
|
54 |
.. autoclass:: cubicweb.web.formwidgets.DateTimePicker |
|
18fb359f5c7a
fix wrong autoclass inclusion
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4443
diff
changeset
|
55 |
.. autoclass:: cubicweb.web.formwidgets.JQueryDateTimePicker |
|
18fb359f5c7a
fix wrong autoclass inclusion
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4443
diff
changeset
|
56 |
.. autoclass:: cubicweb.web.formwidgets.JQueryDatePicker |
|
18fb359f5c7a
fix wrong autoclass inclusion
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4443
diff
changeset
|
57 |
.. autoclass:: cubicweb.web.formwidgets.JQueryTimePicker |
|
18fb359f5c7a
fix wrong autoclass inclusion
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4443
diff
changeset
|
58 |
.. autoclass:: cubicweb.web.formwidgets.AjaxWidget |
|
18fb359f5c7a
fix wrong autoclass inclusion
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4443
diff
changeset
|
59 |
.. autoclass:: cubicweb.web.formwidgets.AutoCompletionWidget |
|
18fb359f5c7a
fix wrong autoclass inclusion
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4443
diff
changeset
|
60 |
.. autoclass:: cubicweb.web.formwidgets.EditableURLWidget |
|
4443
83ff2bb898a5
start documenting forms
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2172
diff
changeset
|
61 |
|
|
4743
026a89520184
[book] a few autoclasses for renderers, misc tweaks
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
4465
diff
changeset
|
62 |
Other classes in this module, which are not proper widget (they are not associated to |
|
4465
18fb359f5c7a
fix wrong autoclass inclusion
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4443
diff
changeset
|
63 |
field) but are used as form controls, may also be useful: Button, SubmitButton, |
|
18fb359f5c7a
fix wrong autoclass inclusion
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4443
diff
changeset
|
64 |
ResetButton, ImgButton, |
|
4443
83ff2bb898a5
start documenting forms
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2172
diff
changeset
|
65 |
|
|
83ff2bb898a5
start documenting forms
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2172
diff
changeset
|
66 |
|
|
83ff2bb898a5
start documenting forms
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2172
diff
changeset
|
67 |
Of course you can not use any widget with any field... |
|
1714
a721966779be
new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff
changeset
|
68 |
|
|
a721966779be
new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff
changeset
|
69 |
Renderers |
|
a721966779be
new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff
changeset
|
70 |
~~~~~~~~~ |
|
4743
026a89520184
[book] a few autoclasses for renderers, misc tweaks
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
4465
diff
changeset
|
71 |
|
|
026a89520184
[book] a few autoclasses for renderers, misc tweaks
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
4465
diff
changeset
|
72 |
.. autoclass:: cubicweb.web.views.formrenderers.BaseFormRenderer |
|
026a89520184
[book] a few autoclasses for renderers, misc tweaks
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
4465
diff
changeset
|
73 |
.. autoclass:: cubicweb.web.views.formrenderers.HTableFormRenderer |
|
026a89520184
[book] a few autoclasses for renderers, misc tweaks
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
4465
diff
changeset
|
74 |
.. autoclass:: cubicweb.web.views.formrenderers.EntityCompositeFormRenderer |
|
026a89520184
[book] a few autoclasses for renderers, misc tweaks
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
4465
diff
changeset
|
75 |
.. autoclass:: cubicweb.web.views.formrenderers.EntityFormRenderer |
|
026a89520184
[book] a few autoclasses for renderers, misc tweaks
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
4465
diff
changeset
|
76 |
.. autoclass:: cubicweb.web.views.formrenderers.EntityInlinedFormRenderer |
|
026a89520184
[book] a few autoclasses for renderers, misc tweaks
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
4465
diff
changeset
|
77 |