[Laszlo-checkins] r9469 - openlaszlo/trunk/WEB-INF/lps/lfc/services

[lou@openlaszlo.org]

Author: lou
Date: 2008-06-05 05:02:36 -0700 (Thu, 05 Jun 2008)
New Revision: 9469

Modified:
   openlaszlo/trunk/WEB-INF/lps/lfc/services/LzCursor.lzs
Log:
Change 20080605-lou-u by lou at loumac.local on 2008-06-05 07:55:06 AST
    in /Users/lou/src/svn/openlaszlo/trunk
    for http://svn.openlaszlo.org/openlaszlo/trunk

Summary: reference: move examples and text in LzCursor to LzCursorService

Bugs Fixed: LPP-5617

Technical Reviewer: (pending)
QA Reviewer: (pending)
Doc Reviewer: (pending)

Details: 
move the examples and text
change LzCurser in the second example to lz.Cursor
fix the shortdescs for LzCursorService and LzCursor    

Tests: visual verify



Modified: openlaszlo/trunk/WEB-INF/lps/lfc/services/LzCursor.lzs
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/services/LzCursor.lzs	2008-06-05 12:01:28 UTC (rev 9468)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/services/LzCursor.lzs	2008-06-05 12:02:36 UTC (rev 9469)
@@ -10,9 +10,36 @@
  */
 
 /**
- * Implementation of cursor controls
+* <p>This example shows how the cursor can be set on a view so that
+ * it will change when the mouse is over that view:</p>
+*
+* <example title="Setting the cursor for a view">
+ * &lt;canvas height="30"&gt;
+ *   &lt;resource name="waitcursor" src="resources/lzwaitcursor_rsc.swf"/&gt;
+ *   &lt;view bgcolor="yellow" cursor="waitcursor"&gt;
+ *     &lt;text&gt;Roll over to change the cursor&lt;/text&gt;
+ *   &lt;/view&gt;
+ * &lt;/canvas&gt;
+ * </example>
+*
+* <p>This example changes the cursor for 1/2 second when the button is
+ * clicked:</p>
+*
+* <example title="Changing the cursor with LzCursor">
+ * &lt;canvas height="30"&gt;
+ *   &lt;resource name="waitcursor" src="resources/lzwaitcursor_rsc.swf"/&gt;
+ *   &lt;button onclick="setCursor()" text="Click me to change the cursor for 1/2 second"&gt;
+ *     &lt;method name="setCursor"&gt;
+ *       lz.Cursor.setCursorGlobal('waitcursor');
+ *       var del= new LzDelegate(LzCursor, 'unlock');
+ *       lz.Timer.addTimer(del, 500);
+ *     &lt;/method&gt;
+ *   &lt;/button&gt;
+ * &lt;/canvas&gt;
+ * </example>
  * @devnote TODO: [2008-03-20 ptw] This should be `implements` not `extends`.
  * @access public
+ * @shortdesc LzCursorService provides methods for changing the mouse cursor.
  */
 public class LzCursorService {
   /** The cursor service.  Also available as the global
@@ -114,40 +141,10 @@
 
 /**
  *
- * <p>The <code>LzCursor</code> service provides methods for
- * changing the mouse cursor.</p>
  *
- * <p>This example shows how the cursor can be set on a view so that
- * it will change when the mouse is over that view:</p>
- *
- * <example title="Setting the cursor for a view">
- * &lt;canvas height="30"&gt;
- *   &lt;resource name="waitcursor" src="resources/lzwaitcursor_rsc.swf"/&gt;
- *   &lt;view bgcolor="yellow" cursor="waitcursor"&gt;
- *     &lt;text&gt;Roll over to change the cursor&lt;/text&gt;
- *   &lt;/view&gt;
- * &lt;/canvas&gt;
- * </example>
- *
- * <p>This example changes the cursor for 1/2 second when the button is
- * clicked:</p>
- *
- * <example title="Changing the cursor with LzCursor">
- * &lt;canvas height="30"&gt;
- *   &lt;resource name="waitcursor" src="resources/lzwaitcursor_rsc.swf"/&gt;
- *   &lt;button onclick="setCursor()" text="Click me to change the cursor for 1/2 second"&gt;
- *     &lt;method name="setCursor"&gt;
- *       LzCursor.setCursorGlobal('waitcursor');
- *       var del= new LzDelegate(LzCursor, 'unlock');
- *       lz.Timer.addTimer(del, 500);
- *     &lt;/method&gt;
- *   &lt;/button&gt;
- * &lt;/canvas&gt;
- * </example>
- *
  * @type LzCursorService
- * @deprecated
- * @shortdesc  LzCursor is a shortcut for <link linkend="LzCursorService">LzCursorService.LzCursor</link>
+ * @keywords deprecated
+ * @shortdesc LzCursor is a shortcut for <link linkend="LzCursorService">LzCursorService.LzCursor</link>. Use lz.Cursor instead.
  */
 var LzCursor = lz.Cursor;