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
|
<!--
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2018 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
-
-
-->
<refentry id="vspx_button">
<refmeta>
<refentrytitle>vspx_button</refentrytitle>
<refmiscinfo>vspx_control</refmiscinfo>
</refmeta>
<refnamediv>
<refname>vspx_button</refname>
<refpurpose>scriptable buttons</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="syn_vspx_button">
<funcprototype id="proto_vspx_button">
<funcdef>
<function>button</function>
</funcdef>
<attributes>
<attribute>name (required) </attribute>
<attribute>annotation (optional) </attribute>
<attribute>initial-enable (optional) </attribute>
<attribute>action (required) </attribute>
<attribute>value (required) </attribute>
<attribute>child-window-options (optional) </attribute>
<attribute>browser-current (optional) </attribute>
<attribute>browser-filter (optional) </attribute>
<attribute>browser-list (optional) </attribute>
<attribute>browser-mode (optional) </attribute>
<attribute>browser-type (optional) </attribute>
<attribute>browser-xfer (optional) </attribute>
<attribute>style (optional) </attribute>
<attribute>selected-image (optional) </attribute>
<attribute>not-selected-image (optional) </attribute>
<attribute>selector (optional) </attribute>
</attributes>
<childs>
<child>after-data-bind</child>
<child>after-data-bind-container</child>
<child>before-data-bind</child>
<child>before-data-bind-container</child>
<child>on-post</child>
<child>on-post-container</child>
<child>before-render</child>
<child>before-render-container</child>
<child>field</child>
</childs>
<class>
<screen><![CDATA[
-- Button class, encapsulate all controls originating a event
create type vspx_button under vspx_field as
(
bt_pressed int default 0, -- internal use only
bt_style varchar default 'submit', -- button style
bt_close_img varchar, -- this and below are alternate image links
bt_open_img varchar, -- for making a two-state image buttons
bt_url varchar -- if a url specified to button, this alter
) temporary self as ref -- it to a image link
overriding method vc_render () returns any,
constructor method vspx_button (name varchar, parent vspx_control),
constructor method vspx_button (name varchar, label varchar, parent vspx_control)
;
-- this represents a browse button
create type vspx_browse_button under vspx_button
as
(
vcb_selector varchar, -- url to be open in pop-up
vcb_chil_options varchar default '', -- child window options
vcb_fields any, -- fileds to be send as parameters
vcb_browser_mode varchar default 'RES', -- COL, RES, STANDALONE
vcb_list_mode integer default '1', -- 1 full list, 0 short list
vcb_system varchar default '', -- 'dav', 'file', '' (none)
vcb_xfer varchar default 'DOM', -- for now only this option is used
vcb_current integer default 0, -- current dav collection id
vcb_filter varchar default '*' -- filter for file list
)
self as ref temporary
constructor method vspx_browse_button (name varchar, parent vspx_control),
overriding method vc_render () returns any
;
-- this represents a delete button
create type vspx_delete_button under vspx_button as
(
btd_table varchar, -- table for delete
btd_key varchar -- key column for delete
) self as ref temporary
constructor method vspx_delete_button (name varchar, parent vspx_control),
constructor method vspx_delete_button (name varchar, label varchar, parent vspx_control)
;
-- these are representation of various button types
create type vspx_radio_button under vspx_button
self as ref temporary
constructor method vspx_radio_button (name varchar, parent vspx_control),
overriding method vc_render () returns any
;
create type vspx_submit under vspx_button
temporary self as ref
constructor method vspx_submit (name varchar, parent vspx_control)
;
create type vspx_logout_button under vspx_button
self as ref temporary
constructor method vspx_logout_button (name varchar, parent vspx_control),
constructor method vspx_logout_button (name varchar, label varchar, parent vspx_control, page vspx_page)
;
create type vspx_return_button under vspx_button
self as ref temporary
overriding method vc_render () returns any,
constructor method vspx_return_button (name varchar, parent vspx_control),
constructor method vspx_return_button (name varchar, label varchar, int_name varchar, parent vspx_control)
;
]]>
</screen>
</class>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_vspx_button">
<title>Description</title>
<para>
<function>vspx_button</function>Scriptable version of Submit Button of the HTML form. Depending of
'action' attribute it may have variants. In some of these variants button will not have submit function (as select and browse button), so in that case they will perform special function for selecting or pop up of new window.
</para>
</refsect1>
<refsect1 id="attrs_vspx_button">
<title>Attributes</title>
<refsect2>
<title>name</title>
<para>A unique name identifying the control.</para>
</refsect2>
<refsect2>
<title>annotation</title>
<para>A human readable comment.</para>
</refsect2>
<refsect2>
<title>initial-enable</title>
<para>Designates is control visible or not initially. Could be data-bound to an SQL expression.</para>
</refsect2>
<refsect2>
<title>action</title>
<para>This designate subclassing of the button.</para>
<para>
'simple' : is a simple submit button, no special functions
</para>
<para>
'submit' : an alias of 'simple' button, obsolete
</para>
<para>
'delete' : a button for deleting a row in a data-set or data-grid controls, it is represented as a submit button with special on-post script. The delete function is performed based on table, key attributes. (check implementation!!)
</para>
<para>
'browse' : a button for browsing will be originated, the function of it is to pop-up a window as specified in selector attribute. Designate client-side JavaScript generation.
</para>
<para>
'return' : this button type will return a value of fileds named as specified in it's children 'filed' elements to the parent window. The page rendering class will make client-side JavaScript code for serving it's function.
</para>
<para>
'logout' : can appear only in login control, this is to perform logout function of it.
</para>
</refsect2>
<refsect2>
<title>value</title>
<para>Text of the label of the button.</para>
</refsect2>
<refsect2>
<title>child-window-options</title>
<para>Options for opening a child pop-up window.This can be used only with conjuction of action browse.</para>
</refsect2>
<refsect2>
<title>browser-current</title>
<para>Current directory of browsing. Can be used only with browse button for WebDAV or Filesystem resources.</para>
</refsect2>
<refsect2>
<title>browser-filter</title>
<para>Filter expression(s) for browsing. (see above)</para>
</refsect2>
<refsect2>
<title>browser-list</title>
<para>Type of browser list, 0 - short, 1 - long</para>
</refsect2>
<refsect2>
<title>browser-mode</title>
<para>COL, RES or STANDALONE , this is to specify what to be selected. In other words this affects behaviour of the pop-up window.</para>
</refsect2>
<refsect2>
<title>browser-type</title>
<para>This designate type of browser: dav or os (filesystem).</para>
</refsect2>
<refsect2>
<title>browser-xfer</title>
<para>A way of transferring the data between windows, DOM is default. No other options in current implementation.</para>
</refsect2>
<refsect2>
<title>style</title>
<para>A style of button, affects appearance.</para>
<para>
'submit' : This is a default style used, no special handling.
The button will be rendered as usual submit button.
</para>
<para>
'uri' : The button will be rendered as link, furthermore client side JavaScript code will be produced to act as like submit button.
</para>
<para>
'image' : The button will be rendered as image on browser under link button. In that case value of button control must be link to the image file.
</para>
</refsect2>
<refsect2>
<title>selected-image</title>
<para>An alternate image</para>
</refsect2>
<refsect2>
<title>not-selected-image</title>
<para>A second alternate image. This and above can will be only initialized. One can use them to change simultaneously the value of button (i.e. ufl_value and hance rendering).</para>
</refsect2>
<refsect2>
<title>selector</title>
<para>This is a URL to pop-up windows. Note that it can be used only with browse button.</para>
</refsect2>
</refsect1>
<refsect1 id="childs_vspx_button">
<title>Children</title>
<refsect2>
<title>field</title>
<para>This element may occur under browse button or select button,
it enumerates the names of inputs to be sent to/back between pop-up and parent window.</para>
</refsect2>
</refsect1>
<refsect1 id="examples_vspx_button">
<title>Examples</title>
<example id="ex_vspx_button">
<title>Simple example</title>
<para>A simple image submit button
</para>
<screen><![CDATA[
<v:button name="submit1" action="simple" style="image" xhtml:alt="A test button" value="--'plus.gif'" />
]]>
</screen>
</example>
</refsect1>
</refentry>
|
