[Laszlo-checkins] r9008 - openlaszlo/trunk/WEB-INF/lps/lfc/helpers

[max@openlaszlo.org]

Author: max
Date: 2008-05-05 14:22:23 -0700 (Mon, 05 May 2008)
New Revision: 9008

Modified:
   openlaszlo/trunk/WEB-INF/lps/lfc/helpers/LzSelectionManager.lzs
Log:
Change 20080505-maxcarlson-X by maxcarlson at Roboto on 2008-05-05 13:55:38 PDT
    in /Users/maxcarlson/openlaszlo/trunk-clean
    for http://svn.openlaszlo.org/openlaszlo/trunk

Summary: Fix LzSelectionManager docs

New Features:

Bugs Fixed: LPP-5619 - selectionmanager reference page problems

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

Documentation:

Release Notes:

Details: Change unused 'selFuncName' constructor arg to a more sane 'sel'. Clean up doc comments, hide attributes that should be private.
    

Tests: docs/reference/LzSelectionManager.html docs look good, example continues to work.



Modified: openlaszlo/trunk/WEB-INF/lps/lfc/helpers/LzSelectionManager.lzs
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/helpers/LzSelectionManager.lzs	2008-05-05 20:59:01 UTC (rev 9007)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/helpers/LzSelectionManager.lzs	2008-05-05 21:22:23 UTC (rev 9008)
@@ -82,12 +82,13 @@
   *
   * @initarg Boolean toggle: If true, a re-selected element will lose
   * the selection.
-  * @initarg private Boolean selFuncName: The name of the method to call (with true or
+  * @initarg Boolean sel: The name of the method to call (with true or
   * false to represent selectedness) when an element changes its selectedness
   */
   
 class LzSelectionManager extends LzNode {
 
+/** @access private */
 function LzSelectionManager ( parent:LzNode? = null , attrs:Object? = null , children:Array? = null, instcall:Boolean  = false) {
     super(parent,attrs,children,instcall);
 }
@@ -104,22 +105,25 @@
   * when an object's selectedness changes.  The method is called with a single Boolean argument.  The default value for this 
   * field is <code>setSelected</code>.
   * @type String
-  * @type token
+  * @lzxtype string
   */
-var sel;
+var sel = "setSelected";
 
 /** A hash of currently selected objects (by UID)
+  * @access private
   * @type Object
   */
 var selectedHash;
 
 /** An array that represents the current selection
+  * @access private
   * @type Array
   */
 var selected;
 
 /** If true, a re-selected element will lose the selection
   * @type Boolean
+  * @lzxtype boolean
   */
 var toggle;
 
@@ -141,7 +145,9 @@
 
     this.toggle = args.toggle == true;
 
-    this.sel = args.selFuncName == null ? "setSelected" : args.selFuncName;
+    if (args.sel != null) {
+        this.sel = args.sel;
+    }
     
     this.selected = new Array;
     this.selectedHash = new Object;
@@ -199,7 +205,6 @@
 
 /**
   * Unselects the given object.
-  * @access protected
   * @param LzView o: The object to make unselected
   */
 function unselect ( o ){
@@ -264,7 +269,6 @@
 /**
   * Determines whether the an additional selection should be multi-selected or
   * should replace the existing selection
-  * @access protected
   * @return Boolean:  If true, multi select. If false, don't multi select
   */
 function isMultiSelect ( ){
@@ -274,18 +278,17 @@
 /**
   * Determines whether the an additional selection should be range-selected or
   * should replace the existing selection
-  * @access protected
   * @return Boolean: If true, range select. If false, don't range select
   */
 function isRangeSelect(  ){
     return LzKeys.isKeyDown( "shift" );
 }
 
+/**
+  * @access private
+  */
 override function toString (){
     return "LzSelectionManager";
 }
 
 } // End of LzSelectionManager
-
-
-