Author: dda
Date: 2008-01-23 15:00:26 -0800 (Wed, 23 Jan 2008)
New Revision: 7878
Modified:
openlaszlo/trunk/WEB-INF/lps/lfc/core/LzNode.lzs
openlaszlo/trunk/WEB-INF/lps/lfc/views/LaszloView.lzs
Log:
Change 20080123-dda-l by [EMAIL PROTECTED] on 2008-01-23 10:46:42 EST
in /Users/dda/laszlo/src/svn/openlaszlo/trunk-doc
for http://svn.openlaszlo.org/openlaszlo/trunk
Summary: Set doc visibility for methods/events/attributes in LzNode, LzView
New Features:
Bugs Fixed: LPP-5011
Technical Reviewer: max (pending)
QA Reviewer: (pending)
Doc Reviewer: lou (pending)
Documentation: LzNode and LzView should be very close to 3.4 doc now.
See details below.
Release Notes:
Details:
Attempted to do a side by side comparison of what was missing in 4.x
doc vs. 3.4 doc. When discrepencies found, used
http://wiki.openlaszlo.org/LFC_API_review
as a guide, if it wasn't specifically mentioned (like the many events in
LzView),
I added in the missing items. In only a few cases this means that there
is now an item without doc, e.g. the 'onplay' event, which didn't have any
doc before.
There's a couple cases that probably need more clarification:
- LzNode.determinePlacement - max says 'this still exists',
I left it private because of this in the content:
Note that this function is not currently designed to be called by
anyone but LzNode.construct....
- LzView.layout had doc in 3.4, in 4.1 there is a (new?) LzView.layouts
attribute,
but LzView.layout did not appear in the doc. It looks like 'layouts' is the
preferred mechanism with layout now be used either internally? or for
backward
compatibility? I left LzView.layout to be unmarked (therefore private and
not shown).
Tests:
Modified: openlaszlo/trunk/WEB-INF/lps/lfc/core/LzNode.lzs
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/core/LzNode.lzs 2008-01-23 21:43:24 UTC
(rev 7877)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/core/LzNode.lzs 2008-01-23 23:00:26 UTC
(rev 7878)
@@ -893,7 +893,7 @@
* LzNodes may override or extend this method to change the
* meaning of attached subnodes.
*
- * @access protected
+ * @access public
*
* @param Array carr: an array of children where the structure of each child
[c]
* takes the form:
@@ -1645,7 +1645,7 @@
* LzNode.construct. Do not expect to be able to 'place' a view properly after
* it has been constructed.
*
- * @access protected
+ * @access private
* @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
@@ -1722,6 +1722,7 @@
* @param String prop: named property
* @return LzView: the first view which has a non-null value for
<param>prop</param>
* or <i>null</i> if none is found
+ * @access private
*/
function searchParents ( prop ){
var sview = this;
Modified: openlaszlo/trunk/WEB-INF/lps/lfc/views/LaszloView.lzs
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/views/LaszloView.lzs 2008-01-23
21:43:24 UTC (rev 7877)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/views/LaszloView.lzs 2008-01-23
23:00:26 UTC (rev 7878)
@@ -1,6 +1,6 @@
/**
*
- * @copyright Copyright 2001-2007 Laszlo Systems, Inc. All Rights Reserved.
+ * @copyright Copyright 2001-2008 Laszlo Systems, Inc. All Rights Reserved.
* Use is subject to license terms.
*
* @affects lzview
@@ -64,7 +64,7 @@
static var tagname = 'view';
/** Event called when this view adds a subview
- * @access private
+ * @access public
* @lzxtype event
*/
var onaddsubview = LzDeclaredEvent;
@@ -73,11 +73,13 @@
/** The onblur script is executed when an element loses focus either
* by the pointing device or by tabbing navigation.
* @lzxtype event
+ * @access public
*/
var onblur = LzDeclaredEvent;
/** The onclick script is executed when the pointing device button is
* clicked over an element.
* @lzxtype event
+ * @access public
*/
var onclick = LzDeclaredEvent;
/** @access private */
@@ -85,21 +87,28 @@
/** The onfocus script is executed when an element receives focus
* either by the pointing device or by tabbing navigation.
* @lzxtype event
+ * @access public
*/
var onfocus = LzDeclaredEvent; // From LzFocus
-/** @lzxtype event */
+/** @lzxtype event
+ * @access public
+ */
var onframe = LzDeclaredEvent;
/** Event for changes to view's <attribute>height</attribute> property
* @lzxtype event
+ * @access public
*/
var onheight = LzDeclaredEvent;
-/** @lzxtype event */
+/** @lzxtype event
+ * @access private
+ */
var onimload = LzDeclaredEvent;
/** The onkeyup script is executed when this view has the focus and a
* key is released. This event is sent with the keycode for the key that
* went up.
+ * @access public
* @lzxtype event
*/
var onkeyup = LzDeclaredEvent; // From LzFocus
@@ -109,19 +118,27 @@
* key that is held down. If you want the script executed only
* once, use onkeyup. This event is sent with the keycode for the key that is
* down.
+ * @access public
* @lzxtype event
*/
var onkeydown = LzDeclaredEvent; // From LzFocus
-/** @lzxtype event */
+/** @lzxtype event
+ * @access public
+ */
var onlastframe = LzDeclaredEvent;
-/** @lzxtype event */
+/** @lzxtype event
+ * @access public
+ */
var onload = LzDeclaredEvent;
-/** @lzxtype event */
+
+/** @lzxtype event
+ * @access private
+ */
var onloadperc = LzDeclaredEvent;
/** <event>onerror</event>: 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 private
+ * @access public
* @lzxtype event
*/
var onerror = LzDeclaredEvent;
@@ -130,10 +147,12 @@
* <event>ontimeout</event>: Sent when the request to load media for the view
times
* out
* @lzxtype event
+ * @access public
*/
var ontimeout = LzDeclaredEvent;
/** The onmousedown script is executed when the pointing device button is
* pressed over an element.
+ * @access public
* @lzxtype event
*/
var onmousedown = LzDeclaredEvent;
@@ -141,12 +160,14 @@
/** The onmouseout script is executed when the point device is moved
* so that is is no longer over an element.
* @lzxtype event
+ * @access public
*/
var onmouseout = LzDeclaredEvent;
/** The onmouseover script is executed when the pointing device is
* moved onto an element.
* @lzxtype event
+ * @access public
*/
var onmouseover = LzDeclaredEvent;
@@ -163,23 +184,27 @@
/** The onmouseup script is executed when the pointing device button is
* released over an element.
* @lzxtype event
+ * @access public
*/
var onmouseup = LzDeclaredEvent;
/**
* Sent when a view changes its opacity
* @lzxtype event
+ * @access public
*/
var onopacity = LzDeclaredEvent;
/** @access private
* @lzxtype event
+ * @access public
*/
var onplay = LzDeclaredEvent;
/**
* Event called when this view removes a subview
* @lzxtype event
+ * @access public
*/
var onremovesubview = LzDeclaredEvent;
@@ -199,7 +224,7 @@
* @lzxtype event
*/
var onrotation = LzDeclaredEvent;
-/** @access private
+/** @access public
* @lzxtype event
*/
var onstop = LzDeclaredEvent;
@@ -215,8 +240,12 @@
* @lzxtype event
*/
var onunstretchedwidth = LzDeclaredEvent;
-/** @lzxtype event */
+
+/** @lzxtype event
+ * @access private
+ */
var onvisible = LzDeclaredEvent;
+
/** @access private
* @lzxtype event
*/
@@ -224,11 +253,13 @@
/** event for changes to view's <attribute>width</attribute> property
* @lzxtype event
+ * @access public
*/
var onwidth = LzDeclaredEvent;
/** event for changes to view's <attribute>x</attribute> property
* @lzxtype event
+ * @access public
*/
var onx = LzDeclaredEvent;
/** @access private
@@ -238,6 +269,7 @@
/** event for changes to view's <attribute>y</attribute> property
* @lzxtype event
+ * @access public
*/
var ony = LzDeclaredEvent;
/** @access private
@@ -255,6 +287,7 @@
* ondblclick event, will simply send two click events.
* The view's doubleclick time can be adjusted by setting its
* DOUBLE_CLICK_TIME attribute
+ * @access public
* @lzxtype event
*/
var ondblclick = LzDeclaredEvent;
@@ -268,7 +301,7 @@
* Base level constructor for views. See <method
* classname="LzNode">construct</method> for more on this.
*
- * @access protected
+ * @access public
*/
function construct ( parent , args) {
//Debug.write('LzView.construct', parent, args);
@@ -337,7 +370,7 @@
* Called right before the view is shown. See <method
* classname="LzNode">init</method> for more.
*
- * @access protected
+ * @access public
*/
function init( ) {
//this.__LZmovieClipRef._visible = this.visible;
@@ -350,7 +383,7 @@
/**
* Called when a subview is added to the view.
- * @access protected
+ * @access private
* @param LzView s: The new subview
*/
function addSubview ( s ){
@@ -451,7 +484,7 @@
* at runtime.
* @type String
* @lzxtype expression
- * @access private
+ * @access public
*/
var source;
/**
@@ -544,6 +577,17 @@
/** Show or hide the handcursor for this view, if clickable */
setters.showhandcursor = "setShowHandCursor";
+/** A CSS property when declared in the tag: value sequence of layout
+ * parameters, which are used to create a layout that is attached to
+ * this view. If there is a class property, it names the class of the
+ * layout; otherwise <tagname>simplelayout</tagname> is used.
+ * Examples:
+ * <code>axis: x</code>, <code>class: constantlayout</code>;
+ * <code>axis: y</code>; <code>axis: x; spacing: 5</code>.
+ * @type Object
+ * @lzxtype css
+ * @access public
+ */
var layout;
setters.layout = "setLayout";
@@ -838,10 +882,12 @@
var resource = null;
/**
+ * The width of the resource that this view attached
* @keywords readonly
*/
var resourcewidth = null;
/**
+ * The height of the resource that this view attached
* @keywords readonly
*/
var resourceheight = null;
@@ -989,6 +1035,7 @@
* <code>axis: y</code>; <code>axis: x; spacing: 5</code>.
* @type Object
* @lzxtype css
+ * @access public
*/
var layouts = null;
@@ -1721,8 +1768,8 @@
/**
* Returns the width of the view.
- * @keywords protected
- * @deprecated
+ * @keywords private
+ * @deprecated use the width attribute directly
*/
function getWidth (){
return this.width;
@@ -1730,8 +1777,8 @@
/**
* Returns the height of the view.
- * @keywords protected
- * @deprecated
+ * @keywords private
+ * @deprecated use the height attribute directly
*/
function getHeight (){
return this.height;
@@ -2661,6 +2708,7 @@
* proxied by the LPS server; made directly to the URL; or should be passed to
* the next policy function in the list. The default policy function returns
* the value of canvas.proxied
+ * @access private
*/
static function addProxyPolicy ( f ){
LzView.__LZproxypolicies.push ( f );
@@ -2673,6 +2721,7 @@
* @param Function f: The function to remove from the policy list
* @return Boolean: Returns true if the function was found and removed, false
* if not
+ * @access private
*/
static function removeProxyPolicy ( f ){
var pol = LzView.__LZproxypolicies;
@@ -2712,14 +2761,12 @@
}
/**
- * LzView.getNextSelection
* Override to specify the next view to be focused
- * @access private
+ * @access public
*/
function getNextSelection() {
}
/**
- * LzView.getPrevSelection
* Override to specify the previous view to be focused
* @access public
*/
_______________________________________________
Laszlo-checkins mailing list
[email protected]
http://www.openlaszlo.org/mailman/listinfo/laszlo-checkins
