<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head profile="http://internetalchemy.org/2003/02/profile">
<link rel="foaf" type="application/rdf+xml" title="FOAF" href="http://www.openlinksw.com/dataspace/uda/about.rdf" />
<link rel="schema.dc" href="http://purl.org/dc/elements/1.1/" />
<meta name="dc.title" content="OpenLink Virtuoso Universal Server: Documentation" />
<meta name="dc.subject" content="OpenLink Virtuoso Universal Server: Documentation" />
<meta name="dc.creator" content="OpenLink Software Documentation Team ; " />
<meta name="dc.copyright" content="OpenLink Software, 1999 - 2009" />
<link rel="top" href="index.html" title="OpenLink Virtuoso Universal Server: Documentation" />
<link rel="search" href="/doc/adv_search.vspx" title="Search OpenLink Virtuoso Universal Server: Documentation" />
<link rel="parent" href=".html" title="Chapter Contents" />
<link rel="prev" href="index.html" title="Home" />
<link rel="next" href="contents.html" title="Contents" />
<link rel="shortcut icon" href="../images/misc/favicon.ico" type="image/x-icon" />
<link rel="stylesheet" type="text/css" href="doc.css" />
<link rel="stylesheet" type="text/css" href="/doc/translation.css" />
<title>OpenLink Virtuoso Universal Server: Documentation</title>
<meta http-equiv="Content-Type" content="text/xhtml; charset=UTF-8" />
<meta name="author" content="OpenLink Software Documentation Team ; " />
<meta name="copyright" content="OpenLink Software, 1999 - 2009" />
<meta name="keywords" content="" />
<meta name="GENERATOR" content="OpenLink XSLT Team" />
</head>
<body>
<div id="header">
<a name="vc_data_grid" />
<img src="../images/misc/logo.jpg" alt="" />
<h1>OpenLink Virtuoso Universal Server: Documentation - data-grid</h1>
</div>
<div id="navbartop">
<div>
<a class="link" href="functions.html">Chapter Contents</a> | <a class="link" href="index.html" title="Home">Prev</a> | <a class="link" href="contents.html" title="Contents">Next</a>
</div>
</div>
<div id="currenttoc">
<form method="post" action="/doc/adv_search.vspx">
<div class="search">Keyword Search: <br />
<input type="text" name="q" /> <input type="submit" name="go" value="Go" />
</div>
</form>
<div>
<a href="http://www.openlinksw.com/">www.openlinksw.com</a>
</div>
<div>
<a href="http://docs.openlinksw.com/">docs.openlinksw.com</a>
</div>
<br />
<div>
<a href="index.html">Book Home</a>
</div>
<br />
<div>
<a href="contents.html">Contents</a>
</div>
<div>
<a href="preface.html">Preface</a>
</div>
<br />
<div>
<a href="overview.html">Overview</a>
</div>
<div>
<a href="installation.html">Installation Guide</a>
</div>
<div>
<a href="quicktours.html">Quick Start & Tours</a>
</div>
<div>
<a href="sampleapps.html">Sample ODBC & JDBC Applications</a>
</div>
<div>
<a href="concepts.html">Conceptual Overview</a>
</div>
<div>
<a href="server.html">Administration</a>
</div>
<div>
<a href="accessinterfaces.html">Data Access Interfaces</a>
</div>
<div>
<a href="sqlreference.html">SQL Reference</a>
</div>
<div>
<a href="sqlprocedures.html">SQL Procedure Language Guide</a>
</div>
<div>
<a href="hooks.html">Database Event Hooks</a>
</div>
<div>
<a href="repl.html">Data Replication, Synchronization and Transformation Services</a>
</div>
<div>
<a href="webappdevelopment.html">Web Application Development</a>
</div>
<div>
<a href="webandxml.html">XML Support</a>
</div>
<div>
<a href="rdfandsparql.html">RDF Data Access and Data Management</a>
</div>
<div>
<a href="webservices.html">Web Services</a>
</div>
<div>
<a href="runtimehosting.html">Runtime Hosting</a>
</div>
<div>
<a href="internetservices.html">Internet Services</a>
</div>
<div>
<a href="freetext.html">Free Text Search</a>
</div>
<div>
<a href="tpcc.html">TPC C Benchmark Kit</a>
</div>
<div>
<a href="xa.html">Using Virtuoso with Tuxedo</a>
</div>
<div>
<a href="appendixa.html">Appendix</a>
</div>
<div>
<a href="functions.html">Virtuoso Functions Guide</a>
</div>
<br />
</div>
<div id="text">
<h2>data-grid</h2>
<div class="refpurpose">Scrollable databound multi-row control.</div>
<div class="funcsynopsis">
<span class="funcdef">
<<a href="vc_data_grid.html">
<span class="function">data-grid</span>
</a>
name (required)
annotation (optional)
initial-enable (optional)
enabled (optional)
instantiate (optional)
control-udt (optional)
xsd-stub-xhtml (optional)
width (optional)
height (optional)
data (optional)
meta (optional)
nrows (optional)
sql (required)
scrollable (optional)
cursor-type (optional)
edit (optional)
debug-srcfile (optional)
debug-srcline (optional)
debug-log (optional)
/></span>
</div>
<div class="refsect1">
<div class="refsect1title">Description</div>
<p>
<p>This is the generic multi-row database view control. It is used to show repeating data, as from tables
or procedure views. Allows scrolling (paging) editing the data; adding a row or removal of existing rows.
Usually this control generates a PL scrollable cursor of type as specified. The number of rows shown are
configurable via nrows attribute. Note also that column children elements are optional; they can be omitted
so then VSPX engine will compute them from specified SQL statement in 'sql' attribute.</p>
<p>Specific to this control is to have row-template and frame-template, these are to present repeating and non-repeating groups of children elements. The frame-template will usually
have a 'rowset' placeholder to designate the place where repeating group (row-template) will be instantiated. The control expects to find child controls with specific names. for scrolling buttons - [data-grid name]'_prev' and [data-grid name]'_next'; for editing buttons - [data-grid name]'_edit' and [data-grid name]'_delete'.</p>
</p>
</div>
<div class="refsect1">
<div class="refsect1title">Attributes</div>
<div class="formalpara">
<strong>name = <a href="vc_type_SqlName.html">SqlName</a>
</strong>
<p>A page level unique name identifying a control.</p>
</div>
<div class="formalpara">
<strong>annotation</strong>
<p>A human readable comment.</p>
</div>
<div class="formalpara">
<strong>initial-enable = <a href="vc_type_CalculateableValue.html">CalculateableValue</a>
</strong>
<p>Determines whether a control is initially visible. True by default. Could be data-bound to an SQL expression.</p>
</div>
<div class="formalpara">
<strong>enabled = <a href="vc_type_CalculateableValue.html">CalculateableValue</a>
</strong>
<p>Determines whether a control is visible. True by default. Could be data-bound to an SQL expression.</p>
</div>
<div class="formalpara">
<strong>instantiate = <a href="vc_type_CalculateableValue.html">CalculateableValue</a>
</strong>
<p>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.</p>
</div>
<div class="formalpara">
<strong>control-udt = <a href="vc_type_SqlName.html">SqlName</a>
</strong>
<p>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.</p>
</div>
<div class="formalpara">
<strong>xsd-stub-xhtml</strong>
<p>This attribute is for internal use only. It has no effect if added to the source VSPX file.</p>
</div>
<div class="formalpara">
<strong>width</strong>
<p>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.</p>
</div>
<div class="formalpara">
<strong>height</strong>
<p>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.</p>
</div>
<div class="formalpara">
<strong>data = <a href="vc_type_CalculateableValue.html">CalculateableValue</a>
</strong>
<p>Expression which returns an array of rowset data, this is an alternative to specifying an SQL expression. The result then will be used to instantiate
the repeating group. An example of such data is the result returned by 'exec' function:</p>
<div>
<pre class="programlisting">
(
("ALFKI" "Alfreds Futterkiste" "030-0074321" )
("ANATR" "Ana Trujillo Emparedados y helados" "(5) 555-4729" )
)
</pre>
</div>
</div>
<div class="formalpara">
<strong>meta = <a href="vc_type_CalculateableValue.html">CalculateableValue</a>
</strong>
<p>This works with combination of data attribute, this expression must return an array of ro metadata. So when this is specified it needs to be an expression returning meta-data for columns. In practice this is the same as 1st element of metadata returned by 'exec()' :</p>
<div>
<pre class="programlisting">
(
("CustomerID" 182 0 5 0 1 1 "Demo" "CustomerID" "demo" "Customers" 0 )
("CompanyName" 182 0 40 1 1 1 "Demo" "CompanyName" "demo" "Customers" 0 )
("Phone" 182 0 24 1 1 1 "Demo" "Phone" "demo" "Customers" 0 )
)
</pre>
</div>
<p>
for details of metadata see 'exec()' function description.</p>
</div>
<div class="formalpara">
<strong>nrows = <a href="vc_type_CalculateableValue.html">CalculateableValue</a>
</strong>
<p>The maximum number of replicas of the row template to be made for rows selected.
This is like the rowset size for a scrollable cursor.</p>
</div>
<div class="formalpara">
<strong>sql = <a href="vc_type_SqlCode.html">SqlCode</a>
</strong>
<p>The select statement that gets the data.
Parameters to the statement MUST be specified as SQL identifiers prefixed with a colon (named parameter).
The values are given in the control's vspx:param children. These specify the parameter name and a data bound expression for the value.
</p>
</div>
<div class="formalpara">
<strong>scrollable</strong>
<p>The setting controls whether next and previous page buttons are presented. This can be on even if the cursor is not scrollable as such.</p>
</div>
<div class="formalpara">
<strong>cursor-type</strong>
<table class="data">
<caption>Table: 12.4.9.1. Allowed values of the 'cursor-type' attribute</caption>
<tr>
<td class="data">static</td>
<td class="data">
<p>A static cursor is used.</p>
</td>
</tr>
<tr>
<td class="data">dynamic</td>
<td class="data">
<p>A dynamic cursor is used.</p>
</td>
</tr>
<tr>
<td class="data">keyset</td>
<td class="data">
<p>A keyset cursor is used.</p>
</td>
</tr>
</table>
<br />
</div>
<div class="formalpara">
<strong>edit = <a href="vc_type_CalculateableValue.html">CalculateableValue</a>
</strong>
<p>Flags whether editing features are enabled on data grid control</p>
</div>
<div class="formalpara">
<strong>debug-srcfile</strong>
<p>URI of the source document where the tag comes from.</p>
</div>
<div class="formalpara">
<strong>debug-srcline</strong>
<p>Line number in the source document where the tag comes from.</p>
</div>
<div class="formalpara">
<strong>debug-log</strong>
<p>This defines what sort of data are saved to the debugging log.
</p>
</div>
</div>
<div class="refsect1">
<div class="refsect1title">Declaration of type vspx_data_grid</div>
<p>
Scrollable, Multi-Row data grid Class
</p>
<div>
<pre class="screen">
create type vspx_data_grid under vspx_form
as (
dg_nrows int default -1, -- how many rows to show on single page
dg_scrollable int default 0, -- scroll on form is enabled
dg_editable int default 1, -- disable edit/add on whole grid
dg_row_meta any, -- metadata
dg_row_data any, -- the data for procedure binding
dg_current_row vspx_row_template, -- current row template
dg_rowno_edit int default null, -- last edited row in result set, to re-display the edit box on error
dg_rows_fetched int default 0, -- these are to keep state for scrolling
dg_prev_bookmark any default null,
dg_last_bookmark any default null
) temporary self as ref
method vc_templates_clean () returns any,
constructor method vspx_data_grid (name varchar, parent vspx_control),
overriding method vc_set_view_state (e vspx_event) returns any,
overriding method vc_view_state (stream any, n int) returns any
</pre>
</div>
</div>
<div class="refsect1">
<div class="refsect1title">Examples</div>
<a name="vc_ex_data_grid__0" />
<div class="example">
<div class="exampletitle">
Editable multi-row data grid based on data-grid control
</div>
<p>
<?xml version="1.0"?>
<!--
-
- $Id: data_grid__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
-
-
This example will show a list of customers from the Northwind demo database.
Allows editing, addtion and removal of existing records.
</p>
<div>
<pre class="screen">
<v:page name="data_grid__0" xmlns:v="http://www.openlinksw.com/vspx/">
<html>
<body>
<v:data-grid name="dg" nrows="5" sql="select CustomerID, CompanyName, Phone from Demo.demo.Customers where CustomerId like :mask" cursor-type="keyset" edit="1">
<v:param name="mask" value="'%'"/>
<v:template name="t1" type="frame">
<div>
<div>
Action
<v:label name="l1" value="--(control.vc_parent as vspx_data_grid).dg_row_meta[0]"/>
<v:label name="l2" value="--(control.vc_parent as vspx_data_grid).dg_row_meta[1]"/>
<v:label name="l3" value="--(control.vc_parent as vspx_data_grid).dg_row_meta[2]"/>
</div>
<v:rowset/>
<v:form type="add"/>
<div>
<v:button name="dg_prev" action="simple" value="&lt;&lt;"/>
<v:button name="dg_next" action="simple" value="&gt;&gt;"/>
</div>
</div>
</v:template>
<v:template name="t2" type="row">
<div>
<v:button name="dg_edit" action="simple" value="Edit"/>
<v:button name="dg_delete" action="simple" value="Delete">
<v:on-post>
delete from Demo.demo.Customers where CustomerID = self.dg.dg_current_row.te_rowset[0];
self.dg.vc_data_bind (e);
</v:on-post>
</v:button>
<v:label name="label1" value="--(control.vc_parent as vspx_row_template).te_rowset[0]"/>
<v:label name="label2" value="--(control.vc_parent as vspx_row_template).te_rowset[1]"/>
<v:label name="label3" value="--(control.vc_parent as vspx_row_template).te_rowset[2]"/>
</div>
</v:template>
<v:template name="t3" type="if-not-exists">
<div>No rows selected</div>
</v:template>
<v:template name="t4" type="edit">
<v:form name="u1" type="update" table="Demo.demo.Customers" if-not-exists="insert">
<v:key column="CustomerID" value="--self.dg.dg_current_row.te_rowset[0]" default="null"/>
<v:template type="if-exists" name="t5">
<div>
<v:button name="b1" action="submit" value="Update"/>
<input type="submit" name="b2" value="Cancel"/>
<v:text name="c_id1" column="CustomerID"/>
<v:text name="c_name1" column="CompanyName"/>
<v:text name="c_phone1" column="Phone"/>
</div>
</v:template>
</v:form>
</v:template>
<v:template name="t6" type="add">
<v:form type="update" name="a1" table="Demo.demo.Customers" if-not-exists="insert">
<v:key column="CustomerID" value="--''" default="null"/>
<v:template name="t7" type="if-exists">
<v:button name="b3" action="submit" value="Add"/>
<v:text name="c_id2" column="CustomerID"/>
<v:text name="c_name2" column="CompanyName"/>
<v:text name="c_phone2" column="Phone"/>
</v:template>
</v:form>
</v:template>
</v:data-grid>
</body>
</html>
</v:page>
</pre>
</div>
</div>
</div>
</div>
<div id="footer">
<div>Copyright© 1999 - 2009 OpenLink Software All rights reserved.</div>
<div id="validation">
<a href="http://validator.w3.org/check/referer">
<img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" />
</a>
<a href="http://jigsaw.w3.org/css-validator/">
<img src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!" height="31" width="88" />
</a>
</div>
</div>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
71d40963b505df4524269198e237b3e3
>
files
>
922
