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