major doc changes
[roojs1] / Roo / bootstrap / nav / ProgressBar.js
similarity index 83%
rename from Roo/bootstrap/NavProgressBar.js
rename to Roo/bootstrap/nav/ProgressBar.js
index 7afa07c..b5da843 100644 (file)
@@ -6,42 +6,46 @@
  */
 
 /**
- * @class Roo.bootstrap.NavProgressBar
+ * @class Roo.bootstrap.nav.ProgressBar
  * @extends Roo.bootstrap.Component
+ * @children Roo.bootstrap.nav.ProgressBarItem
  * Bootstrap NavProgressBar class
  * 
  * @constructor
- * Create a new nav progress bar
+ * Create a new nav progress bar - a bar indicating step along a process
  * @param {Object} config The config object
  */
 
-Roo.bootstrap.NavProgressBar = function(config){
-    Roo.bootstrap.NavProgressBar.superclass.constructor.call(this, config);
+Roo.bootstrap.nav.ProgressBar = function(config){
+    Roo.bootstrap.nav.ProgressBar.superclass.constructor.call(this, config);
 
     this.bullets = this.bullets || [];
    
-//    Roo.bootstrap.NavProgressBar.register(this);
+//    Roo.bootstrap.nav.ProgressBar.register(this);
      this.addEvents({
         /**
             * @event changed
             * Fires when the active item changes
-            * @param {Roo.bootstrap.NavProgressBar} this
-            * @param {Roo.bootstrap.NavProgressItem} selected The item selected
-            * @param {Roo.bootstrap.NavProgressItem} prev The previously selected item 
+            * @param {Roo.bootstrap.nav.ProgressBar} this
+            * @param {Roo.bootstrap.nav.ProgressItem} selected The item selected
+            * @param {Roo.bootstrap.nav.ProgressItem} prev The previously selected item 
          */
         'changed': true
      });
     
 };
 
-Roo.extend(Roo.bootstrap.NavProgressBar, Roo.bootstrap.Component,  {
-    
+Roo.extend(Roo.bootstrap.nav.ProgressBar, Roo.bootstrap.Component,  {
+    /**
+     * @cfg {Roo.bootstrap.nav.ProgressItem} NavProgressBar:bullets[]
+     * Bullets for the Nav Progress bar for the toolbar
+     */
     bullets : [],
     barItems : [],
     
     getAutoCreate : function()
     {
-        var cfg = Roo.apply({}, Roo.bootstrap.NavProgressBar.superclass.getAutoCreate.call(this));
+        var cfg = Roo.apply({}, Roo.bootstrap.nav.ProgressBar.superclass.getAutoCreate.call(this));
         
         cfg = {
             tag : 'div',
@@ -81,7 +85,7 @@ Roo.extend(Roo.bootstrap.NavProgressBar, Roo.bootstrap.Component,  {
     
     onRender : function(ct, position) 
     {
-        Roo.bootstrap.NavProgressBar.superclass.onRender.call(this, ct, position);
+        Roo.bootstrap.nav.ProgressBar.superclass.onRender.call(this, ct, position);
         
         if(this.bullets.length){
             Roo.each(this.bullets, function(b){
@@ -95,7 +99,7 @@ Roo.extend(Roo.bootstrap.NavProgressBar, Roo.bootstrap.Component,  {
     
     addItem : function(cfg)
     {
-        var item = new Roo.bootstrap.NavProgressItem(cfg);
+        var item = new Roo.bootstrap.nav.ProgressItem(cfg);
         
         item.parentId = this.id;
         item.render(this.el.select('.roo-navigation-bar', true).first(), null);