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