Author: dda
Date: 2008-01-30 09:19:23 -0800 (Wed, 30 Jan 2008)
New Revision: 7928
Modified:
openlaszlo/trunk/WEB-INF/lps/lfc/core/LzNode.lzs
openlaszlo/trunk/WEB-INF/lps/lfc/views/LaszloView.lzs
Log:
Change 20080130-dda-a by [EMAIL PROTECTED] on 2008-01-30 12:08:47 EST
in /Users/dda/laszlo/src/svn/openlaszlo/trunk-doc
for http://svn.openlaszlo.org/openlaszlo/trunk
Summary: doc: expose some functions/events as public according to comments from
API review. (partial fix)
New Features:
Bugs Fixed: LPP-5011
Technical Reviewer: (pending)
QA Reviewer: (pending)
Doc Reviewer: liorio (pending)
Documentation:
Release Notes:
Details:
Using the comments from http://wiki.openlaszlo.org/LFC_API_review ,
resolved some more issues. Since there are dozens of issues on the
page, it's a work in progress. I don't claim that all the issues
in the page are solved, only that they are resolved unless they are marked
with the red 'OPEN' marker. And yes, there are still many OPEN items.
The OPEN ones will be continued to be fixed
incrementally, and the JIRA bug will be kept unresolved through this
process.
Changes are to javadoc only, no code changes.
Tests:
Modified: openlaszlo/trunk/WEB-INF/lps/lfc/core/LzNode.lzs
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/core/LzNode.lzs 2008-01-30 17:18:37 UTC
(rev 7927)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/core/LzNode.lzs 2008-01-30 17:19:23 UTC
(rev 7928)
@@ -1629,6 +1629,7 @@
this.options[ key ] = val;
}
+// The access for doc is public, since it is referred to several times in doc
/**
* Determines the immediateparent for a subnode whose parent is this node.
* This method will only be called for subnodes which have a placement
@@ -1641,11 +1642,11 @@
* A subclass might implement this method to cause the "placement" parameter
* to have a different behavior or additional effects.
*
- * Note that this function is not currently designed to be called by anyone
but
+ * <note>This function is not currently designed to be called by anyone but
* LzNode.construct. Do not expect to be able to 'place' a view properly after
- * it has been constructed.
+ * it has been constructed.</note>
*
- * @access private
+ * @access public
* @param LzNode aSub: The new subnode
* @param String placement: The placement attribute for the new subnode
* @param dictionary args: The initialization args for the new subnode
Modified: openlaszlo/trunk/WEB-INF/lps/lfc/views/LaszloView.lzs
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/views/LaszloView.lzs 2008-01-30
17:18:37 UTC (rev 7927)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/views/LaszloView.lzs 2008-01-30
17:19:23 UTC (rev 7928)
@@ -90,7 +90,8 @@
* @access public
*/
var onfocus = LzDeclaredEvent; // From LzFocus
-/** @lzxtype event
+/** Sent onidle while view is playing its resource
+ * @lzxtype event
* @access public
*/
var onframe = LzDeclaredEvent;
@@ -122,7 +123,10 @@
* @lzxtype event
*/
var onkeydown = LzDeclaredEvent; // From LzFocus
-/** @lzxtype event
+/** Sent when the view sets its frame (resource number) to the last
+ * frame. This can be used to find out when a streaming media clip is
+ * done playing.
+ * @lzxtype event
* @access public
*/
var onlastframe = LzDeclaredEvent;
@@ -132,19 +136,18 @@
var onload = LzDeclaredEvent;
/** @lzxtype event
- * @access private
+ * @access public
*/
var onloadperc = LzDeclaredEvent;
-/** <event>onerror</event>: Sent when there is an error loading the view's
resource.
+/** Sent when there is an error loading the view's resource.
* The argument sent with the event is the error string sent by the server.
* @access public
* @lzxtype event
*/
var onerror = LzDeclaredEvent;
-/**
- * <event>ontimeout</event>: Sent when the request to load media for the view
times
+/** Sent when the request to load media for the view times
* out
* @lzxtype event
* @access public
@@ -195,7 +198,8 @@
*/
var onopacity = LzDeclaredEvent;
-/** @access private
+/**
+ * Sent when a view begins playing its resource
* @lzxtype event
* @access public
*/
@@ -224,7 +228,11 @@
* @lzxtype event
*/
var onrotation = LzDeclaredEvent;
-/** @access public
+/**
+ * Sent when a view's resource that is capable of playing is
+ * stopped. This is only called if stop is called directly; when a resource
+ * hits its last frame, the LzView event onlastframe is called.
+ * @access public
* @lzxtype event
*/
var onstop = LzDeclaredEvent;
@@ -242,7 +250,7 @@
var onunstretchedwidth = LzDeclaredEvent;
/** @lzxtype event
- * @access private
+ * @access public
*/
var onvisible = LzDeclaredEvent;
_______________________________________________
Laszlo-checkins mailing list
[email protected]
http://www.openlaszlo.org/mailman/listinfo/laszlo-checkins
