<!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_tree" />
<img src="../images/misc/logo.jpg" alt="" />
<h1>OpenLink Virtuoso Universal Server: Documentation - tree</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>tree</h2>
<div class="refpurpose">A container for displaying a tree of nested nodes.</div>
<div class="funcsynopsis">
<span class="funcdef">
<<a href="vc_tree.html">
<span class="function">tree</span>
</a>
name (required)
annotation (optional)
initial-enable (optional)
enabled (optional)
instantiate (optional)
control-udt (optional)
xsd-stub-xhtml (optional)
width (optional)
height (optional)
show-root (optional)
multi-branch (required)
orientation (required)
root (required)
child-function (required)
start-path (required)
open-at (optional)
debug-srcfile (optional)
debug-srcline (optional)
debug-log (optional)
/></span>
</div>
<div class="refsect1">
<div class="refsect1title">Description</div>
<p>
<p>This can be used for hierarchical tables of contents,
directory browsing, hierarchical menus and such.
The tree can have either one or more branches open at any time, up to
the leaves. The tree has a root, which may or may not be visible.
The contents of the tree can either be fixed, in which case these are an
XML tree, or dynamic, in which case these are generated level by level
by SQL functions attached to the tree. The tree can have various external appearences.</p>
<p>The tree is represented at run time by a vspx_tree instance.
Nodes of the tree are represented by vspx_tree_node objects,
which are childs of the vspx_tree. The nodes hold an identifier (vc_instance_name)
of the corresponding tree branch, which is used to retrieve children of the node.
These also hold a flag (tn_open member) indicating if the node is open or not.</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>show-root</strong>
<p>This attribute is obsolete and has no effect.</p>
</div>
<div class="formalpara">
<strong>multi-branch</strong>
<p>
This determines whether more than one branches can be open at one time.
The values are 0 and 1 (true and false). The default is 0 (false).
</p>
</div>
<div class="formalpara">
<strong>orientation</strong>
<p>
This can be 'horizontal' or 'vertical', the default is 'vertical'.
The tree can have different styles. The default is a vertical arrangement
with open levels indented, the children under the parent node.
Each node template is a single line. The horizontal style shows each level on a separate line.
In this case it is not allowed multiple open branches. The children of the root will be
shown on one line. When one is opened, its children will fill the next line.
</p>
</div>
<div class="formalpara">
<strong>root = <a href="vc_type_SqlName.html">SqlName</a>
</strong>
<p>
This is a SQL expression which produces the root object.
This can be of any data type, a file system path is an example.
</p>
<div>
<pre class="programlisting">
create procedure root_node (in path varchar)
{
declare i, l int;
declare ret, arr any;
arr :=
vector_concat (sys_dirlist (path, 0), sys_dirlist (path, 1));
return arr;
};
</pre>
</div>
</div>
<div class="formalpara">
<strong>child-function = <a href="vc_type_SqlName.html">SqlName</a>
</strong>
<p>Given the result of the root expression, this must generate an array
of similar elements corresponing to the children of the node in
question. This same function should be applicable to each element of
the array it returns. If the array is empty then the node in question
is a leaf.</p>
<div>
<pre class="programlisting">
-- Example of this function
create procedure child_node (in node_name varchar, in node varchar)
{
declare i, l int;
declare ret, arr any;
declare exit handler for sqlstate '*'
{
return vector ();
};
if (isstring (file_stat (node_name, 3)))
return vector ();
arr :=
vector_concat (sys_dirlist (node_name, 0), sys_dirlist (node_name, 1));
return arr;
}
;
</pre>
</div>
</div>
<div class="formalpara">
<strong>start-path = <a href="vc_type_CalculateableValue.html">CalculateableValue</a>
</strong>
<p>This is an expression which will be evaluated and passed to the 'root' function as argument.
</p>
</div>
<div class="formalpara">
<strong>open-at = <a href="vc_type_CalculateableValue.html">CalculateableValue</a>
</strong>
<p>This is an expression which will be used as XPath
expression to designate which branches of the tree are open
and which are not initially.
</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_tree</div>
<p>
</p>
<div>
<pre class="screen">
create type vspx_tree under vspx_control
as
(
vt_current_node int default -1,
vt_node any default null,
vt_open_at varchar default null,
vt_xpath_id varchar default null
)
temporary self as ref
overriding method vc_view_state (stream any, n int) returns any,
method vc_get_state () returns any,
method vc_open_at (path varchar) returns any,
constructor method vspx_tree (name varchar, parent vspx_control)
</pre>
</div>
</div>
<div class="refsect1">
<div class="refsect1title">Examples</div>
<a name="vc_ex_tree__0" />
<div class="example">
<div class="exampletitle">
</div>
<p>
<?xml version="1.0"?>
<!--
-
- $Id: tree__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
-
-
</p>
<div>
<pre class="screen">
<v:page name="demo_tree" xmlns:v="http://www.openlinksw.com/vspx/">
<html>
<body>
<v:form name="f1" method="POST" type="simple">
<div>
<v:tree name="tree1" multi-branch="1" orientation="vertical"
root="root_node" start-path="." child-function="child_node" >
<v:node-template name="node_tmpl">
<div STYLE="margin-left:1em;">
<v:button name="tree1_toggle" action="simple" style="image" value="--case (control.vc_parent as vspx_tree_node).tn_open when 0 then 'plus.gif' else 'minus.gif' end" />
<b><v:label name="label1" value="--(control.vc_parent as vspx_tree_node).tn_value" /></b>
<v:node />
</div>
</v:node-template>
<v:leaf-template name="leaf_tmpl">
<div STYLE="margin-left:1em;">
<v:label name="label2" value="--(control.vc_parent as vspx_tree_node).tn_value" />
</div>
</v:leaf-template>
</v:tree>
</div>
</v:form>
</body>
</html>
</v:page>
</pre>
</div>
</div>
</div>
<div class="tip">
<div class="tiptitle">See Also: Reference Material in the Tutorial:</div>
<p>
<a href="/tutorial/web/vx_s_4/tree.vspx">VX-S-4</a>
</p>
</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
>
960
