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
|
<refentry id="vc_code_file">
<refmeta>
<refentrytitle>code-file</refentrytitle>
<refmiscinfo>vspx_control</refmiscinfo>
</refmeta>
<refnamediv>
<refname>code-file</refname>
<refpurpose>Code-behind file containing SQL script.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="vc_syn_code_file">
<funcprototype id="vc_proto_code_file">
<funcdef>
<<function>code-file</function> <attribute>
<parameter>url</parameter> (required) </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_code_file">
<title>Description</title>
<para>This element is used to load an external SQL
script after page class compilation and before page execution.
This script may contain page subclass or custom control definitions.
In this way SQL code can be separated from VSPX markup, or in other words
to separate page design from application logic.
</para>
</refsect1>
<refsect1 id="vc_attrs_code_file">
<title>Attributes</title>
<formalpara>
<title>url</title>
<para>URL of file to be loaded after VSPX page compilation.
If relative then the base is the page where the control resides
(i.e. same URL resolution rules applied as for includes).
</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_ex_code_file">
<title>Examples</title>
<example id="vc_ex_code_file__0">
<title>
Code-behind SQL script
</title>
<para>
<?xml version="1.0"?>
<!--
-
- $Id: code_file__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 script of a button's post event is in separate SQL file.
The code_file__0.sql contents:
drop type my_page_subclass
;
create type my_page_subclass under DB.dba.page__vspx_code__file____0_vspx
temporary self as ref
overriding method vc_post_b1 (control vspx_button, e vspx_event) returns any,
method button_change (control vspx_button) returns any
;
create method vc_post_b1 (inout control vspx_button, inout e vspx_event) for my_page_subclass
{
if (not control.vc_focus) return;
self.button_change (control);
return;
}
;
create method button_change (inout control vspx_button) for my_page_subclass
{
self.var1 := self.var1 + 1;
control.ufl_value := 'Activated';
}
;
</para>
<screen>
<v:page name="page1" xmlns:v="http://www.openlinksw.com/vspx/" page-subclass="my_page_subclass">
<html>
<body>
<v:code-file url="code_file__0.sql"/>
<v:variable name="var1" type="int" default="0" param-name="id" persist="pagestate" />
<v:form type="simple" name="f1">
<v:label name="l1" value="--self.var1" format="%d" />
<v:button action="simple" name="b1" value="Submit" />
</v:form>
</body>
</html>
</v:page>
</screen>
</example>
</refsect1>
</refentry>
|