2 "name" : "Roo.TabPanel",
9 "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>",
10 "isSingleton" : false,
14 "isBuilderTop" : false,
15 "memberOf" : "TabPanel",
23 "type" : "String/HTMLElement/Roo.Element",
24 "desc" : "The id, DOM element or Roo.Element container where this TabPanel is to be rendered.",
29 "type" : "Object/Boolean",
30 "desc" : "Config object to set any properties for this TabPanel, or true to render the tabs on the bottom.",
41 "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>",
42 "memberOf" : "Roo.util.Observable"
47 "name" : "getActiveTab",
49 "desc" : "Gets the active {@link Roo.TabPanelItem}.",
54 "isConstructor" : false,
66 "type" : "Roo.TabPanelItem",
67 "desc" : "The active TabPanelItem or null if none are active."
72 "name" : "beginUpdate",
74 "desc" : "Disables tab resizing while tabs are being added (if {@link #resizeTabs} is false this does nothing)",
79 "isConstructor" : false,
93 "desc" : "\"Unhides\" the {@link Roo.TabPanelItem} with the specified id/index.",
98 "isConstructor" : false,
109 "type" : "String/Number",
110 "desc" : "The id or index of the TabPanelItem to unhide.",
117 "name" : "enableTab",
119 "desc" : "Enables a {@link Roo.TabPanelItem} that is disabled.",
124 "isConstructor" : false,
135 "type" : "String/Number",
136 "desc" : "The id or index of the TabPanelItem to enable.",
143 "name" : "setTabWidth",
145 "desc" : "Resizes all the tabs to the passed width",
150 "isConstructor" : false,
162 "desc" : "new width",
169 "name" : "endUpdate",
171 "desc" : "Stops an update and resizes the tabs (if {@link #resizeTabs} is false this does nothing)",
172 "sig" : "()\n{\n\n}",
176 "isConstructor" : false,
190 "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.",
191 "sig" : "(id, text, content, closable)",
195 "isConstructor" : false,
207 "desc" : "The id of the div to use <b>or create</b>",
213 "desc" : "The text for the tab",
219 "desc" : "(optional) Content to put in the TabPanelItem body",
225 "desc" : "(optional) True to create a close icon on the tab",
232 "type" : "Roo.TabPanelItem",
233 "desc" : "The created TabPanelItem"
238 "name" : "disableTab",
240 "desc" : "Disables a {@link Roo.TabPanelItem}. It cannot be the active tab, if it is this call is ignored.",
245 "isConstructor" : false,
256 "type" : "String/Number",
257 "desc" : "The id or index of the TabPanelItem to disable.",
266 "desc" : "Destroys this TabPanel",
267 "sig" : "(removeEl)",
271 "isConstructor" : false,
283 "desc" : "(optional) True to remove the element from the DOM as well (defaults to undefined)",
292 "desc" : "Returns the {@link Roo.TabPanelItem} with the specified id/index",
297 "isConstructor" : false,
308 "type" : "String/Number",
309 "desc" : "The id or index of the TabPanelItem to fetch.",
316 "type" : "Roo.TabPanelItem",
324 "desc" : "Returns the number of tabs in this TabPanel.",
325 "sig" : "()\n{\n\n}",
329 "isConstructor" : false,
347 "name" : "autoSizeTabs",
349 "desc" : "Manual call to resize the tabs (if {@link #resizeTabs} is false this does nothing)",
350 "sig" : "()\n{\n\n}",
354 "isConstructor" : false,
366 "name" : "removeTab",
368 "desc" : "Removes a {@link Roo.TabPanelItem}.",
373 "isConstructor" : false,
384 "type" : "String/Number",
385 "desc" : "The id or index of the TabPanelItem to remove.",
394 "desc" : "Activates a {@link Roo.TabPanelItem}. The currently active one will be deactivated.",
399 "isConstructor" : false,
410 "type" : "String/Number",
411 "desc" : "The id or index of the TabPanelItem to activate.",
418 "type" : "Roo.TabPanelItem",
419 "desc" : "The TabPanelItem."
424 "name" : "syncHeight",
426 "desc" : "Updates the tab body element to fit the height of the container element\nfor overflow scrolling",
427 "sig" : "(targetHeight)",
431 "isConstructor" : false,
441 "name" : "targetHeight",
443 "desc" : "(optional) Override the starting height from the elements height",
450 "name" : "addTabItem",
452 "desc" : "Adds an existing {@link Roo.TabPanelItem}.",
457 "isConstructor" : false,
468 "type" : "Roo.TabPanelItem",
469 "desc" : "The TabPanelItem to add",
478 "desc" : "Hides the {@link Roo.TabPanelItem} with the specified id/index",
483 "isConstructor" : false,
494 "type" : "String/Number",
495 "desc" : "The id or index of the TabPanelItem to hide.",
502 "name" : "purgeListeners",
504 "desc" : "Removes all listeners for this object",
505 "sig" : "()\n{\n\n}",
507 "memberOf" : "Roo.util.Observable",
509 "isConstructor" : false,
523 "desc" : "Appends an event handler to this element (shorthand for addListener)",
524 "sig" : "(eventName, handler, scope, options)",
526 "memberOf" : "Roo.util.Observable",
528 "isConstructor" : false,
538 "name" : "eventName",
540 "desc" : "The type of event to listen for",
546 "desc" : "The method the event invokes",
552 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
558 "desc" : "(optional)",
567 "desc" : "Removes a listener (shorthand for removeListener)",
568 "sig" : "(eventName, handler, scope)",
570 "memberOf" : "Roo.util.Observable",
572 "isConstructor" : false,
582 "name" : "eventName",
584 "desc" : "The type of event to listen for",
590 "desc" : "The handler to remove",
596 "desc" : "(optional) The scope (this object) for the handler",
603 "name" : "addEvents",
605 "desc" : "Used to define events on this Observable",
608 "memberOf" : "Roo.util.Observable",
610 "isConstructor" : false,
622 "desc" : "The object with the events defined",
629 "name" : "releaseCapture",
631 "desc" : "Removes <b>all</b> added captures from the Observable.",
634 "memberOf" : "Roo.util.Observable",
636 "isConstructor" : false,
647 "type" : "Observable",
648 "desc" : "The Observable to release",
655 "name" : "removeListener",
657 "desc" : "Removes a listener",
658 "sig" : "(eventName, handler, scope)",
660 "memberOf" : "Roo.util.Observable",
662 "isConstructor" : false,
672 "name" : "eventName",
674 "desc" : "The type of event to listen for",
680 "desc" : "The handler to remove",
686 "desc" : "(optional) The scope (this object) for the handler",
693 "name" : "fireEvent",
695 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
696 "sig" : "(eventName, args)",
698 "memberOf" : "Roo.util.Observable",
700 "isConstructor" : false,
710 "name" : "eventName",
717 "type" : "Object...",
718 "desc" : "Variable number of parameters are passed to handlers",
726 "desc" : "returns false if any of the handlers return false otherwise it returns true"
731 "name" : "hasListener",
733 "desc" : "Checks to see if this object has any listeners for a specified event",
734 "sig" : "(eventName)",
736 "memberOf" : "Roo.util.Observable",
738 "isConstructor" : false,
748 "name" : "eventName",
750 "desc" : "The name of the event to check for",
758 "desc" : "True if the event is being listened for, else false"
765 "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.",
766 "sig" : "(o, fn, scope)",
768 "memberOf" : "Roo.util.Observable",
770 "isConstructor" : false,
781 "type" : "Observable",
782 "desc" : "The Observable to capture",
788 "desc" : "The function to call",
794 "desc" : "(optional) The scope (this object) for the fn",
801 "name" : "addListener",
803 "desc" : "Appends an event handler to this component",
804 "sig" : "(eventName, handler, scope, options)",
806 "memberOf" : "Roo.util.Observable",
808 "isConstructor" : false,
818 "name" : "eventName",
820 "desc" : "The type of event to listen for",
826 "desc" : "The method the event invokes",
832 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
838 "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>",
847 "name" : "beforetabchange",
849 "desc" : "Fires before the active tab changes, set cancel to true on the \"e\" parameter to cancel the change",
850 "sig" : "function (_self, e, tab)\n{\n\n}",
859 "type" : "Roo.TabPanel",
866 "desc" : "Set cancel to true on this object to cancel the tab change",
871 "type" : "Roo.TabPanelItem",
872 "desc" : "The tab being changed to",
879 "name" : "tabchange",
881 "desc" : "Fires when the active tab changes",
882 "sig" : "function (_self, activePanel)\n{\n\n}",
891 "type" : "Roo.TabPanel",
896 "name" : "activePanel",
897 "type" : "Roo.TabPanelItem",
898 "desc" : "The new active tab",