SF.net SVN: ledger-smb:[6091] trunk/UI/lib/TabSet.js

[..hidden..]

Revision: 6091
          http://sourceforge.net/p/ledger-smb/code/6091
Author:   einhverfr
Date:     2013-09-28 03:32:02 +0000 (Sat, 28 Sep 2013)
Log Message:
-----------
updated docs on new tab widget

Modified Paths:
--------------
    trunk/UI/lib/TabSet.js

Modified: trunk/UI/lib/TabSet.js
===================================================================
--- trunk/UI/lib/TabSet.js	2013-09-28 03:27:52 UTC (rev 6090)
+++ trunk/UI/lib/TabSet.js	2013-09-28 03:32:02 UTC (rev 6091)
@@ -1,3 +1,37 @@
+/* lsmb/lib/TabSet
+ * A Dojo tabset widget for LedgerSMB
+ * based on dijit/layout/TabContainer
+ *
+ * This widget features autodetection of internal content panes but currently 
+ * does not support nesting unless content panes are remote.  That may change
+ * in future versions.  Additionally, this widget supports initial tab selection
+ * and size declarations via the startup() call.
+ *
+ * Overridden methods:
+ *
+ * startup(activeDiv, boxSize)
+ *
+ * activeDiv is the element id of the pane to be activated on startup, and
+ * boxSize is the size to make the tabset.
+ *
+ * Internal content panes are created from divs with a class of 'lsmb-tab' 
+ * allowing for dojo-agnostic auto-detection.
+ *
+ * Sample (instantiates a tab set, sets the active div to the activeDiv 
+ *         parameter in the global scope, and sets the size to the viewport):
+ * require([
+ *          'dojo/query',
+ *          'dojo/dom',
+ *          "lsmb/lib/TabSet",
+ *          'dojo/window',
+ *          'dojo/domReady!'],
+ * function(query, dom, tc, win){
+ *     var tabs = new tc({}, dom.byId('contact_tabs'));
+ *     tabs.startup(activeDiv, win.getBox());
+ * }
+ * ); 
+ *
+ */
 define([
     'dijit/layout/TabContainer',
     'dojo/_base/declare'

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.


------------------------------------------------------------------------------
October Webinars: Code for Performance
Free Intel webinars can help you accelerate application performance.
Explore tips for MPI, OpenMP, advanced profiling, and more. Get the most from 
the latest Intel processors and coprocessors. See abstracts and register >
http://pubads.g.doubleclick.net/gampad/clk?id=60133471&iu=/4140/ostg.clktrk
_______________________________________________
Ledger-smb-commits mailing list
..hidden..
https://lists.sourceforge.net/lists/listinfo/ledger-smb-commits