2 "name" : "Roo.ContentPanel",
6 "desc" : "A basic ContentPanel element.",
10 "memberOf" : "ContentPanel",
18 "type" : "String/HTMLElement/Roo.Element",
19 "desc" : "The container element for this panel",
24 "type" : "String/Object",
25 "desc" : "A string to set only the title or a config object",
31 "desc" : "(optional) Set the HTML content for this panel",
37 "desc" : "(optional) Used by xtype constructors to add to regions. (values center,east,west,south,north)",
48 "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
54 "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>",
55 "memberOf" : "Roo.util.Observable"
58 "name" : "autoScroll",
60 "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
64 "name" : "fitToFrame",
66 "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
70 "name" : "background",
72 "desc" : "True if the panel should not be activated when it is added (defaults to false)",
77 "type" : "Roo.Toolbar",
78 "desc" : "A toolbar for this panel",
84 "desc" : "[required] (center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
90 "desc" : "Raw content to fill content panel with (uses setContent on construction.)",
95 "type" : "Roo.menu.Menu",
96 "desc" : "popup menu",
102 "desc" : "The title for this panel",
108 "desc" : "Extra style to add to the content panel",
112 "name" : "autoCreate",
113 "type" : "Boolean|Object",
114 "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
118 "name" : "fitContainer",
120 "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
126 "desc" : "True if the panel can be closed/removed",
131 "type" : "String|Object",
132 "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
136 "name" : "adjustments",
138 "desc" : "Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])",
144 "desc" : "Calls {@link #setUrl} with this value",
149 "type" : "String|HTMLElement|Element",
150 "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
158 "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.",
159 "sig" : "(url, params, callback, discardUrl)",
163 "isConstructor" : false,
174 "type" : "Object/String/Function",
175 "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n<pre><code>\npanel.load({\n url: \"your-url.php\",\n params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n callback: yourFunction,\n scope: yourObject, //(optional scope)\n discardUrl: false,\n nocache: false,\n text: \"Loading...\",\n timeout: 30,\n scripts: false\n});\n</code></pre>\nThe only required property is <i>url</i>. The optional properties <i>nocache</i>, <i>text</i> and <i>scripts</i>\nare shorthand for <i>disableCaching</i>, <i>indicatorText</i> and <i>loadScripts</i> and are used to set their associated property on this panel UpdateManager instance.",
180 "type" : "String/Object",
181 "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}",
187 "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)",
191 "name" : "discardUrl",
193 "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.",
200 "type" : "Roo.ContentPanel",
206 "name" : "getUpdateManager",
208 "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
209 "sig" : "()\n{\n\n}",
213 "isConstructor" : false,
225 "type" : "Roo.UpdateManager",
226 "desc" : "The UpdateManager"
231 "name" : "isClosable",
233 "desc" : "Returns true is this panel was configured to be closable",
234 "sig" : "()\n{\n\n}",
238 "isConstructor" : false,
258 "desc" : "Destroys this panel",
259 "sig" : "()\n{\n\n}",
263 "isConstructor" : false,
277 "desc" : "Returns this panel's element - used by regiosn to add.",
278 "sig" : "()\n{\n\n}",
282 "isConstructor" : false,
294 "type" : "Roo.Element",
300 "name" : "setContent",
302 "desc" : "Updates this panel's element",
303 "sig" : "(content, loadScripts)",
307 "isConstructor" : false,
319 "desc" : "The new content",
323 "name" : "loadScripts",
325 "desc" : "(optional) true to look for and process scripts",
334 "desc" : "Returns this panel's id",
335 "sig" : "()\n{\n\n}",
339 "isConstructor" : false,
359 "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n<pre><code>\n\nlayout.addxtype({\n xtype : 'Form',\n items: [ .... ]\n }\n);\n\n</code></pre>",
364 "isConstructor" : false,
376 "desc" : "Xtype definition of item to add.",
385 "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.",
386 "sig" : "()\n{\n\n}",
390 "isConstructor" : false,
404 "desc" : "Returns this panel's title",
405 "sig" : "()\n{\n\n}",
409 "isConstructor" : false,
429 "desc" : "Set this panel's title",
434 "isConstructor" : false,
453 "name" : "getToolbar",
455 "desc" : "Returns the toolbar for this Panel if one was configured.",
456 "sig" : "()\n{\n\n}",
460 "isConstructor" : false,
472 "type" : "Roo.Toolbar",
480 "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.",
481 "sig" : "(url, params, loadOnce)",
485 "isConstructor" : false,
496 "type" : "String/Function",
497 "desc" : "The URL to load the content from or a function to call to get the URL",
502 "type" : "String/Object",
503 "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)",
509 "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)",
516 "type" : "Roo.UpdateManager",
517 "desc" : "The UpdateManager"
522 "name" : "purgeListeners",
524 "desc" : "Removes all listeners for this object",
525 "sig" : "()\n{\n\n}",
527 "memberOf" : "Roo.util.Observable",
529 "isConstructor" : false,
543 "desc" : "Appends an event handler to this element (shorthand for addListener)",
544 "sig" : "(eventName, handler, scope, options)",
546 "memberOf" : "Roo.util.Observable",
548 "isConstructor" : false,
558 "name" : "eventName",
560 "desc" : "The type of event to listen for",
566 "desc" : "The method the event invokes",
572 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
578 "desc" : "(optional)",
587 "desc" : "Removes a listener (shorthand for removeListener)",
588 "sig" : "(eventName, handler, scope)",
590 "memberOf" : "Roo.util.Observable",
592 "isConstructor" : false,
602 "name" : "eventName",
604 "desc" : "The type of event to listen for",
610 "desc" : "The handler to remove",
616 "desc" : "(optional) The scope (this object) for the handler",
623 "name" : "addEvents",
625 "desc" : "Used to define events on this Observable",
628 "memberOf" : "Roo.util.Observable",
630 "isConstructor" : false,
642 "desc" : "The object with the events defined",
649 "name" : "releaseCapture",
651 "desc" : "Removes <b>all</b> added captures from the Observable.",
654 "memberOf" : "Roo.util.Observable",
656 "isConstructor" : false,
667 "type" : "Observable",
668 "desc" : "The Observable to release",
675 "name" : "removeListener",
677 "desc" : "Removes a listener",
678 "sig" : "(eventName, handler, scope)",
680 "memberOf" : "Roo.util.Observable",
682 "isConstructor" : false,
692 "name" : "eventName",
694 "desc" : "The type of event to listen for",
700 "desc" : "The handler to remove",
706 "desc" : "(optional) The scope (this object) for the handler",
713 "name" : "fireEvent",
715 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
716 "sig" : "(eventName, args)",
718 "memberOf" : "Roo.util.Observable",
720 "isConstructor" : false,
730 "name" : "eventName",
737 "type" : "Object...",
738 "desc" : "Variable number of parameters are passed to handlers",
746 "desc" : "returns false if any of the handlers return false otherwise it returns true"
751 "name" : "hasListener",
753 "desc" : "Checks to see if this object has any listeners for a specified event",
754 "sig" : "(eventName)",
756 "memberOf" : "Roo.util.Observable",
758 "isConstructor" : false,
768 "name" : "eventName",
770 "desc" : "The name of the event to check for",
778 "desc" : "True if the event is being listened for, else false"
785 "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.",
786 "sig" : "(o, fn, scope)",
788 "memberOf" : "Roo.util.Observable",
790 "isConstructor" : false,
801 "type" : "Observable",
802 "desc" : "The Observable to capture",
808 "desc" : "The function to call",
814 "desc" : "(optional) The scope (this object) for the fn",
821 "name" : "addListener",
823 "desc" : "Appends an event handler to this component",
824 "sig" : "(eventName, handler, scope, options)",
826 "memberOf" : "Roo.util.Observable",
828 "isConstructor" : false,
838 "name" : "eventName",
840 "desc" : "The type of event to listen for",
846 "desc" : "The method the event invokes",
852 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
858 "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>",
867 "name" : "deactivate",
869 "desc" : "Fires when this panel is activated.",
870 "sig" : "function (_self)\n{\n\n}",
879 "type" : "Roo.ContentPanel",
889 "desc" : "Fires when this panel is resized if fitToFrame is true.",
890 "sig" : "function (_self, width, height)\n{\n\n}",
899 "type" : "Roo.ContentPanel",
906 "desc" : "The width after any component adjustments",
912 "desc" : "The height after any component adjustments",
921 "desc" : "Fires when this tab is created",
922 "sig" : "function (_self)\n{\n\n}",
931 "type" : "Roo.ContentPanel",
941 "desc" : "Fires when this panel is activated.",
942 "sig" : "function (_self)\n{\n\n}",
951 "type" : "Roo.ContentPanel",