Fix #5665 - pre-commit hooks for roojs
[roojs1] / docs / symbols / Roo.TabPanel.json
1 {
2   "name" : "Roo.TabPanel",
3   "augments" : [
4     "Roo.util.Observable"
5   ],
6   "desc" : "A lightweight tab container.\n<br><br>\nUsage:\n<pre><code>\n// basic tabs 1, built from existing content\nvar tabs = new Roo.TabPanel(\"tabs1\");\ntabs.addTab(\"script\", \"View Script\");\ntabs.addTab(\"markup\", \"View Markup\");\ntabs.activate(\"script\");\n\n// more advanced tabs, built from javascript\nvar jtabs = new Roo.TabPanel(\"jtabs\");\njtabs.addTab(\"jtabs-1\", \"Normal Tab\", \"My content was added during construction.\");\n\n// set up the UpdateManager\nvar tab2 = jtabs.addTab(\"jtabs-2\", \"Ajax Tab 1\");\nvar updater = tab2.getUpdateManager();\nupdater.setDefaultUrl(\"ajax1.htm\");\ntab2.on('activate', updater.refresh, updater, true);\n\n// Use setUrl for Ajax loading\nvar tab3 = jtabs.addTab(\"jtabs-3\", \"Ajax Tab 2\");\ntab3.setUrl(\"ajax2.htm\", null, true);\n\n// Disabled tab\nvar tab4 = jtabs.addTab(\"tabs1-5\", \"Disabled Tab\", \"Can't see me cause I'm disabled\");\ntab4.disable();\n\njtabs.activate(\"jtabs-1\");\n</code></pre>",
7   "isSingleton" : false,
8   "isStatic" : false,
9   "isBuiltin" : false,
10   "memberOf" : "TabPanel",
11   "example" : "",
12   "deprecated" : "",
13   "since" : "",
14   "see" : "",
15   "params" : [
16     {
17       "name" : "container",
18       "type" : "String/HTMLElement/Roo.Element",
19       "desc" : "The id, DOM element or Roo.Element container where this TabPanel is to be rendered.",
20       "isOptional" : false
21     },
22     {
23       "name" : "config",
24       "type" : "Object/Boolean",
25       "desc" : "Config object to set any properties for this TabPanel, or true to render the tabs on the bottom.",
26       "isOptional" : false
27     }
28   ],
29   "returns" : [
30   ],
31   "config" : [
32     {
33       "name" : "listeners",
34       "type" : "Object",
35       "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  </code></pre>",
36       "memberOf" : "Roo.util.Observable",
37       "values" : [
38       ]
39     }
40   ],
41   "methods" : [
42     {
43       "name" : "getActiveTab",
44       "desc" : "Gets the active {@link Roo.TabPanelItem}.",
45       "isStatic" : false,
46       "isConstructor" : false,
47       "isPrivate" : false,
48       "memberOf" : "Roo.TabPanel",
49       "example" : "",
50       "deprecated" : "",
51       "since" : "",
52       "see" : "",
53       "params" : [
54       ],
55       "returns" : [
56         {
57           "name" : "",
58           "type" : "Roo.TabPanelItem",
59           "desc" : "The active TabPanelItem or null if none are active."
60         }
61       ]
62     },
63     {
64       "name" : "beginUpdate",
65       "desc" : "Disables tab resizing while tabs are being added (if {@link #resizeTabs} is false this does nothing)",
66       "isStatic" : false,
67       "isConstructor" : false,
68       "isPrivate" : false,
69       "memberOf" : "Roo.TabPanel",
70       "example" : "",
71       "deprecated" : "",
72       "since" : "",
73       "see" : "",
74       "params" : [
75       ],
76       "returns" : [
77       ]
78     },
79     {
80       "name" : "unhideTab",
81       "desc" : "\"Unhides\" the {@link Roo.TabPanelItem} with the specified id/index.",
82       "isStatic" : false,
83       "isConstructor" : false,
84       "isPrivate" : false,
85       "memberOf" : "Roo.TabPanel",
86       "example" : "",
87       "deprecated" : "",
88       "since" : "",
89       "see" : "",
90       "params" : [
91         {
92           "name" : "id",
93           "type" : "String/Number",
94           "desc" : "The id or index of the TabPanelItem to unhide.",
95           "isOptional" : false
96         }
97       ],
98       "returns" : [
99       ]
100     },
101     {
102       "name" : "enableTab",
103       "desc" : "Enables a {@link Roo.TabPanelItem} that is disabled.",
104       "isStatic" : false,
105       "isConstructor" : false,
106       "isPrivate" : false,
107       "memberOf" : "Roo.TabPanel",
108       "example" : "",
109       "deprecated" : "",
110       "since" : "",
111       "see" : "",
112       "params" : [
113         {
114           "name" : "id",
115           "type" : "String/Number",
116           "desc" : "The id or index of the TabPanelItem to enable.",
117           "isOptional" : false
118         }
119       ],
120       "returns" : [
121       ]
122     },
123     {
124       "name" : "setTabWidth",
125       "desc" : "Resizes all the tabs to the passed width",
126       "isStatic" : false,
127       "isConstructor" : false,
128       "isPrivate" : false,
129       "memberOf" : "Roo.TabPanel",
130       "example" : "",
131       "deprecated" : "",
132       "since" : "",
133       "see" : "",
134       "params" : [
135         {
136           "name" : "The",
137           "type" : "Number",
138           "desc" : "new width",
139           "isOptional" : false
140         }
141       ],
142       "returns" : [
143       ]
144     },
145     {
146       "name" : "endUpdate",
147       "desc" : "Stops an update and resizes the tabs (if {@link #resizeTabs} is false this does nothing)",
148       "isStatic" : false,
149       "isConstructor" : false,
150       "isPrivate" : false,
151       "memberOf" : "Roo.TabPanel",
152       "example" : "",
153       "deprecated" : "",
154       "since" : "",
155       "see" : "",
156       "params" : [
157       ],
158       "returns" : [
159       ]
160     },
161     {
162       "name" : "addTab",
163       "desc" : "Creates a new {@link Roo.TabPanelItem} by looking for an existing element with the provided id -- if it's not found it creates one.",
164       "isStatic" : false,
165       "isConstructor" : false,
166       "isPrivate" : false,
167       "memberOf" : "Roo.TabPanel",
168       "example" : "",
169       "deprecated" : "",
170       "since" : "",
171       "see" : "",
172       "params" : [
173         {
174           "name" : "id",
175           "type" : "String",
176           "desc" : "The id of the div to use <b>or create</b>",
177           "isOptional" : false
178         },
179         {
180           "name" : "text",
181           "type" : "String",
182           "desc" : "The text for the tab",
183           "isOptional" : false
184         },
185         {
186           "name" : "content",
187           "type" : "String",
188           "desc" : "(optional) Content to put in the TabPanelItem body",
189           "isOptional" : false
190         },
191         {
192           "name" : "closable",
193           "type" : "Boolean",
194           "desc" : "(optional) True to create a close icon on the tab",
195           "isOptional" : false
196         }
197       ],
198       "returns" : [
199         {
200           "name" : "",
201           "type" : "Roo.TabPanelItem",
202           "desc" : "The created TabPanelItem"
203         }
204       ]
205     },
206     {
207       "name" : "disableTab",
208       "desc" : "Disables a {@link Roo.TabPanelItem}. It cannot be the active tab, if it is this call is ignored.",
209       "isStatic" : false,
210       "isConstructor" : false,
211       "isPrivate" : false,
212       "memberOf" : "Roo.TabPanel",
213       "example" : "",
214       "deprecated" : "",
215       "since" : "",
216       "see" : "",
217       "params" : [
218         {
219           "name" : "id",
220           "type" : "String/Number",
221           "desc" : "The id or index of the TabPanelItem to disable.",
222           "isOptional" : false
223         }
224       ],
225       "returns" : [
226       ]
227     },
228     {
229       "name" : "destroy",
230       "desc" : "Destroys this TabPanel",
231       "isStatic" : false,
232       "isConstructor" : false,
233       "isPrivate" : false,
234       "memberOf" : "Roo.TabPanel",
235       "example" : "",
236       "deprecated" : "",
237       "since" : "",
238       "see" : "",
239       "params" : [
240         {
241           "name" : "removeEl",
242           "type" : "Boolean",
243           "desc" : "(optional) True to remove the element from the DOM as well (defaults to undefined)",
244           "isOptional" : false
245         }
246       ],
247       "returns" : [
248       ]
249     },
250     {
251       "name" : "getTab",
252       "desc" : "Returns the {@link Roo.TabPanelItem} with the specified id/index",
253       "isStatic" : false,
254       "isConstructor" : false,
255       "isPrivate" : false,
256       "memberOf" : "Roo.TabPanel",
257       "example" : "",
258       "deprecated" : "",
259       "since" : "",
260       "see" : "",
261       "params" : [
262         {
263           "name" : "id",
264           "type" : "String/Number",
265           "desc" : "The id or index of the TabPanelItem to fetch.",
266           "isOptional" : false
267         }
268       ],
269       "returns" : [
270         {
271           "name" : "",
272           "type" : "Roo.TabPanelItem",
273           "desc" : ""
274         }
275       ]
276     },
277     {
278       "name" : "getCount",
279       "desc" : "Returns the number of tabs in this TabPanel.",
280       "isStatic" : false,
281       "isConstructor" : false,
282       "isPrivate" : false,
283       "memberOf" : "Roo.TabPanel",
284       "example" : "",
285       "deprecated" : "",
286       "since" : "",
287       "see" : "",
288       "params" : [
289       ],
290       "returns" : [
291         {
292           "name" : "",
293           "type" : "Number",
294           "desc" : ""
295         }
296       ]
297     },
298     {
299       "name" : "autoSizeTabs",
300       "desc" : "Manual call to resize the tabs (if {@link #resizeTabs} is false this does nothing)",
301       "isStatic" : false,
302       "isConstructor" : false,
303       "isPrivate" : false,
304       "memberOf" : "Roo.TabPanel",
305       "example" : "",
306       "deprecated" : "",
307       "since" : "",
308       "see" : "",
309       "params" : [
310       ],
311       "returns" : [
312       ]
313     },
314     {
315       "name" : "removeTab",
316       "desc" : "Removes a {@link Roo.TabPanelItem}.",
317       "isStatic" : false,
318       "isConstructor" : false,
319       "isPrivate" : false,
320       "memberOf" : "Roo.TabPanel",
321       "example" : "",
322       "deprecated" : "",
323       "since" : "",
324       "see" : "",
325       "params" : [
326         {
327           "name" : "id",
328           "type" : "String/Number",
329           "desc" : "The id or index of the TabPanelItem to remove.",
330           "isOptional" : false
331         }
332       ],
333       "returns" : [
334       ]
335     },
336     {
337       "name" : "activate",
338       "desc" : "Activates a {@link Roo.TabPanelItem}. The currently active one will be deactivated.",
339       "isStatic" : false,
340       "isConstructor" : false,
341       "isPrivate" : false,
342       "memberOf" : "Roo.TabPanel",
343       "example" : "",
344       "deprecated" : "",
345       "since" : "",
346       "see" : "",
347       "params" : [
348         {
349           "name" : "id",
350           "type" : "String/Number",
351           "desc" : "The id or index of the TabPanelItem to activate.",
352           "isOptional" : false
353         }
354       ],
355       "returns" : [
356         {
357           "name" : "",
358           "type" : "Roo.TabPanelItem",
359           "desc" : "The TabPanelItem."
360         }
361       ]
362     },
363     {
364       "name" : "syncHeight",
365       "desc" : "Updates the tab body element to fit the height of the container element\nfor overflow scrolling",
366       "isStatic" : false,
367       "isConstructor" : false,
368       "isPrivate" : false,
369       "memberOf" : "Roo.TabPanel",
370       "example" : "",
371       "deprecated" : "",
372       "since" : "",
373       "see" : "",
374       "params" : [
375         {
376           "name" : "targetHeight",
377           "type" : "Number",
378           "desc" : "(optional) Override the starting height from the elements height",
379           "isOptional" : false
380         }
381       ],
382       "returns" : [
383       ]
384     },
385     {
386       "name" : "addTabItem",
387       "desc" : "Adds an existing {@link Roo.TabPanelItem}.",
388       "isStatic" : false,
389       "isConstructor" : false,
390       "isPrivate" : false,
391       "memberOf" : "Roo.TabPanel",
392       "example" : "",
393       "deprecated" : "",
394       "since" : "",
395       "see" : "",
396       "params" : [
397         {
398           "name" : "item",
399           "type" : "Roo.TabPanelItem",
400           "desc" : "The TabPanelItem to add",
401           "isOptional" : false
402         }
403       ],
404       "returns" : [
405       ]
406     },
407     {
408       "name" : "hideTab",
409       "desc" : "Hides the {@link Roo.TabPanelItem} with the specified id/index",
410       "isStatic" : false,
411       "isConstructor" : false,
412       "isPrivate" : false,
413       "memberOf" : "Roo.TabPanel",
414       "example" : "",
415       "deprecated" : "",
416       "since" : "",
417       "see" : "",
418       "params" : [
419         {
420           "name" : "id",
421           "type" : "String/Number",
422           "desc" : "The id or index of the TabPanelItem to hide.",
423           "isOptional" : false
424         }
425       ],
426       "returns" : [
427       ]
428     },
429     {
430       "name" : "purgeListeners",
431       "desc" : "Removes all listeners for this object",
432       "isStatic" : false,
433       "isConstructor" : false,
434       "isPrivate" : false,
435       "memberOf" : "Roo.util.Observable",
436       "example" : "",
437       "deprecated" : "",
438       "since" : "",
439       "see" : "",
440       "params" : [
441       ],
442       "returns" : [
443       ]
444     },
445     {
446       "name" : "on",
447       "desc" : "Appends an event handler to this element (shorthand for addListener)",
448       "isStatic" : false,
449       "isConstructor" : false,
450       "isPrivate" : false,
451       "memberOf" : "Roo.util.Observable",
452       "example" : "",
453       "deprecated" : "",
454       "since" : "",
455       "see" : "",
456       "params" : [
457         {
458           "name" : "eventName",
459           "type" : "String",
460           "desc" : "The type of event to listen for",
461           "isOptional" : false
462         },
463         {
464           "name" : "handler",
465           "type" : "Function",
466           "desc" : "The method the event invokes",
467           "isOptional" : false
468         },
469         {
470           "name" : "scope",
471           "type" : "Object",
472           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
473           "isOptional" : false
474         },
475         {
476           "name" : "options",
477           "type" : "Object",
478           "desc" : "(optional)",
479           "isOptional" : false
480         }
481       ],
482       "returns" : [
483       ]
484     },
485     {
486       "name" : "un",
487       "desc" : "Removes a listener (shorthand for removeListener)",
488       "isStatic" : false,
489       "isConstructor" : false,
490       "isPrivate" : false,
491       "memberOf" : "Roo.util.Observable",
492       "example" : "",
493       "deprecated" : "",
494       "since" : "",
495       "see" : "",
496       "params" : [
497         {
498           "name" : "eventName",
499           "type" : "String",
500           "desc" : "The type of event to listen for",
501           "isOptional" : false
502         },
503         {
504           "name" : "handler",
505           "type" : "Function",
506           "desc" : "The handler to remove",
507           "isOptional" : false
508         },
509         {
510           "name" : "scope",
511           "type" : "Object",
512           "desc" : "(optional) The scope (this object) for the handler",
513           "isOptional" : false
514         }
515       ],
516       "returns" : [
517       ]
518     },
519     {
520       "name" : "addEvents",
521       "desc" : "Used to define events on this Observable",
522       "isStatic" : false,
523       "isConstructor" : false,
524       "isPrivate" : false,
525       "memberOf" : "Roo.util.Observable",
526       "example" : "",
527       "deprecated" : "",
528       "since" : "",
529       "see" : "",
530       "params" : [
531         {
532           "name" : "object",
533           "type" : "Object",
534           "desc" : "The object with the events defined",
535           "isOptional" : false
536         }
537       ],
538       "returns" : [
539       ]
540     },
541     {
542       "name" : "releaseCapture",
543       "desc" : "Removes <b>all</b> added captures from the Observable.",
544       "isStatic" : true,
545       "isConstructor" : false,
546       "isPrivate" : false,
547       "memberOf" : "Roo.util.Observable",
548       "example" : "",
549       "deprecated" : "",
550       "since" : "",
551       "see" : "",
552       "params" : [
553         {
554           "name" : "o",
555           "type" : "Observable",
556           "desc" : "The Observable to release",
557           "isOptional" : false
558         }
559       ],
560       "returns" : [
561       ]
562     },
563     {
564       "name" : "removeListener",
565       "desc" : "Removes a listener",
566       "isStatic" : false,
567       "isConstructor" : false,
568       "isPrivate" : false,
569       "memberOf" : "Roo.util.Observable",
570       "example" : "",
571       "deprecated" : "",
572       "since" : "",
573       "see" : "",
574       "params" : [
575         {
576           "name" : "eventName",
577           "type" : "String",
578           "desc" : "The type of event to listen for",
579           "isOptional" : false
580         },
581         {
582           "name" : "handler",
583           "type" : "Function",
584           "desc" : "The handler to remove",
585           "isOptional" : false
586         },
587         {
588           "name" : "scope",
589           "type" : "Object",
590           "desc" : "(optional) The scope (this object) for the handler",
591           "isOptional" : false
592         }
593       ],
594       "returns" : [
595       ]
596     },
597     {
598       "name" : "fireEvent",
599       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
600       "isStatic" : false,
601       "isConstructor" : false,
602       "isPrivate" : false,
603       "memberOf" : "Roo.util.Observable",
604       "example" : "",
605       "deprecated" : "",
606       "since" : "",
607       "see" : "",
608       "params" : [
609         {
610           "name" : "eventName",
611           "type" : "String",
612           "desc" : "",
613           "isOptional" : false
614         },
615         {
616           "name" : "args",
617           "type" : "Object...",
618           "desc" : "Variable number of parameters are passed to handlers",
619           "isOptional" : false
620         }
621       ],
622       "returns" : [
623         {
624           "name" : "",
625           "type" : "Boolean",
626           "desc" : "returns false if any of the handlers return false otherwise it returns true"
627         }
628       ]
629     },
630     {
631       "name" : "hasListener",
632       "desc" : "Checks to see if this object has any listeners for a specified event",
633       "isStatic" : false,
634       "isConstructor" : false,
635       "isPrivate" : false,
636       "memberOf" : "Roo.util.Observable",
637       "example" : "",
638       "deprecated" : "",
639       "since" : "",
640       "see" : "",
641       "params" : [
642         {
643           "name" : "eventName",
644           "type" : "String",
645           "desc" : "The name of the event to check for",
646           "isOptional" : false
647         }
648       ],
649       "returns" : [
650         {
651           "name" : "",
652           "type" : "Boolean",
653           "desc" : "True if the event is being listened for, else false"
654         }
655       ]
656     },
657     {
658       "name" : "capture",
659       "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
660       "isStatic" : true,
661       "isConstructor" : false,
662       "isPrivate" : false,
663       "memberOf" : "Roo.util.Observable",
664       "example" : "",
665       "deprecated" : "",
666       "since" : "",
667       "see" : "",
668       "params" : [
669         {
670           "name" : "o",
671           "type" : "Observable",
672           "desc" : "The Observable to capture",
673           "isOptional" : false
674         },
675         {
676           "name" : "fn",
677           "type" : "Function",
678           "desc" : "The function to call",
679           "isOptional" : false
680         },
681         {
682           "name" : "scope",
683           "type" : "Object",
684           "desc" : "(optional) The scope (this object) for the fn",
685           "isOptional" : false
686         }
687       ],
688       "returns" : [
689       ]
690     },
691     {
692       "name" : "addListener",
693       "desc" : "Appends an event handler to this component",
694       "isStatic" : false,
695       "isConstructor" : false,
696       "isPrivate" : false,
697       "memberOf" : "Roo.util.Observable",
698       "example" : "",
699       "deprecated" : "",
700       "since" : "",
701       "see" : "",
702       "params" : [
703         {
704           "name" : "eventName",
705           "type" : "String",
706           "desc" : "The type of event to listen for",
707           "isOptional" : false
708         },
709         {
710           "name" : "handler",
711           "type" : "Function",
712           "desc" : "The method the event invokes",
713           "isOptional" : false
714         },
715         {
716           "name" : "scope",
717           "type" : "Object",
718           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
719           "isOptional" : false
720         },
721         {
722           "name" : "options",
723           "type" : "Object",
724           "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n     \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t</code></pre>",
725           "isOptional" : false
726         }
727       ],
728       "returns" : [
729       ]
730     }
731   ],
732   "events" : [
733     {
734       "name" : "beforetabchange",
735       "desc" : "Fires before the active tab changes, set cancel to true on the \"e\" parameter to cancel the change",
736       "memberOf" : "Roo.TabPanel",
737       "example" : "",
738       "deprecated" : "",
739       "since" : "",
740       "see" : "",
741       "params" : [
742         {
743           "name" : "this",
744           "type" : "Roo.TabPanel",
745           "desc" : "",
746           "isOptional" : false
747         },
748         {
749           "name" : "e",
750           "type" : "Object",
751           "desc" : "Set cancel to true on this object to cancel the tab change",
752           "isOptional" : false
753         },
754         {
755           "name" : "tab",
756           "type" : "Roo.TabPanelItem",
757           "desc" : "The tab being changed to",
758           "isOptional" : false
759         }
760       ],
761       "returns" : [
762       ]
763     },
764     {
765       "name" : "tabchange",
766       "desc" : "Fires when the active tab changes",
767       "memberOf" : "Roo.TabPanel",
768       "example" : "",
769       "deprecated" : "",
770       "since" : "",
771       "see" : "",
772       "params" : [
773         {
774           "name" : "this",
775           "type" : "Roo.TabPanel",
776           "desc" : "",
777           "isOptional" : false
778         },
779         {
780           "name" : "activePanel",
781           "type" : "Roo.TabPanelItem",
782           "desc" : "The new active tab",
783           "isOptional" : false
784         }
785       ],
786       "returns" : [
787       ]
788     }
789   ]
790 }