Author: ben
Date: 2007-11-13 17:42:38 -0800 (Tue, 13 Nov 2007)
New Revision: 7245
Modified:
openlaszlo/trunk/WEB-INF/lps/lfc/controllers/LzAnimatorGroup.lzs
openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataElement.lzs
openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataNode.lzs
openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataRequest.lzs
openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataText.lzs
openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDatapointer.lzs
openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataset.lzs
openlaszlo/trunk/WEB-INF/lps/lfc/data/LzReplicationManager.lzs
openlaszlo/trunk/WEB-INF/lps/lfc/helpers/LzCommand.lzs
openlaszlo/trunk/WEB-INF/lps/lfc/helpers/LzState.lzs
openlaszlo/trunk/WEB-INF/lps/lfc/services/LzIdle.lzs
openlaszlo/trunk/WEB-INF/lps/lfc/views/LzInputText.lzs
openlaszlo/trunk/WEB-INF/lps/lfc/views/LzText.lzs
Log:
Change 20071113-ben-q by [EMAIL PROTECTED] on 2007-11-13 17:30:43 PST
in /Users/ben/src/svn/openlaszlo/trunk
for http://svn.openlaszlo.org/openlaszlo/trunk
Summary: Add event annotations to LFC classes so the doctools can find them
Technical Reviewer: none
QA Reviewer: none
Documentation:
This change adds annotation comments only!
It just adds @lzxtype event to the doc comment
for each LzDeclaredEvent.
With this change, the events will appear in the Events
table in the reference. For exmaple,
http://localhost:8080/trunk/docs/reference/LzText.html
lists these events in the Events section:
onhscroll
onmaxhscroll
onmaxlength
onmaxscroll
onpattern
onscroll
ontext
Tests:
See LFC reference. Note that the events are listed in the
events section.
Modified: openlaszlo/trunk/WEB-INF/lps/lfc/controllers/LzAnimatorGroup.lzs
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/controllers/LzAnimatorGroup.lzs
2007-11-14 01:38:07 UTC (rev 7244)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/controllers/LzAnimatorGroup.lzs
2007-11-14 01:42:38 UTC (rev 7245)
@@ -183,28 +183,36 @@
* @modifier read-only
*/
var isactive = false;
-
+/** @lzxtype event */
var ontarget = LzDeclaredEvent;
+/** @lzxtype event */
var onduration = LzDeclaredEvent;
+/** @lzxtype event */
var onstarted = LzDeclaredEvent;
/** Executed when the animator starts. This code is executed
* multiple times if the animator repeats.
+ * @lzxtype event
*/
var onstart = LzDeclaredEvent;
+/** @lzxtype event */
var onpaused = LzDeclaredEvent;
/** Use of 'onfinish' event
* is deprecated. Use 'onstop' event instead.
* @keywords deprecated
+ * @lzxtype event
*/
var onfinish = LzDeclaredEvent;
/** Executed when the animator finishes.
+ * @lzxtype event
*/
var onstop = LzDeclaredEvent;
-/** Event sent at the beginning of each new repeat. */
+/** Event sent at the beginning of each new repeat.
+ * @lzxtype event
+ */
var onrepeat = LzDeclaredEvent;
var animatorProps = { attribute : true, from : true ,
Modified: openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataElement.lzs
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataElement.lzs 2007-11-14
01:38:07 UTC (rev 7244)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataElement.lzs 2007-11-14
01:42:38 UTC (rev 7245)
@@ -32,11 +32,17 @@
}
}
+/** @lzxtype event */
var onDocumentChange = LzDeclaredEvent;
+/** @lzxtype event */
var onparentNode = LzDeclaredEvent;
+/** @lzxtype event */
var onchildNode = LzDeclaredEvent;
+/** @lzxtype event */
var onchildNodes = LzDeclaredEvent;
+/** @lzxtype event */
var onattributes = LzDeclaredEvent;
+/** @lzxtype event */
var onnodeName = LzDeclaredEvent;
/** @access private */
Modified: openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataNode.lzs
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataNode.lzs 2007-11-14
01:38:07 UTC (rev 7244)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataNode.lzs 2007-11-14
01:42:38 UTC (rev 7245)
@@ -66,6 +66,7 @@
*/
trait LzDataNode {
+/** @lzxtype event */
var onownerDocument = LzDeclaredEvent;
Modified: openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataRequest.lzs
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataRequest.lzs 2007-11-14
01:38:07 UTC (rev 7244)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataRequest.lzs 2007-11-14
01:42:38 UTC (rev 7245)
@@ -42,7 +42,8 @@
// Used by dataprovider to record error messages
var error = null;
-
+
+ /** @lzxtype event */
var onstatus = LzDeclaredEvent;
function initialize (requestor) {
Modified: openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataText.lzs
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataText.lzs 2007-11-14
01:38:07 UTC (rev 7244)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataText.lzs 2007-11-14
01:42:38 UTC (rev 7245)
@@ -26,12 +26,17 @@
this.data = text;
}
-
+/** @lzxtype event */
var onDocumentChange = LzDeclaredEvent;
+/** @lzxtype event */
var onparentNode = LzDeclaredEvent;
+/** @lzxtype event */
var onchildNode = LzDeclaredEvent;
+/** @lzxtype event */
var onchildNodes = LzDeclaredEvent;
+/** @lzxtype event */
var onattributes = LzDeclaredEvent;
+/** @lzxtype event */
var onnodeName = LzDeclaredEvent;
/** This property is of type String, can raise a DOMException object on setting
Modified: openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDatapointer.lzs
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDatapointer.lzs 2007-11-14
01:38:07 UTC (rev 7244)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDatapointer.lzs 2007-11-14
01:42:38 UTC (rev 7245)
@@ -125,7 +125,9 @@
var rerunxpath = false;
setters.rerunxpath = "__LZsetRerunXPath";
+/** @lzxtype event */
var onp = LzDeclaredEvent;
+/** @lzxtype event */
var onDocumentChange = LzDeclaredEvent;
/** Sent when the data selected by this datapointer's
<attribute>xpath</attribute>
* changes. For XPaths which select a datanode, this means that the
@@ -134,16 +136,20 @@
* text selected by the <attribute>xpath</attribute> has changed. Note that a
datapointer mapped to
* a data node will not receive <event>ondata</event> when the node, say,
changes one of
* its attributes.
+ * @lzxtype event
*/
var ondata = LzDeclaredEvent;
/** Sent when the dataset that the datapointer
* is pointing to generates an error.
+ * @lzxtype event
*/
var onerror = LzDeclaredEvent;
/** Sent when a request by the dataset that
* the datapointer is pointing to times out.
+ * @lzxtype event
*/
var ontimeout = LzDeclaredEvent;
+/** @lzxtype event */
var onrerunxpath = LzDeclaredEvent;
Modified: openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataset.lzs
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataset.lzs 2007-11-14 01:38:07 UTC
(rev 7244)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataset.lzs 2007-11-14 01:42:38 UTC
(rev 7245)
@@ -103,10 +103,15 @@
var dataRequestClass = LzHTTPDataRequest;
var dsloadDel = null;
+/** @lzxtype event */
var ondata = LzDeclaredEvent;
-/** Sent when the dataset's request results in an error. */
+/** Sent when the dataset's request results in an error.
+ * @lzxtype event
+ */
var onerror = LzDeclaredEvent;
-/** Sent when the request made by the dataset times out. */
+/** Sent when the request made by the dataset times out.
+ * @lzxtype event
+ */
var ontimeout = LzDeclaredEvent;
var timeout = 60000;
Modified: openlaszlo/trunk/WEB-INF/lps/lfc/data/LzReplicationManager.lzs
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/data/LzReplicationManager.lzs
2007-11-14 01:38:07 UTC (rev 7244)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/data/LzReplicationManager.lzs
2007-11-14 01:42:38 UTC (rev 7245)
@@ -111,8 +111,11 @@
/** @access private */
var __LZdataoffset = 0;
+/** @lzxtype event */
var onnodes = LzDeclaredEvent;
+/** @lzxtype event */
var onclones = LzDeclaredEvent;
+/** @lzxtype event */
var onvisible = LzDeclaredEvent;
/**
Modified: openlaszlo/trunk/WEB-INF/lps/lfc/helpers/LzCommand.lzs
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/helpers/LzCommand.lzs 2007-11-14
01:38:07 UTC (rev 7244)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/helpers/LzCommand.lzs 2007-11-14
01:42:38 UTC (rev 7245)
@@ -55,6 +55,7 @@
/**
* If the command is active, this event is sent
* when the keys array are pressed simultaneously.
+ * @lzxtype event
*/
var onselect = LzDeclaredEvent;
Modified: openlaszlo/trunk/WEB-INF/lps/lfc/helpers/LzState.lzs
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/helpers/LzState.lzs 2007-11-14
01:38:07 UTC (rev 7244)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/helpers/LzState.lzs 2007-11-14
01:42:38 UTC (rev 7245)
@@ -79,9 +79,14 @@
*/
static var tagname = 'state';
-/** Sent when the state is applied. */
+/** Sent when the state is applied.
+ * @lzxtype event
+ */
var onapply = LzDeclaredEvent;
-/** Sent when the state is removed */
+
+/** Sent when the state is removed
+ * @lzxtype event
+ */
var onremove = LzDeclaredEvent;
/** <code>setAttribute('apply', true)</code> will
Modified: openlaszlo/trunk/WEB-INF/lps/lfc/services/LzIdle.lzs
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/services/LzIdle.lzs 2007-11-14
01:38:07 UTC (rev 7244)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/services/LzIdle.lzs 2007-11-14
01:42:38 UTC (rev 7245)
@@ -75,7 +75,9 @@
}
}
-/** This is the idle event for the system, sent by this service */
+/** This is the idle event for the system, sent by this service
+ * @lzxtype event
+ */
var onidle = LzDeclaredEvent;
function toString () { return "LzIdle" }; // LzIdle in case somebody checks it
Modified: openlaszlo/trunk/WEB-INF/lps/lfc/views/LzInputText.lzs
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/views/LzInputText.lzs 2007-11-14
01:38:07 UTC (rev 7244)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/views/LzInputText.lzs 2007-11-14
01:42:38 UTC (rev 7245)
@@ -72,11 +72,15 @@
*/
class LzInputText extends LzText {
+/** @lzxtype event */
+var onenabled = LzDeclaredEvent;
-var onenabled = LzDeclaredEvent;
+/** @lzxtype event */
var onselect = LzDeclaredEvent;
-/** whenever the text in the field changes. */
+/** whenever the text in the field changes.
+ * @lzxtype event
+ */
var ontext = LzDeclaredEvent;
/** @access private
Modified: openlaszlo/trunk/WEB-INF/lps/lfc/views/LzText.lzs
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/views/LzText.lzs 2007-11-14 01:38:07 UTC
(rev 7244)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/views/LzText.lzs 2007-11-14 01:42:38 UTC
(rev 7245)
@@ -78,13 +78,21 @@
*/
static var tagname = 'text';
-/** Sent whenever the text in the field changes. */
+/** Sent whenever the text in the field changes.
+ * @lzxtype event
+ */
var ontext = LzDeclaredEvent;
+/** @lzxtype event */
var onmaxlength = LzDeclaredEvent;
+/** @lzxtype event */
var onpattern = LzDeclaredEvent;
+/** @lzxtype event */
var onscroll = LzDeclaredEvent;
+/** @lzxtype event */
var onmaxscroll = LzDeclaredEvent;
+/** @lzxtype event */
var onhscroll = LzDeclaredEvent;
+/** @lzxtype event */
var onmaxhscroll = LzDeclaredEvent;
/**
_______________________________________________
Laszlo-checkins mailing list
[email protected]
http://www.openlaszlo.org/mailman/listinfo/laszlo-checkins
