2923083e4739c63cbc45c998c6a8294be0562c63
[roojs1] / docs / Roo.docs.js
1 //<script type="text/javascript">
2
3 // Auto generated file - created by app.Builder.js- do not edit directly (at present!)
4
5 Roo.namespace('Roo');
6
7 Roo.docs = new Roo.XComponent({
8
9  _strings : {
10   '3e6ec55e2dff4342e3f25b0b0b988de9' :"Inheritance tree",
11   'ae635f08107a69569e636835f24e6f6f' :" extends ",
12   '87f9f735a1d36793ceaecd4e47124b63' :"Events",
13   'd41d8cd98f00b204e9800998ecf8427e' :"",
14   '9b34238e8113db140b452beec500024b' :"Roo JS Documentation",
15   '50f33d14f129e4548c1c270fd6725a78' :"Configuration options",
16   'e64b94523532dbac62df6795a5153f04' :"doc-desc",
17   '3673e725413179fe76f341ed908a5c36' :"Defined in: ",
18   'd2b697ad8e989a6c4592987f22f5bbfc' :"doc-comments",
19   'f361257612a512f9be2fdc2abfb25aef' :"<small>Defined by</small>",
20   '494a64a432ff6a121e4ab9003c7a0df3' :"parentcls",
21   'f561aaf6ef0bf14d4208bb46a4ccb3ad' :"xxx",
22   '9bd81329febf6efe22788e03ddeaf0af' :" Class ",
23   'a1d108496af420635536a4e29e87d42b' :"Constructor, Static and Public Methods",
24   'd41d8cd98f00b204e9800998ecf8427e' :" "
25  },
26
27   part     :  ["docs", "docs" ],
28   order    : '001-Roo.docs',
29   region   : 'center',
30   parent   : false,
31   name     : "unnamed module",
32   disabled : false, 
33   permname : '', 
34   _tree : function(_data)
35   {
36    var _this = this;
37    var MODULE = this;
38    return {
39    xtype : 'Body',
40    cls : 'doc-body',
41    listeners : {
42     render : function (_self)
43      {
44            
45         
46          
47      }
48    },
49    xns : Roo.bootstrap,
50    '|xns' : 'Roo.bootstrap',
51    items  : [
52     {
53      xtype : 'NavSidebar',
54      cls : 'left-menu-sidebar',
55      style : 'padding-top:80px;',
56      listeners : {
57       render : function (_self)
58        {
59          _this.sidebar = this;
60          //  this.el.addClass(language);
61            
62        }
63      },
64      xns : Roo.bootstrap,
65      '|xns' : 'Roo.bootstrap',
66      items  : [
67       {
68        xtype : 'NavGroup',
69        activeLookup : function() 
70        { 
71            return;
72            
73            var pathname = window.location.pathname.substring(baseURL.length);
74            
75            if(!pathname.length){
76                return;
77            }
78            
79            if(pathname.match(/^\/Projects/)){
80                pathname = '/Projects';
81            }
82            
83            var lookupPath = function(item)
84            {
85                if(typeof(item.href) == 'undefined' || !item.href.length || item.href == '#'){
86                    return true;
87                }
88                
89                item.el.removeClass('active');
90                
91                var href = item.href.substring(baseURL.length);
92                
93                if(href != pathname){
94                    return true;
95                }
96                
97                item.el.addClass('active');
98                return false;
99                    
100            };
101            
102            var seted = false;
103            
104            Roo.each(_this.navGroup.items, function(i){
105                
106                var s = lookupPath(i);
107                
108                if(!s){
109                    return false;
110                }
111                
112                if(typeof(i.menu) == 'undefined' || !i.menu.items.length){
113                    return;
114                }
115                
116                Roo.each(i.menu.items, function(ii){
117                    
118                    var ss = lookupPath(ii);
119                    
120                    if(!ss){
121                        seted = true;
122                        return false;
123                    }
124                    
125                });
126                
127                if(seted){
128                    return false;
129                }
130                
131            });
132        },
133        autoExpand : function() 
134        { 
135            return;
136            
137            _this.menu_expand = false;
138            
139            var lookupMenu = function(menu, index){
140                
141                if(menu.target == pagedata.page.target){
142                    _this.menu_expand = index + 1;
143                    return;
144                }
145                
146                if(!menu.children.length){
147                    return;
148                }
149                
150                Roo.each(menu.children, function(c){
151                    lookupMenu(c, index);
152                });
153                
154            }
155            
156            Roo.each(pagemenus, function(v, k){
157                
158                lookupMenu(v, k);
159                
160            });
161            
162            if(_this.menu_expand === false){
163                return;
164            }
165            
166            if(typeof(_this.navGroup.items[_this.menu_expand].menu) == 'undefined'){
167                return;
168            }
169            
170            _this.navGroup.items[_this.menu_expand].menu.show(_this.navGroup.items[_this.menu_expand].el, false, false);
171            
172        },
173        listeners : {
174         childrenrendered : function (_self)
175          {
176              _this.navGroup.autoExpand();
177              
178              _this.navGroup.activeLookup();
179          },
180         render : function (_self)
181          {
182              _this.navGroup = this;
183              
184          }
185        },
186        xns : Roo.bootstrap,
187        '|xns' : 'Roo.bootstrap',
188        items  : [
189         {
190          xtype : 'NavItem',
191          active : false,
192          cls : '',
193          style : 'position:fixed;top:0;z-Index:1000;',
194          xns : Roo.bootstrap,
195          '|xns' : 'Roo.bootstrap',
196          items  : [
197           {
198            xtype : 'Link',
199            cls : 'logo',
200            href : '#',
201            preventDefault : true,
202            listeners : {
203             click : function (e)
204              {
205                  document.location.hash = '#';
206              }
207            },
208            xns : Roo.bootstrap,
209            '|xns' : 'Roo.bootstrap'
210           }
211          ]
212         }
213        ]
214       },
215       {
216        xtype : 'Container',
217        cls : 'left-menu-sidebar-options',
218        xns : Roo.bootstrap,
219        '|xns' : 'Roo.bootstrap',
220        items  : [
221         {
222          xtype : 'Row',
223          xns : Roo.bootstrap,
224          '|xns' : 'Roo.bootstrap'
225         }
226        ]
227       }
228      ]
229     },
230     {
231      xtype : 'NavHeaderbar',
232      autohide : true,
233      brand : ' ',
234      brand_href : baseURL + '/',
235      cls : 'mobile-header-menu',
236      inverse : false,
237      position : 'fixed-top',
238      style : '',
239      listeners : {
240       beforetoggle : function (_self)
241        {
242            _this.navGroup.autoExpand(); 
243            
244            _this.navGroup.activeLookup();
245            
246            _this.navHeaderBar.mask.show();
247            
248            if(this.el.select('.navbar-collapse',true).first().hasClass('in')){
249                _this.navHeaderBar.mask.hide();
250                return;
251            }
252        },
253       render : function (_self)
254        {
255            return;
256            
257            _this.navHeaderBar = this;
258            
259            this.el.addClass(language); 
260            
261            var body = Roo.select('body', true).first();
262            
263            var mark = {
264                tag: "div",
265                cls:"x-dlg-mask"
266            };
267            
268            this.mask = Roo.DomHelper.append(body, mark, true);
269            
270            var size = body.getSize();
271            this.mask.setSize(size.width, size.height);
272            
273            this.mask.setStyle('z-index', '1029');
274            
275            this.mask.enableDisplayMode("block");
276            this.mask.hide();
277            
278            this.mask.on('click', function(){
279                
280                this.el.select('.navbar-collapse',true).removeClass('in'); 
281                this.mask.hide();
282                
283            }, this);
284            
285            
286            var maxHeight = Roo.lib.Dom.getViewHeight() - this.el.select('.navbar-header', true).first().getHeight();
287            
288            this.el.select('.navbar-collapse', true).first().setStyle('max-height', maxHeight);
289            
290        }
291      },
292      xns : Roo.bootstrap,
293      '|xns' : 'Roo.bootstrap'
294     },
295     {
296      xtype : 'Container',
297      cls : 'general-content-body',
298      listeners : {
299       render : function (_self)
300        {
301               _this.introContainer = this;
302        }
303      },
304      xns : Roo.bootstrap,
305      '|xns' : 'Roo.bootstrap',
306      items  : [
307       {
308        xtype : 'Header',
309        html : _this._strings['9b34238e8113db140b452beec500024b'] /* Roo JS Documentation */,
310        level : 1,
311        xns : Roo.bootstrap,
312        '|xns' : 'Roo.bootstrap'
313       },
314       {
315        xtype : 'Container',
316        listeners : {
317         render : function (_self)
318          {
319              _this.introBody = this;
320          }
321        },
322        xns : Roo.bootstrap,
323        '|xns' : 'Roo.bootstrap'
324       }
325      ]
326     },
327     {
328      xtype : 'Container',
329      cls : 'general-content-body',
330      listeners : {
331       render : function (_self)
332        {
333            _this.doc_body_content = this;
334        }
335      },
336      xns : Roo.bootstrap,
337      '|xns' : 'Roo.bootstrap',
338      items  : [
339       {
340        xtype : 'Row',
341        style : 'margin: 0px;',
342        xns : Roo.bootstrap,
343        '|xns' : 'Roo.bootstrap',
344        items  : [
345         {
346          xtype : 'Column',
347          md : 9,
348          style : 'padding-left: 0px;',
349          xns : Roo.bootstrap,
350          '|xns' : 'Roo.bootstrap',
351          items  : [
352           {
353            xtype : 'Container',
354            cls : 'doc-header-container',
355            xns : Roo.bootstrap,
356            '|xns' : 'Roo.bootstrap',
357            items  : [
358             {
359              xtype : 'Header',
360              html : _this._strings['9bd81329febf6efe22788e03ddeaf0af'] /*  Class  */,
361              level : 4,
362              xns : Roo.bootstrap,
363              '|xns' : 'Roo.bootstrap',
364              items  : [
365               {
366                xtype : 'Element',
367                cls : 'doc-classname',
368                html : _this._strings['f561aaf6ef0bf14d4208bb46a4ccb3ad'] /* xxx */,
369                style : 'font-size: 24px;\n    font-weight: bold;',
370                tag : 'span',
371                listeners : {
372                 render : function (_self)
373                  {
374                      _this.doc_name = this
375                  }
376                },
377                xns : Roo.bootstrap,
378                '|xns' : 'Roo.bootstrap'
379               },
380               {
381                xtype : 'Element',
382                cls : 'doc-extends-str',
383                html : _this._strings['ae635f08107a69569e636835f24e6f6f'] /*  extends  */,
384                tag : 'small',
385                listeners : {
386                 render : function (_self)
387                  {
388                      _this.doc_extends_sep = this;
389                  }
390                },
391                xns : Roo.bootstrap,
392                '|xns' : 'Roo.bootstrap',
393                items  : [
394                 {
395                  xtype : 'Link',
396                  cls : 'doc-extends',
397                  html : _this._strings['494a64a432ff6a121e4ab9003c7a0df3'] /* parentcls */,
398                  preventDefault : true,
399                  listeners : {
400                   click : function (e)
401                    {
402                    
403                        if (this.el.dom.innerHTML.length) {
404                            document.location.hash = '#' +  this.el.dom.innerHTML;
405                          
406                        } 
407                    },
408                   render : function (_self)
409                    {
410                        _this.doc_extends = this;
411                    }
412                  },
413                  xns : Roo.bootstrap,
414                  '|xns' : 'Roo.bootstrap'
415                 }
416                ]
417               }
418              ]
419             },
420             {
421              xtype : 'Header',
422              html : _this._strings['3673e725413179fe76f341ed908a5c36'] /* Defined in:  */,
423              level : 5,
424              xns : Roo.bootstrap,
425              '|xns' : 'Roo.bootstrap',
426              items  : [
427               {
428                xtype : 'Link',
429                cls : 'doc-source',
430                href : '#',
431                html : _this._strings['3673e725413179fe76f341ed908a5c36'] /* Defined in:  */,
432                preventDefault : true,
433                listeners : {
434                 click : function (e)
435                  {
436                      
437                      Roo.log(["click", this]);
438                      if (this.el.dom.innerHTML.length > 0) {
439                          Roo.docs.init.loadSource();
440                      }
441                  },
442                 render : function (_self)
443                  {
444                      _this.doc_source = this;
445                  }
446                },
447                xns : Roo.bootstrap,
448                '|xns' : 'Roo.bootstrap'
449               }
450              ]
451             }
452            ]
453           },
454           {
455            xtype : 'Container',
456            cls : 'doc-desc',
457            html : _this._strings['e64b94523532dbac62df6795a5153f04'] /* doc-desc */,
458            listeners : {
459             render : function (_self)
460              {
461                  _this.doc_desc = this;
462              }
463            },
464            xns : Roo.bootstrap,
465            '|xns' : 'Roo.bootstrap'
466           },
467           {
468            xtype : 'Container',
469            cls : 'doc-comments',
470            hidden : true,
471            html : _this._strings['d2b697ad8e989a6c4592987f22f5bbfc'] /* doc-comments */,
472            xns : Roo.bootstrap,
473            '|xns' : 'Roo.bootstrap'
474           }
475          ]
476         },
477         {
478          xtype : 'Column',
479          md : 3,
480          xns : Roo.bootstrap,
481          '|xns' : 'Roo.bootstrap',
482          items  : [
483           {
484            xtype : 'Container',
485            cls : 'doc-augments',
486            header : _this._strings['3e6ec55e2dff4342e3f25b0b0b988de9'] /* Inheritance tree */,
487            panel : 'primary',
488            listeners : {
489             render : function (_self)
490              {
491                  _this.augments  = this;
492              }
493            },
494            xns : Roo.bootstrap,
495            '|xns' : 'Roo.bootstrap'
496           }
497          ]
498         }
499        ]
500       },
501       {
502        xtype : 'Container',
503        cls : 'doc-table-container',
504        expandable : true,
505        expanded : true,
506        header : _this._strings['50f33d14f129e4548c1c270fd6725a78'] /* Configuration options */,
507        panel : 'primary',
508        style : 'margin-top:15px',
509        listeners : {
510         render : function (_self)
511          {
512              _this.configTableContainer = this;
513          }
514        },
515        xns : Roo.bootstrap,
516        '|xns' : 'Roo.bootstrap',
517        items  : [
518         {
519          xtype : 'Table',
520          rowSelection : true,
521          striped : true,
522          listeners : {
523           render : function (_self)
524            {
525                _this.configTable = this;
526            },
527           rowclass : function (_self, rowcfg)
528            {
529                  rc = rowcfg.record.json.memberOf == Roo.docs.init.currentClass ? 'doc-added-member '  : 'doc-not-member ';
530                  rowcfg.rowClass = rc + (rowcfg.record.json.expanded ? 'expanded' : '');
531            },
532           rowclick : function (_self, el, rowIndex, e)
533            {
534                if (e.target.className != 'fixedFont' && e.target.parentNode.className != 'fixedFont') {
535                    return false;
536                }
537                
538                var r = this.store.getAt(rowIndex);
539                r.json.expanded = !r.json.expanded ;
540                this.refreshRow(r);
541            }
542          },
543          xns : Roo.bootstrap,
544          '|xns' : 'Roo.bootstrap',
545          store : {
546           xtype : 'Store',
547           xns : Roo.data,
548           '|xns' : 'Roo.data',
549           proxy : {
550            xtype : 'MemoryProxy',
551            xns : Roo.data,
552            '|xns' : 'Roo.data'
553           },
554           reader : {
555            xtype : 'ArrayReader',
556            fields : [ 'name', 'type', 'desc', 'memberOf' ],
557            xns : Roo.data,
558            '|xns' : 'Roo.data'
559           }
560          },
561          cm : [
562           {
563            xtype : 'ColumnModel',
564            dataIndex : 'name',
565            header : _this._strings['d41d8cd98f00b204e9800998ecf8427e'] /*  */,
566            md : 11,
567            renderer : function(v,x,r) { 
568            
569                return Roo.docs.template.config(r.json);
570            
571                                 
572            },
573            xns : Roo.grid,
574            '|xns' : 'Roo.grid'
575           },
576           {
577            xtype : 'ColumnModel',
578            dataIndex : 'memberOf',
579            header : _this._strings['f361257612a512f9be2fdc2abfb25aef'] /* <small>Defined by</small> */,
580            md : 1,
581            renderer : function(v,x,r) { 
582             if (r.json.memberOf  == Roo.docs.init.currentClass) {
583                        return '';
584                    }
585            
586                         return  '<small><a href="#' + r.json.memberOf + '">' + r.json.memberOf + '</a></small>';
587                                 
588            },
589            xns : Roo.grid,
590            '|xns' : 'Roo.grid'
591           }
592          ]
593         }
594        ]
595       },
596       {
597        xtype : 'Container',
598        cls : 'doc-table-container',
599        expandable : true,
600        expanded : true,
601        header : _this._strings['a1d108496af420635536a4e29e87d42b'] /* Constructor, Static and Public Methods */,
602        panel : 'primary',
603        listeners : {
604         render : function (_self)
605          {
606              _this.methodsTableContainer = this;
607          }
608        },
609        xns : Roo.bootstrap,
610        '|xns' : 'Roo.bootstrap',
611        items  : [
612         {
613          xtype : 'Table',
614          rowSelection : true,
615          listeners : {
616           render : function (_self)
617            {
618                _this.methodsTable = this;
619            },
620           rowclass : function (_self, rowcfg)
621            {
622                  var j = rowcfg.record.json;
623                  var rc = j.memberOf == Roo.docs.init.currentClass || j.isConstructor ? 'doc-added-member '  : 'doc-not-member ';
624                  rowcfg.rowClass = rc + (rowcfg.record.json.expanded ? 'expanded' : '');
625            },
626           rowclick : function (_self, el, rowIndex, e)
627            {
628                  if (e.target.className != 'fixedFont' && e.target.parentNode.className != 'fixedFont') {
629                    return false;
630                }
631                 var r = this.store.getAt(rowIndex);
632                r.json.expanded = !r.json.expanded ;
633                this.refreshRow(r);
634            }
635          },
636          xns : Roo.bootstrap,
637          '|xns' : 'Roo.bootstrap',
638          store : {
639           xtype : 'Store',
640           sortInfo : { field : 'name', direction : 'ASC' },
641           xns : Roo.data,
642           '|xns' : 'Roo.data',
643           proxy : {
644            xtype : 'MemoryProxy',
645            xns : Roo.data,
646            '|xns' : 'Roo.data'
647           },
648           reader : {
649            xtype : 'ArrayReader',
650            fields : [ 'name', 'type', 'desc', 'memberOf' ],
651            xns : Roo.data,
652            '|xns' : 'Roo.data'
653           }
654          },
655          cm : [
656           {
657            xtype : 'ColumnModel',
658            dataIndex : 'name',
659            header : _this._strings['d41d8cd98f00b204e9800998ecf8427e'] /*   */,
660            md : 11,
661            renderer : function(v,x,r) { 
662            
663                return Roo.docs.template.method(r.json);
664                          
665                                 
666            },
667            sortable : false,
668            xns : Roo.grid,
669            '|xns' : 'Roo.grid'
670           },
671           {
672            xtype : 'ColumnModel',
673            dataIndex : 'memberOf',
674            header : _this._strings['f361257612a512f9be2fdc2abfb25aef'] /* <small>Defined by</small> */,
675            md : 1,
676            renderer : function(v,x,r) { 
677            
678             if (r.json.memberOf  == Roo.docs.init.currentClass) {
679                        return '';
680                    }
681                         return  '<small><a href="#' + r.json.memberOf + '">' + r.json.memberOf + '</a></small>';
682                                 
683            },
684            xns : Roo.grid,
685            '|xns' : 'Roo.grid'
686           }
687          ]
688         }
689        ]
690       },
691       {
692        xtype : 'Container',
693        cls : 'doc-table-container',
694        expandable : true,
695        expanded : true,
696        header : _this._strings['87f9f735a1d36793ceaecd4e47124b63'] /* Events */,
697        panel : 'primary',
698        listeners : {
699         render : function (_self)
700          {
701              _this.eventsTableContainer   = this;
702          }
703        },
704        xns : Roo.bootstrap,
705        '|xns' : 'Roo.bootstrap',
706        items  : [
707         {
708          xtype : 'Table',
709          rowSelection : true,
710          listeners : {
711           render : function (_self)
712            {
713                _this.eventsTable = this;
714            },
715           rowclass : function (_self, rowcfg)
716            {
717                  rc = rowcfg.record.json.memberOf == Roo.docs.init.currentClass ? 'doc-added-member '  : 'doc-not-member ';
718                  rowcfg.rowClass = rc + (rowcfg.record.json.expanded ? 'expanded' : '');
719            },
720           rowclick : function (_self, el, rowIndex, e)
721            {
722                    if (e.target.className != 'fixedFont' && e.target.parentNode.className != 'fixedFont') {
723                    return false;
724                }
725                var r = this.store.getAt(rowIndex);
726                r.json.expanded = !r.json.expanded ;
727                this.refreshRow(r);
728            }
729          },
730          xns : Roo.bootstrap,
731          '|xns' : 'Roo.bootstrap',
732          store : {
733           xtype : 'Store',
734           xns : Roo.data,
735           '|xns' : 'Roo.data',
736           proxy : {
737            xtype : 'MemoryProxy',
738            xns : Roo.data,
739            '|xns' : 'Roo.data'
740           },
741           reader : {
742            xtype : 'ArrayReader',
743            fields : [ 'name', 'type', 'desc', 'memberOf' ],
744            xns : Roo.data,
745            '|xns' : 'Roo.data'
746           }
747          },
748          cm : [
749           {
750            xtype : 'ColumnModel',
751            dataIndex : 'name',
752            header : _this._strings['d41d8cd98f00b204e9800998ecf8427e'] /*  */,
753            md : 11,
754            renderer : function(v,x,r) { 
755            
756                return Roo.docs.template.event(r.json);
757                          
758                                 
759            },
760            xns : Roo.grid,
761            '|xns' : 'Roo.grid'
762           },
763           {
764            xtype : 'ColumnModel',
765            dataIndex : 'memberOf',
766            header : _this._strings['f361257612a512f9be2fdc2abfb25aef'] /* <small>Defined by</small> */,
767            md : 1,
768            renderer : function(v,x,r) { 
769                    if (r.json.memberOf  == Roo.docs.init.currentClass) {
770                        return '';
771                    }
772            
773                         return  '<small><a href="#' + r.json.memberOf + '">' + r.json.memberOf + '</a></small>';
774                                 
775            },
776            xns : Roo.grid,
777            '|xns' : 'Roo.grid'
778           }
779          ]
780         }
781        ]
782       }
783      ]
784     }
785    ]
786   };  }
787 });