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
|
<refentry id="vc_calendar">
<refmeta>
<refentrytitle>calendar</refentrytitle>
<refmiscinfo>vspx_control</refmiscinfo>
</refmeta>
<refnamediv>
<refname>calendar</refname>
<refpurpose>Databound calendar control.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="vc_syn_calendar">
<funcprototype id="vc_proto_calendar">
<funcdef>
<<function>calendar</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>initial-date</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_calendar">
<title>Description</title>
<para>This is the generic calendar control.</para>
</refsect1>
<refsect1 id="vc_attrs_calendar">
<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>initial-date = <link linkend="vc_type_CalculateableValue">CalculateableValue</link>
</title>
<para>Expression which returns a date for setting initially the current date of the calendar.</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_calendar">
<title>Declaration of type vspx_calendar</title>
<para>
</para>
<screen>
create type vspx_calendar under vspx_control as
(
cal_date date,
cal_meta any,
cal_selected datetime,
cal_current_row vspx_row_template
) temporary self as ref
method vc_get_date_array () returns any,
overriding method vc_view_state (stream any, n int) returns any,
overriding method vc_set_view_state (e vspx_event) returns any,
constructor method vspx_calendar (name varchar, parent vspx_control)
</screen>
</refsect1>
<refsect1 id="vc_ex_calendar">
<title>Examples</title>
<example id="vc_ex_calendar__0">
<title>
A calendar
</title>
<para>
<?xml version="1.0"?>
<!--
-
- $Id: calendar__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 demo will show a calendar allowing to list dates by months
</para>
<screen>
<v:page name="pagecal1" xmlns:v="http://www.openlinksw.com/vspx/">
<html>
<body>
<v:form name="form1" type="simple" method="POST" >
<v:calendar name="cal1" initial-date="--now()">
<v:template type="simple" name="chead1" name-to-remove="table" set-to-remove="bottom">
<table border="0" cellpadding="0" cellspacing="0">
<tr>
<td align="center">
<v:button name="pmon" value="<" action="simple" style="url">
<v:on-post>
self.cal1.cal_date := dateadd ('month', -1, self.cal1.cal_date);
self.cal1.vc_data_bind (e);
</v:on-post>
</v:button>
</td>
<td colspan="5" align="center">
<?V monthname((control.vc_parent as vspx_calendar).cal_date) ?>
<?V year((control.vc_parent as vspx_calendar).cal_date) ?>
</td>
<td align="center">
<v:button name="nmon" value=">" action="simple" style="url">
<v:on-post>
self.cal1.cal_date := dateadd ('month', 1, self.cal1.cal_date);
self.cal1.vc_data_bind (e);
</v:on-post>
</v:button>
</td>
</tr>
<tr><td>Sun</td><td>|Mon</td><td>|Tue</td><td>|Wed</td><td>|Thu</td><td>|Fri</td><td>|Sat</td></tr>
</table>
</v:template>
<v:template type="repeat" name="cbody1" name-to-remove="" set-to-remove="">
<v:template type="browse" name="crow1" name-to-remove="table" set-to-remove="both">
<table>
<tr>
<td align="center"><v:button style="url" action="simple" name="b1" value="--cal_icell(control, 0)" /></td>
<td align="center"><v:button style="url" action="simple" name="b2" value="--cal_icell(control, 1)" /></td>
<td align="center"><v:button style="url" action="simple" name="b3" value="--cal_icell(control, 2)" /></td>
<td align="center"><v:button style="url" action="simple" name="b4" value="--cal_icell(control, 3)" /></td>
<td align="center"><v:button style="url" action="simple" name="b5" value="--cal_icell(control, 4)" /></td>
<td align="center"><v:button style="url" action="simple" name="b6" value="--cal_icell(control, 5)" /></td>
<td align="center"><v:button style="url" action="simple" name="b7" value="--cal_icell(control, 6)" /></td>
</tr>
</table>
</v:template>
</v:template>
<v:template type="simple" name="cbott1" name-to-remove="table" set-to-remove="top">
<table>
</table>
</v:template>
</v:calendar>
</v:form>
</body>
</html>
</v:page>
</screen>
</example>
</refsect1>
</refentry>
|