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