[Laszlo-checkins] r12706 - openlaszlo/trunk/docs/src/reference
dda@openlaszlo.org
dda at openlaszlo.org
Sun Feb 1 09:34:19 PST 2009
Author: dda
Date: 2009-02-01 09:34:17 -0800 (Sun, 01 Feb 2009)
New Revision: 12706
Modified:
openlaszlo/trunk/docs/src/reference/langref.xml
Log:
Change 20090130-dda-P by dda at lester-2.local on 2009-01-30 15:29:33 EST
in /Users/dda/laszlo/src/svn/openlaszlo/trunk-doc4
for http://svn.openlaszlo.org/openlaszlo/trunk
Summary: Restore LzDelegate documentation
New Features:
Bugs Fixed: LPP-7584 [Bring lz.Delegate docs back]
Technical Reviewer: max (pending)
QA Reviewer: (pending)
Doc Reviewer: liorio (pending)
Documentation:
Release Notes:
Details:
In 3.x versions there were two overlapping bits of documentation,
one referred to as <handler> and one as LzDelegate. In 4.0 or thereabouts,
LzDelegate doc came from the javascript class doc, and the <handler> doc
was copied from 3.x and pasted in via some 'canned' js2doc (langref.xml)
When the great renaming took place, LzDelegate got renamed
to lz.handler (to match its <handler> tag), but in the simple doc
tools world, the canned <handler> doc now shadowed the lz.handler doc
since they were written to the same .html file.
As a side-effect, automatically generated indices for Classes and Tags
did not index the <handler> page.
This change removes the canned documentation in preference
to what is in the javadoc for the LzDelegate class so there is only ONE source
for <handler> in the reference doc. If there is important content that was lost,
it could be either inserted into LzDelegate javadoc, and/or be put into the developers guide.
Note that there was an example that may be worth recovering.
Tests:
Rebuilt reference doc and changed the <handler> page and links to it in the
index.
Modified: openlaszlo/trunk/docs/src/reference/langref.xml
===================================================================
--- openlaszlo/trunk/docs/src/reference/langref.xml 2009-02-01 16:09:59 UTC (rev 12705)
+++ openlaszlo/trunk/docs/src/reference/langref.xml 2009-02-01 17:34:17 UTC (rev 12706)
@@ -563,68 +563,6 @@
</class>
</property>
-<property id="tag.handler" topic="LFC" subtopic="Events" access="public">
- <doc>
- <tag name="shortdesc"><text>Attaches an event handler to an object or class.</text></tag>
- <tag name="lzxname"><text>handler</text></tag>
- <text>
- <para>Attaches a handler method for the named event to the object that contains this element.
- The handler method must have a <sgmltag class="attribute">name</sgmltag>.</para>
- <para>The <sgmltag class="attribute">name</sgmltag> attribute gives the event for which this handler should be invoked.</para>
- <para>Events can be declared via the <sgmltag class="attribute" role="LzEvent"><event></sgmltag> tag.
- Events are also generated whenever the value of an attribute is changed using the <method>setAttribute()</method> method.</para>
- <para>For example, if a handler is defined via:
- <programlisting><![CDATA[
-<view id="obj">
- <handler name="onmyevent" args="a">
- this.setBGColor(0xff0000);
- Debug.debug('%w got onblah event, arg is %w', this, a);
- </handler>
-</view>]]></programlisting>
- then script code <literal>obj.onmyevent.sendEvent(259)</literal> will invoke this handler method.</para>
- <para>The argument passed to an event handler is whatever value was used in the call to <method>sendEvent()</method> which generated the event.
- In the case where an attribute value is set using <method>setAttribute()</method>, the new value is sent as the argument to <method>sendEvent()</method>,
- and that will be the argument value received to any user-defined handler for that event.</para>
- </text>
- </doc>
- <class>
- <property name="__ivars__" access="public">
- <object>
- <property name="args" modifiers="final">
- <doc>
- <tag name="lzxtype"><text>string</text></tag>
- <text>The parameter names of this handler. The value of this attribute is a comma-separated list of JavaScript identifiers.</text>
- </doc>
- </property>
- <property name="method" modifiers="final">
- <doc>
- <tag name="lzxtype"><text>string</text></tag>
- <text>A method to call when this handler is invoked.</text>
- </doc>
- </property>
- <property name="name" modifiers="final">
- <doc>
- <tag name="lzxtype"><text>token</text></tag>
- <text>The name of a variable that will be set to this object when the application is started.
- If this element is directly within a <sgmltag class="element" role="LzCanvas"><canvas></sgmltag>
- or <sgmltag class="element" role="tag.library"><library></sgmltag> element, the global variable
- and the canvas property with this name will be set to this object. If this element is within another object,
- that object's property with this name will be set to this object.</text>
- </doc>
- </property>
- <property name="reference" modifiers="final">
- <doc>
- <tag name="lzxtype"><text>reference</text></tag>
- <text>If this attribute is present, it is a JavaScript expression that evaluates to an object.
- The code in this method executes when this object sends the event named by the <sgmltag class="attribute">event</sgmltag> attribute.
- This attribute may be present only if the <sgmltag class="attribute">event</sgmltag> attribute is present too.</text>
- </doc>
- </property>
- </object>
- </property>
- </class>
-</property>
-
<property id="tag.security" topic="LZX" subtopic="Basics" access="public">
<doc>
<tag name="shortdesc"><text>Canvas element used to control RPC security</text></tag>
More information about the Laszlo-checkins
mailing list