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.length) {
 294             cb(d)
 295         }
 296         d.augments.push(d.extends);
 297         var ax = new new Roo.data.Connection();
 298         ax.request({
 299             url : this.prefix + 'symbols/' + d.extends + '.json',
 300             method : 'GET',
 301             success : function(res, o)
 302             {
 303
 304                 var r = Roo.decode(res.responseText);
 305                 // copy methods that are not constructors..
 306                 r.methods.forEach(function(m) {
 307                     if (m.isConstructor || m.static) {
 308                         return;
 309                     }
 310                     d.methods.push(m);
 311                 });
 312
 313                 r.props.forEach(function(m) {
 314                     if (m.isConstant) {
 315                         return;
 316                     }
 317                     d.props.push(m);
 318                 });
 319
 320                 r.events.forEach(function(m) {
 321
 322                     d.events.push(m);
 323                 });
 324
 325             },
 326             scope : this
 327         });
 328
 329     },
 330
 331
 332
 333     fillDoc : function(d)
 334     {
 335         /*{
 336             "name" : "Roo.bootstrap.Progress",
 337             "augments" : [
 338               "Roo.bootstrap.Component",
 339               "Roo.Component",
 340               "Roo.util.Observable"
 341             ],
 342             "desc" : "Bootstrap Progress class",
 343             "config" : [
 344               {
 345         */
 346         document.body.scrollTop  = 0;
 347         Roo.docs.doc_name.el.dom.innerHTML = Roo.docs.template.resolveLinks(d.name);
 348         Roo.docs.doc_desc.el.dom.innerHTML = Roo.docs.template.summary(d);
 349         Roo.docs.doc_extends.hide();
 350         Roo.docs.doc_extends_sep.hide();
 351         if (d.augments.length) {
 352             Roo.docs.doc_extends.show();
 353             Roo.docs.doc_extends_sep.show();
 354             Roo.docs.doc_extends.el.dom.innerHTML = d.augments[0];
 355         }
 356         Roo.docs.doc_source.el.dom.innerHTML = d.name.replace(/\./g,"/") + ".js";
 357
 358         if (d.augments.length) {
 359             Roo.docs.augments.show();
 360             Roo.docs.augments.bodyEl().dom.innerHTML = Roo.docs.template.augments(d);
 361         } else {
 362             Roo.docs.augments.hide();
 363         }
 364
 365
 366
 367         Roo.docs.configTableContainer.hide();
 368         Roo.docs.methodsTableContainer.hide();
 369         Roo.docs.eventsTableContainer.hide();
 370         if (d.config.length) {
 371             Roo.docs.configTableContainer.show();
 372             Roo.docs.configTable.store.load( { params : { data : d.config.sort(Roo.docs.template.makeSortby("name")) }});
 373         }
 374
 375         if (d.methods.length) {
 376             Roo.docs.methodsTable.store.load( { params : { data : Roo.docs.template.methodsSort(d) }});
 377             Roo.docs.methodsTableContainer.show();
 378         }
 379         if (d.events.length) {
 380             Roo.docs.eventsTable.store.load( { params : { data : d.events.sort(Roo.docs.template.makeSortby("name")) }});
 381             Roo.docs.eventsTableContainer.show();
 382         }
 383
 384
 385     },
 386     onClick : function(e)
 387     {
 388         if (e.target.nodeName != 'A') {
 389             return;
 390         }
 391         if (!e.target.href.match(/#/)) {
 392             return;
 393         }
 394         e.stopPropagation();
 395         var link = e.target.href.split('#')[1];
 396         this.loadClass(link);
 397
 398     },
 399
 400     onHashChange : function()
 401     {
 402         if (this.hash == location.hash) {
 403             return;
 404         }
 405         this.loadHash();
 406
 407     },
 408     loadHash : function()
 409     {
 410         if (location.hash.length < 2) {
 411             this.loadDoc(false);
 412         }
 413         this.loadClass(location.hash.substring(1));
 414         this.hash = location.hash;
 415     },
 416
 417
 418     loadIntro : function()
 419     {
 420
 421
 422         Roo.Ajax.request({
 423             url : 'summary.txt',
 424             method : 'GET',
 425             success : function(res)
 426             {
 427                 this.renderIntro(res.responseText);
 428
 429
 430             },
 431             scope : this
 432         });
 433
 434
 435     },
 436     // render the really simple markdown data
 437     renderIntro : function(intro)
 438     {
 439
 440         Roo.docs.doc_body_content.hide();
 441
 442
 443         var lines = intro.split("\n");
 444         var tree = { 'name' : 'root', cn : []};
 445         var state = [ tree ];
 446         for (var i=0;i< lines.length;i++) {
 447             var line = lines[i];
 448             if (!line.length || line.match(/^\s+$/)) {
 449                 continue;
 450             }
 451             var sm = line.match(/^(\s+)(.*)/);
 452
 453             var sml = sm ? sm[1].length: 0;
 454             //Roo.log(sml);
 455             sml = sml / 4; // 4 spaces indent?
 456             var add = { name : sm ?  sm[2] : line, cn : [] };
 457             state[sml].cn.push(add);
 458             state[sml+1] = add;
 459
 460         }
 461         //Roo.log(tree);
 462
 463         for(var i = 0; i < tree.cn.length; i++) {
 464             // make a container..
 465             var treei = tree.cn[i];
 466             var ctree = {
 467
 468                 xtype : 'Column',
 469                 xns : Roo.bootstrap,
 470                 md:4,
 471                 sm : 6,
 472                 items : [ {
 473                     header : treei.name,
 474                     xtype : 'Container',
 475                     panel : 'info',
 476                     xns : Roo.bootstrap,
 477                     items : []
 478                 }]
 479             };
 480             for(var ii = 0; ii < treei.cn.length; ii++) {
 481                 var treeii = treei.cn[ii];
 482                 // another container..
 483                var ctreei = {
 484                     header : treeii.name,
 485                     xtype : 'Container',
 486                     panel : 'primary',
 487                     xns : Roo.bootstrap,
 488
 489                     items : [
 490                          {
 491                             xtype : 'Element',
 492                             tag :'ul',
 493
 494                             xns : Roo.bootstrap,
 495                             items : []
 496                          }
 497                     ]
 498                 };
 499                 ctree.items[0].items.push(ctreei);
 500                 var footer = '';
 501                 for(var iii = 0; iii < treeii.cn.length; iii++) {
 502                     var treeiii = treeii.cn[iii];
 503                     var ll = treeiii.name.match(/^(\S+)\s*(.*)$/);
 504                     //Roo.log(treeiii.name);
 505                     if (treeiii.name == 'Examples') {
 506                         for (var j =0;j< treeiii.cn.length; j++) {
 507                             var exs = treeiii.cn[j].name.match(/^\[([^\]]+)\](.*)$/);
 508                             footer += '<li><a target="_blank" href="../' + exs[1] + '">'+exs[2] + '</a></li>';
 509                         }
 510                         continue;
 511
 512
 513                     }
 514
 515
 516
 517                     ctreeii = {
 518                             xtype : 'Element',
 519                             tag :'li',
 520                             xns : Roo.bootstrap,
 521                             items : [
 522                                 {
 523                                    xtype : 'Link',
 524                                     href : '#' + ( ll ? ll[1] : treeiii.name ) ,
 525                                     html : ll ? ll[1] : treeiii.name,
 526
 527                                     xns : Roo.bootstrap
 528                                 },
 529                                 {
 530                                    xtype : 'Element',
 531                                     tag : 'span',
 532                                     html : ll && ll[2].length ? ' - ' + ll[2] : '',
 533                                     xns : Roo.bootstrap
 534                                 }
 535                             ]
 536
 537
 538
 539                     };
 540                     ctreei.items.push(ctreeii);
 541
 542                 }
 543                 if (footer.length) {
 544                     //Roo.log("footer:"+  footer);
 545                     ctreei.footer = '<h5>Examples:</h5><ul>'+footer +'</ul>';
 546                 }
 547
 548             }
 549
 550
 551
 552
 553
 554             Roo.docs.introBody.addxtypeChild(ctree);
 555         }
 556
 557
 558
 559     }
 560
 561
 562
 563 };
 564
 565
 566 Roo.onReady(Roo.docs.init.onReady, Roo.docs.init);
 567
 568