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