1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
|
<refentry id="vc_form">
<refmeta>
<refentrytitle>form</refentrytitle>
<refmiscinfo>vspx_control</refmiscinfo>
</refmeta>
<refnamediv>
<refname>form</refname>
<refpurpose>Generic scriptable container for elements that may accept user's input.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="vc_syn_form">
<funcprototype id="vc_proto_form">
<funcdef>
<<function>form</function> <attribute>
<parameter>name</parameter> (required) </attribute>
<attribute>
<parameter>annotation</parameter> (optional) </attribute>
<attribute>
<parameter>initial-enable</parameter> (optional) </attribute>
<attribute>
<parameter>enabled</parameter> (optional) </attribute>
<attribute>
<parameter>instantiate</parameter> (optional) </attribute>
<attribute>
<parameter>control-udt</parameter> (optional) </attribute>
<attribute>
<parameter>xsd-stub-xhtml</parameter> (optional) </attribute>
<attribute>
<parameter>width</parameter> (optional) </attribute>
<attribute>
<parameter>height</parameter> (optional) </attribute>
<attribute>
<parameter>type</parameter> (optional) </attribute>
<attribute>
<parameter>action</parameter> (optional) </attribute>
<attribute>
<parameter>method</parameter> (optional) </attribute>
<attribute>
<parameter>table</parameter> (optional) </attribute>
<attribute>
<parameter>if-not-exists</parameter> (optional) </attribute>
<attribute>
<parameter>concurrency</parameter> (optional) </attribute>
<attribute>
<parameter>triggers</parameter> (optional) </attribute>
<attribute>
<parameter>data-source</parameter> (optional) </attribute>
<attribute>
<parameter>debug-srcfile</parameter> (optional) </attribute>
<attribute>
<parameter>debug-srcline</parameter> (optional) </attribute>
<attribute>
<parameter>debug-log</parameter> (optional) </attribute>
/></funcdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="vc_desc_form">
<title>Description</title>
<para>
This is a grouping element for controls that handle post data and validation of user's input. In case of type 'update', this is a single row update control for a database table.
This retrieves the data from the row identified by the keys and shows the data in the column bound fields enclosed. If responding to a post for a submit inside this form, the form updates/inserts the data and shows the resulting state at the render pass.
</para>
</refsect1>
<refsect1 id="vc_attrs_form">
<title>Attributes</title>
<formalpara>
<title>name = <link linkend="vc_type_SqlName">SqlName</link>
</title>
<para>A page level unique name identifying a control.</para>
</formalpara>
<formalpara>
<title>annotation</title>
<para>A human readable comment.</para>
</formalpara>
<formalpara>
<title>initial-enable = <link linkend="vc_type_CalculateableValue">CalculateableValue</link>
</title>
<para>Determines whether a control is initially visible. True by default. Could be data-bound to an SQL expression.</para>
</formalpara>
<formalpara>
<title>enabled = <link linkend="vc_type_CalculateableValue">CalculateableValue</link>
</title>
<para>Determines whether a control is visible. True by default. Could be data-bound to an SQL expression.</para>
</formalpara>
<formalpara>
<title>instantiate = <link linkend="vc_type_CalculateableValue">CalculateableValue</link>
</title>
<para>Determines whether a control instantiate its children. It is true by default. It could be data-bound to an SQL expression. Unlike most of calcucateable attributes, the value of this attribute for a control is calcluated before calling 'on-init' event handler of the control; other values are calculated before calling 'before-data-bind' event handler.</para>
</formalpara>
<formalpara>
<title>control-udt = <link linkend="vc_type_SqlName">SqlName</link>
</title>
<para>At run time every control is represented as an instance of some user-defined type (UDT). VSPX compiles selects the UDT to use depending on name of the XML element that represents the control and maybe some of its attributes. In some specific cases the application developer may instruct VSPX compiler to use some other UDT, e.g. an application-specific UDT that is derived from the preset one. If specified, the value of 'control-udt' attribute should be equal to the name of the desired target UDT.</para>
</formalpara>
<formalpara>
<title>xsd-stub-xhtml</title>
<para>This attribute is for internal use only. It has no effect if added to the source VSPX file.</para>
</formalpara>
<formalpara>
<title>width</title>
<para>Visible width of the control when it is displayed in WYSIWYG tools when the source VSPX text is edited.
The value of this attribute will not be used when the resulting HTML is rendered.</para>
</formalpara>
<formalpara>
<title>height</title>
<para>Visible width of the control when it is displayed in WYSIWYG tools when the source VSPX text is edited.
The value of this attribute will not be used when the resulting HTML is rendered.</para>
</formalpara>
<formalpara>
<title>type</title>
<para>Type of form, can be 'simple' or 'update'. When this is 'simple' the vspx_form class will be instantiated, otherwise in case of 'update' vspx_update_form subclass will be used.</para>
<table>
<title>Allowed values of the 'type' attribute</title>
<tgroup cols="2">
<tbody>
<row>
<entry>simple</entry>
<entry>
<para>
Form with no special data binding.
</para>
</entry>
</row>
<row>
<entry>update</entry>
<entry>
<para>
Form that may be used in templates of type 'update' or 'add'.
</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</formalpara>
<formalpara>
<title>action</title>
<para>
A URL for processing. The data filled-in the form will be submitted to the 'action' page.
Therefore this is a page where the content of that form will be processed.
If it is empty, the target is a current page.
</para>
</formalpara>
<formalpara>
<title>method</title>
<para>A method of transferring the form data, can be POST or GET. The same as 'method' of HTML forms.</para>
<para>The use of 'GET' is not recommended because the length of the URI may easily exceed internal limits of the browser or an intermediate proxy server.</para>
</formalpara>
<formalpara>
<title>table</title>
<para>If the value of 'type' attribute is 'update', the form acts as a single row update control for a database table; and the value of 'table' attribute specifies the name of that table.
It retrieves the data from the row identified by the keys and shows the data in the column bound fields enclosed. If responding to a post for a submit inside this form, the form updates/inserts the data and shows the resulting state at the render pass.
This attribute is required if 'type' is 'update' and prohibited otherwise.</para>
</formalpara>
<formalpara>
<title>if-not-exists</title>
<para>If the keys do not select any row, and the value of this attribute is 'insert', the update form will be filled in with defaults filled in and will do an insert into the table when the form is submitted.
In this case of course the keys will have to be defaulted after the post or will have to be supplied in the post as fields.
Any defaulting should take place in the v:on-post handler which is before the insert or update in the event of the post.
</para>
</formalpara>
<formalpara>
<title>concurrency</title>
<para>If true and a previous value was shown in the form before the post being processed, this causes the system to check whether any of the data has been updated between getting it and the post at hand.
This is a sort of optimistic concurrency control at the row level. If an update is detected, the updated_meanwhile message is set as the error message of the form and no update is made. The render pass may choose to process this message as it will, the default is to show it as any other error message for form level validation failure.
</para>
</formalpara>
<formalpara>
<title>triggers</title>
<para>This is applicable for update form only, when this is OFF no PL triggers
will be fired when inserting or updating.</para>
</formalpara>
<formalpara>
<title>data-source = <link linkend="vc_type_SqlName">SqlName</link>
</title>
<para>This is applicable to the update form and is
An alternative of 'table'. When is specified the value is suppsed to be
valid reference to existing data-source control. Further the given data-source
will be used to bind/update the data.
</para>
</formalpara>
<formalpara>
<title>debug-srcfile</title>
<para>URI of the source document where the tag comes from.</para>
</formalpara>
<formalpara>
<title>debug-srcline</title>
<para>Line number in the source document where the tag comes from.</para>
</formalpara>
<formalpara>
<title>debug-log</title>
<para>This defines what sort of data are saved to the debugging log.
</para>
</formalpara>
</refsect1>
<refsect1 id="vc_udt_form">
<title>Declaration of type vspx_form</title>
<para>
</para>
<screen>
create type vspx_form under vspx_control
as
(
uf_action varchar default '',
uf_method varchar default 'post',
--uf_inside_form int default 0,
uf_validators any,
uf_xmodel any default null,
uf_xsubmit any default null,
uf_xschema any default null
) temporary self as ref
constructor method vspx_form (name varchar, parent vspx_control),
method prologue_render (sid varchar, realm varchar, nonce varchar) returns any,
method epilogue_render () returns any,
overriding method vc_set_model () returns any
</screen>
</refsect1>
<refsect1 id="vc_ex_form">
<title>Examples</title>
<example id="vc_ex_form__0">
<title>
Simple entry form
</title>
<para>
<?xml version="1.0"?>
<!--
-
- $Id: form__0.vspx,v 1.2 2006/08/16 00:04:15 source Exp $
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2006 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
The OK button of the form submits data from the form back to the same page.
</para>
<screen>
<v:page name="form__0" xmlns:v="http://www.openlinksw.com/vspx/">
<html>
<head>
<title>VSPX samples | v:form</title>
</head>
<body>
<v:form name="form1" type="simple" action="" method="POST">
<v:label name="label1" value="--'Simple form'"/>
<v:text name="txt1" default=""/>
<v:text name="txt2" default=""/>
<v:button name="submit1" action="simple" value="OK"/>
</v:form>
</body>
</html>
</v:page>
</screen>
</example>
<example id="vc_ex_form__1">
<title>
Simple entry form containing various controls
</title>
<para>
<?xml version="1.0"?>
<!--
-
- $Id: form__1.vspx,v 1.2 2006/08/16 00:04:15 source Exp $
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2006 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
The OK button of the form submits data from the form back to the same page.
the check-box is validated against ragio group
</para>
<screen>
<v:page name="form__1" xmlns:v="http://www.openlinksw.com/vspx/">
<html>
<head>
<title>VSPX samples | v:form | v:validator</title>
</head>
<body>
<v:form name="f1" type="simple" method="POST">
<v:error-summary/><br/>
<v:label name="l1" value="--'Simple form'"/><br/>
<v:url name="u1" value="--'This page'" url="--self.f1.uf_action" /><br/>
<v:text name="t1" value="--self.rb1.ufl_value"/><br/>
<v:text name="t2" value="--'my'||'password'" type="password"/><br/>
<v:text name="t3" value="--'something'||'hidden'" type="hidden"/>
<v:textarea name="ta1" value="--'some text'" /><br/>
<v:check-box name="cb1" value="check-box" /><br/>
<v:radio-group name="rg1">
<v:radio-button name="rb1" value="one" />
<v:radio-button name="rb2" value="two" />
</v:radio-group><br/>
<v:button name="b1" action="simple" value="--'OK'"/><br/>
<v:validator test="sql" message="only when radio is on position one check-box could be checked">
if (self.rb2.ufl_selected and self.cb1.ufl_selected)
{
return 1;
}
</v:validator>
</v:form>
</body>
</html>
</v:page>
</screen>
</example>
</refsect1>
<tip>
<title>See Also: Reference Material in the Tutorial:</title>
<para>
<ulink url="/tutorial/web/vx_s_2/form.vspx">VX-S-2</ulink>
</para>
<para>
<ulink url="/tutorial/web/vx_s_3/update_form.vspx">VX-S-3</ulink>
</para>
</tip>
</refentry>
|
