git.roojs.org Git - roojs1/blob - docs/Roo.docs.init.js

   1
   2
   3 Roo.docs.init = {
   4
   5     classes : false, // flat version of list of classes
   6     currentClass : '--none--', // currently viewed class name
   7
   8     prefix : '',
   9     hash : '',
  10
  11     onReady : function()
  12     {
  13
  14
  15         Roo.XComponent.hideProgress = true;
  16         Roo.XComponent.build();
  17
  18
  19         Roo.XComponent.on('buildcomplete', function() {
  20
  21             //Roo.XComponent.modules[0].el.fireEvent('render');
  22             this.loadTree();
  23         }, this);
  24         if (window.location.search.length > 0) {
  25             this.prefix = window.location.search.substring(1);
  26         }
  27
  28         window.onhashchange = function() { Roo.docs.init.onHashChange(); }
  29
  30
  31     },
  32
  33     loadTree: function()
  34     {
  35         Roo.docs.doc_body_content.hide();
  36
  37         Roo.Ajax.request({
  38             url : this.prefix + 'tree.json',
  39             method : 'GET',
  40             success : function(res, o)
  41             {
  42                 var d = Roo.decode(res.responseText);
  43                 //Roo.log(d);
  44                 this.classes = {};
  45                 // our classes witch children first..
  46                 d.forEach(function(e) {
  47                     if (e.cn.length) {
  48                         this.addTreeItem(Roo.docs.navGroup, e, 'NavSidebarItem', true );
  49
  50                     }
  51                 }, this);
  52
  53                 d.forEach(function(e) {
  54                     if (!e.cn.length) {
  55                         this.addTreeItem(Roo.docs.navGroup, e, 'NavSidebarItem' ,true);
  56                     }
  57                 }, this);
  58
  59                 // mobile....
  60
  61                 d.forEach(function(e) {
  62                     if (e.cn.length) {
  63                         this.addTreeItem(Roo.docs.mobileNavGroup, e, 'NavSidebarItem', false);
  64
  65                     }
  66                 }, this);
  67
  68                 d.forEach(function(e) {
  69                     if (!e.cn.length) {
  70                         this.addTreeItem(Roo.docs.mobileNavGroup, e, 'NavSidebarItem', false);
  71                     }
  72                 }, this);
  73
  74                 var roo = Roo.docs.navGroup.items[1].menu;
  75                 if (!Roo.docs.init.prefix.length) {
  76                     roo.show(roo.triggerEl, '?', false);
  77                 }
  78
  79                 if (location.hash.length) {
  80                     this.loadHash();
  81                     return;
  82                 }
  83
  84                 this.loadIntro();
  85
  86
  87             },
  88             scope : this
  89         });
  90
  91
  92     },
  93
  94     hideChildren : function(c)
  95     {
  96         if (c.node.menu) {
  97             c.node.menu.hide();
  98         }
  99         for (var i =0; i < c.cn.length; i++) {
 100             this.hideChildren(c.cn[i]);
 101         }
 102
 103     },
 104
 105
 106     addTreeItem : function(parent, e, type , parent_e) {
 107
 108         this.classes[e.name] = e;
 109         // add a node..
 110         var node = parent.addxtypeChild(Roo.factory({
 111             html: e.name.split('.').pop(),
 112            // id : e.name,
 113             xns : Roo.bootstrap,
 114             showArrow: false,
 115             xtype : type,
 116             preventDefault : true,
 117           //  cls : type == 'NavSidebarItem' ? 'open' : '',
 118             listeners : {
 119                 click : (function(mi,ev,c)
 120                 {
 121
 122                     ev.stopEvent();
 123
 124                     if (c.cn.length && !Roo.docs.init.prefix.length) {
 125                         //Roo.log(ev);
 126                         if (mi.menu.el.hasClass('show')) {
 127                             this.hideChildren(c); //mi.menu.hide();
 128                             // collapse children..
 129
 130
 131
 132                         } else {
 133                             mi.menu.show(mi.menu.triggerEl,'?', false);
 134                         }
 135
 136                     }
 137                     location.hash = '#' + c.name;
 138                     //Roo.docs.init.loadDoc(c);
 139
 140                 }).createDelegate(this,[e], true)
 141
 142             },
 143             fa :  e.cn.length  ? 'chevron-right' : '',
 144             menu : !e.cn.length ? false  : Roo.factory({
 145                 type : 'treeview',
 146                 xns: Roo.bootstrap,
 147                 xtype : 'Menu',
 148                 listeners : {
 149                     beforehide : (function(mi,c)
 150                     {
 151                         if (Roo.docs.init.prefix.length) {
 152                             return;
 153                         }
 154
 155                         if (c.name.split('.').length < 2)  {
 156                             return false;
 157                         }
 158                         return true;
 159
 160                     }).createDelegate(this,[e], true)
 161
 162                 }
 163
 164             })
 165         }));
 166
 167         // mobile nodes..?
 168
 169
 170
 171
 172
 173
 174         if (parent_e !== false) {
 175             e.node = node;
 176             e.parent_menu = parent;
 177             e.parent = parent_e == true ? null : parent_e;
 178         }
 179
 180         parent.items.push(node);
 181         if (e.cn.length  && type == 'NavSidebarItem') {
 182             this.topm = node.menu;
 183         }
 184
 185
 186         if (!e.cn.length) {
 187             return;
 188         }
 189         e.cn.forEach(function(ec) {
 190             var cn = ec.name.split('.').pop();
 191             //Roo.log(cn);
 192             if (cn == cn.toLowerCase()) {
 193                 this.addTreeItem(node.menu, ec,'MenuItem', parent_e !== false ? e : false);
 194             }
 195
 196         }, this);
 197         e.cn.forEach(function(ec) {
 198             var cn = ec.name.split('.').pop();
 199             if (cn != cn.toLowerCase()) {
 200                 this.addTreeItem(node.menu, ec,'MenuItem', parent_e !== false ? e : false);
 201             }
 202         }, this);
 203
 204     },
 205
 206     loadClass : function(name)
 207     {
 208         if(typeof(this.classes[name]) != 'undefined' && this.classes[name].is_class ) {
 209             this.loadDoc(this.classes[name]);
 210         }
 211
 212
 213
 214     },
 215
 216     loadSource : function( )
 217     {
 218
 219
 220         Roo.Ajax.request({
 221             url : 'src/' +this.currentClass.replace(/\./g,'_') + '.js.html',
 222             method : 'GET',
 223             success : function(res, o)
 224             {
 225                 Roo.docs.ViewSource.show({
 226                         source : res.responseText,
 227                         fname : this.currentClass.replace(/\./g,'/') + ".js"
 228                 });
 229
 230             },
 231             scope : this
 232         });
 233
 234
 235     },
 236
 237     loadDoc : function(cls)
 238     {
 239         if (this.currentClass == cls.name) {
 240             return;
 241         }
 242         //Roo.docs.mobileNavGroup.hide();
 243         Roo.log("loadDoc?");
 244         Roo.docs.doc_body_content.hide();
 245         Roo.docs.navHeaderBar.collapse();
 246         this.currentClass = cls.name;
 247         if (!cls ) {
 248             Roo.docs.introBody.show();
 249             return;
 250         }
 251
 252         // expand parents..
 253
 254         var m = cls.parent_menu;
 255         m.show(m.triggerEl,'?', false);
 256         var mp = cls;
 257         while ((mp = mp.parent)) {
 258             m = mp.parent_menu;
 259             m.show(m.triggerEl,'?', false);
 260         }
 261         cls.node.el.scrollIntoView(Roo.docs.sidebar.el,false);
 262         Roo.docs.sidebar.el.select('.active').removeClass('active');
 263         cls.node.el.addClass('active');
 264
 265         Roo.docs.introBody.hide();
 266         Roo.docs.doc_body_content.show();
 267         Roo.Ajax.request({
 268             url : this.prefix + 'symbols/' + cls.name + '.json',
 269             method : 'GET',
 270             success : function(res, o)
 271             {
 272
 273                 var d = Roo.decode(res.responseText);
 274
 275                 if (typeof(d.augments) == 'undefined') {
 276                     d.augments = [];
 277                     d.config = []; // props for ctor?
 278                     d.isFlutter  = true;
 279                     this.fillAugments(d, Roo.docs.init.fillDoc);
 280                     return;
 281                 }
 282                 this.fillDoc(d);
 283
 284
 285
 286             },
 287             scope : this
 288         });
 289
 290     },
 291     fillAugments : function(d, cb)
 292     {
 293         if (!d.extends.lenght) {
 294             cb(d)
 295         }
 296         d.augments.push(d.extends);
 297         Roo.Ajax.request({
 298             url : this.prefix + 'symbols/' + d.extends + '.json',
 299             method : 'GET',
 300             success : function(res, o)
 301             {
 302
 303                 var r = Roo.decode(res.responseText);
 304                 // copy methods that are not constructors..
 305                 r.methods.forEach(function(m) {
 306                     if (m.isConstructor || m.static) {
 307                         return;
 308                     }
 309                     d.methods.push(m);
 310                 });
 311
 312                 r.props.forEach(function(m) {
 313                     if (m.isConstant) {
 314                         return;
 315                     }
 316                     d.props.push(m);
 317                 });
 318
 319                 r.events.forEach(function(m) {
 320
 321                     d.events.push(m);
 322                 });
 323
 324             },
 325             scope : this
 326         });
 327
 328     },
 329
 330
 331
 332     fillDoc : function(d)
 333     {
 334         /*{
 335             "name" : "Roo.bootstrap.Progress",
 336             "augments" : [
 337               "Roo.bootstrap.Component",
 338               "Roo.Component",
 339               "Roo.util.Observable"
 340             ],
 341             "desc" : "Bootstrap Progress class",
 342             "config" : [
 343               {
 344         */
 345         document.body.scrollTop  = 0;
 346         Roo.docs.doc_name.el.dom.innerHTML = Roo.docs.template.resolveLinks(d.name);
 347         Roo.docs.doc_desc.el.dom.innerHTML = Roo.docs.template.summary(d);
 348         Roo.docs.doc_extends.hide();
 349         Roo.docs.doc_extends_sep.hide();
 350         if (d.augments.length) {
 351             Roo.docs.doc_extends.show();
 352             Roo.docs.doc_extends_sep.show();
 353             Roo.docs.doc_extends.el.dom.innerHTML = d.augments[0];
 354         }
 355         Roo.docs.doc_source.el.dom.innerHTML = d.name.replace(/\./g,"/") + ".js";
 356
 357         if (d.augments.length) {
 358             Roo.docs.augments.show();
 359             Roo.docs.augments.bodyEl().dom.innerHTML = Roo.docs.template.augments(d);
 360         } else {
 361             Roo.docs.augments.hide();
 362         }
 363
 364
 365
 366         Roo.docs.configTableContainer.hide();
 367         Roo.docs.methodsTableContainer.hide();
 368         Roo.docs.eventsTableContainer.hide();
 369         if (d.config.length) {
 370             Roo.docs.configTableContainer.show();
 371             Roo.docs.configTable.store.load( { params : { data : d.config.sort(Roo.docs.template.makeSortby("name")) }});
 372         }
 373
 374         if (d.methods.length) {
 375             Roo.docs.methodsTable.store.load( { params : { data : Roo.docs.template.methodsSort(d) }});
 376             Roo.docs.methodsTableContainer.show();
 377         }
 378         if (d.events.length) {
 379             Roo.docs.eventsTable.store.load( { params : { data : d.events.sort(Roo.docs.template.makeSortby("name")) }});
 380             Roo.docs.eventsTableContainer.show();
 381         }
 382
 383
 384     },
 385     onClick : function(e)
 386     {
 387         if (e.target.nodeName != 'A') {
 388             return;
 389         }
 390         if (!e.target.href.match(/#/)) {
 391             return;
 392         }
 393         e.stopPropagation();
 394         var link = e.target.href.split('#')[1];
 395         this.loadClass(link);
 396
 397     },
 398
 399     onHashChange : function()
 400     {
 401         if (this.hash == location.hash) {
 402             return;
 403         }
 404         this.loadHash();
 405
 406     },
 407     loadHash : function()
 408     {
 409         if (location.hash.length < 2) {
 410             this.loadDoc(false);
 411         }
 412         this.loadClass(location.hash.substring(1));
 413         this.hash = location.hash;
 414     },
 415
 416
 417     loadIntro : function()
 418     {
 419
 420
 421         Roo.Ajax.request({
 422             url : 'summary.txt',
 423             method : 'GET',
 424             success : function(res)
 425             {
 426                 this.renderIntro(res.responseText);
 427
 428
 429             },
 430             scope : this
 431         });
 432
 433
 434     },
 435     // render the really simple markdown data
 436     renderIntro : function(intro)
 437     {
 438
 439         Roo.docs.doc_body_content.hide();
 440
 441
 442         var lines = intro.split("\n");
 443         var tree = { 'name' : 'root', cn : []};
 444         var state = [ tree ];
 445         for (var i=0;i< lines.length;i++) {
 446             var line = lines[i];
 447             if (!line.length || line.match(/^\s+$/)) {
 448                 continue;
 449             }
 450             var sm = line.match(/^(\s+)(.*)/);
 451
 452             var sml = sm ? sm[1].length: 0;
 453             //Roo.log(sml);
 454             sml = sml / 4; // 4 spaces indent?
 455             var add = { name : sm ?  sm[2] : line, cn : [] };
 456             state[sml].cn.push(add);
 457             state[sml+1] = add;
 458
 459         }
 460         //Roo.log(tree);
 461
 462         for(var i = 0; i < tree.cn.length; i++) {
 463             // make a container..
 464             var treei = tree.cn[i];
 465             var ctree = {
 466
 467                 xtype : 'Column',
 468                 xns : Roo.bootstrap,
 469                 md:4,
 470                 sm : 6,
 471                 items : [ {
 472                     header : treei.name,
 473                     xtype : 'Container',
 474                     panel : 'info',
 475                     xns : Roo.bootstrap,
 476                     items : []
 477                 }]
 478             };
 479             for(var ii = 0; ii < treei.cn.length; ii++) {
 480                 var treeii = treei.cn[ii];
 481                 // another container..
 482                var ctreei = {
 483                     header : treeii.name,
 484                     xtype : 'Container',
 485                     panel : 'primary',
 486                     xns : Roo.bootstrap,
 487
 488                     items : [
 489                          {
 490                             xtype : 'Element',
 491                             tag :'ul',
 492
 493                             xns : Roo.bootstrap,
 494                             items : []
 495                          }
 496                     ]
 497                 };
 498                 ctree.items[0].items.push(ctreei);
 499                 var footer = '';
 500                 for(var iii = 0; iii < treeii.cn.length; iii++) {
 501                     var treeiii = treeii.cn[iii];
 502                     var ll = treeiii.name.match(/^(\S+)\s*(.*)$/);
 503                     //Roo.log(treeiii.name);
 504                     if (treeiii.name == 'Examples') {
 505                         for (var j =0;j< treeiii.cn.length; j++) {
 506                             var exs = treeiii.cn[j].name.match(/^\[([^\]]+)\](.*)$/);
 507                             footer += '<li><a target="_blank" href="../' + exs[1] + '">'+exs[2] + '</a></li>';
 508                         }
 509                         continue;
 510
 511
 512                     }
 513
 514
 515
 516                     ctreeii = {
 517                             xtype : 'Element',
 518                             tag :'li',
 519                             xns : Roo.bootstrap,
 520                             items : [
 521                                 {
 522                                    xtype : 'Link',
 523                                     href : '#' + ( ll ? ll[1] : treeiii.name ) ,
 524                                     html : ll ? ll[1] : treeiii.name,
 525
 526                                     xns : Roo.bootstrap
 527                                 },
 528                                 {
 529                                    xtype : 'Element',
 530                                     tag : 'span',
 531                                     html : ll && ll[2].length ? ' - ' + ll[2] : '',
 532                                     xns : Roo.bootstrap
 533                                 }
 534                             ]
 535
 536
 537
 538                     };
 539                     ctreei.items.push(ctreeii);
 540
 541                 }
 542                 if (footer.length) {
 543                     //Roo.log("footer:"+  footer);
 544                     ctreei.footer = '<h5>Examples:</h5><ul>'+footer +'</ul>';
 545                 }
 546
 547             }
 548
 549
 550
 551
 552
 553             Roo.docs.introBody.addxtypeChild(ctree);
 554         }
 555
 556
 557
 558     }
 559
 560
 561
 562 };
 563
 564
 565 Roo.onReady(Roo.docs.init.onReady, Roo.docs.init);
 566
 567