2 "name" : "Roo.ContentPanel",
6 "desc" : "A basic ContentPanel element.",
14 "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
15 "memberOf" : "Roo.ContentPanel",
22 "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>",
23 "memberOf" : "Roo.util.Observable",
28 "name" : "autoScroll",
30 "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
31 "memberOf" : "Roo.ContentPanel",
36 "name" : "fitToFrame",
38 "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
39 "memberOf" : "Roo.ContentPanel",
44 "name" : "background",
46 "desc" : "True if the panel should not be activated when it is added (defaults to false)",
47 "memberOf" : "Roo.ContentPanel",
54 "desc" : "A toolbar for this panel",
55 "memberOf" : "Roo.ContentPanel",
62 "desc" : "which region to put this panel on (when used with xtype constructors)",
63 "memberOf" : "Roo.ContentPanel",
75 "desc" : "Raw content to fill content panel with (uses setContent on construction.)",
76 "memberOf" : "Roo.ContentPanel",
83 "desc" : "The title for this panel",
84 "memberOf" : "Roo.ContentPanel",
89 "name" : "autoCreate",
90 "type" : "Boolean/Object",
91 "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
92 "memberOf" : "Roo.ContentPanel",
97 "name" : "fitContainer",
99 "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
100 "memberOf" : "Roo.ContentPanel",
107 "desc" : "True if the panel can be closed/removed",
108 "memberOf" : "Roo.ContentPanel",
114 "type" : "String/Object",
115 "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
116 "memberOf" : "Roo.ContentPanel",
121 "name" : "adjustments",
123 "desc" : "Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])",
124 "memberOf" : "Roo.ContentPanel",
131 "desc" : "Calls {@link #setUrl} with this value",
132 "memberOf" : "Roo.ContentPanel",
138 "type" : "String/HTMLElement/Element",
139 "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
140 "memberOf" : "Roo.ContentPanel",
148 "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.",
150 "isConstructor" : false,
152 "memberOf" : "Roo.ContentPanel",
160 "type" : "Object/String/Function",
161 "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.",
166 "type" : "String/Object",
167 "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}",
173 "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)",
177 "name" : "discardUrl",
179 "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.",
186 "type" : "Roo.ContentPanel",
192 "name" : "getUpdateManager",
193 "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
195 "isConstructor" : false,
197 "memberOf" : "Roo.ContentPanel",
207 "type" : "Roo.UpdateManager",
208 "desc" : "The UpdateManager"
213 "name" : "isClosable",
214 "desc" : "Returns true is this panel was configured to be closable",
216 "isConstructor" : false,
218 "memberOf" : "Roo.ContentPanel",
235 "desc" : "Destroys this panel",
237 "isConstructor" : false,
239 "memberOf" : "Roo.ContentPanel",
251 "desc" : "Returns this panel's element - used by regiosn to add.",
253 "isConstructor" : false,
255 "memberOf" : "Roo.ContentPanel",
265 "type" : "Roo.Element",
271 "name" : "setContent",
272 "desc" : "Updates this panel's element",
274 "isConstructor" : false,
276 "memberOf" : "Roo.ContentPanel",
285 "desc" : "The new content",
289 "name" : "loadScripts",
291 "desc" : "(optional) true to look for and process scripts",
300 "desc" : "Returns this panel's id",
302 "isConstructor" : false,
304 "memberOf" : "Roo.ContentPanel",
321 "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>",
323 "isConstructor" : false,
325 "memberOf" : "Roo.ContentPanel",
334 "desc" : "Xtype definition of item to add.",
343 "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.",
345 "isConstructor" : false,
347 "memberOf" : "Roo.ContentPanel",
359 "desc" : "Returns this panel's title",
361 "isConstructor" : false,
363 "memberOf" : "Roo.ContentPanel",
380 "desc" : "Set this panel's title",
382 "isConstructor" : false,
384 "memberOf" : "Roo.ContentPanel",
401 "name" : "getToolbar",
402 "desc" : "Returns the toolbar for this Panel if one was configured.",
404 "isConstructor" : false,
406 "memberOf" : "Roo.ContentPanel",
416 "type" : "Roo.Toolbar",
423 "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.",
425 "isConstructor" : false,
427 "memberOf" : "Roo.ContentPanel",
435 "type" : "String/Function",
436 "desc" : "The URL to load the content from or a function to call to get the URL",
441 "type" : "String/Object",
442 "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)",
448 "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)",
455 "type" : "Roo.UpdateManager",
456 "desc" : "The UpdateManager"
461 "name" : "purgeListeners",
462 "desc" : "Removes all listeners for this object",
464 "isConstructor" : false,
466 "memberOf" : "Roo.util.Observable",
478 "desc" : "Appends an event handler to this element (shorthand for addListener)",
480 "isConstructor" : false,
482 "memberOf" : "Roo.util.Observable",
489 "name" : "eventName",
491 "desc" : "The type of event to listen for",
497 "desc" : "The method the event invokes",
503 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
509 "desc" : "(optional)",
518 "desc" : "Removes a listener (shorthand for removeListener)",
520 "isConstructor" : false,
522 "memberOf" : "Roo.util.Observable",
529 "name" : "eventName",
531 "desc" : "The type of event to listen for",
537 "desc" : "The handler to remove",
543 "desc" : "(optional) The scope (this object) for the handler",
551 "name" : "addEvents",
552 "desc" : "Used to define events on this Observable",
554 "isConstructor" : false,
556 "memberOf" : "Roo.util.Observable",
565 "desc" : "The object with the events defined",
573 "name" : "releaseCapture",
574 "desc" : "Removes <b>all</b> added captures from the Observable.",
576 "isConstructor" : false,
578 "memberOf" : "Roo.util.Observable",
586 "type" : "Observable",
587 "desc" : "The Observable to release",
595 "name" : "removeListener",
596 "desc" : "Removes a listener",
598 "isConstructor" : false,
600 "memberOf" : "Roo.util.Observable",
607 "name" : "eventName",
609 "desc" : "The type of event to listen for",
615 "desc" : "The handler to remove",
621 "desc" : "(optional) The scope (this object) for the handler",
629 "name" : "fireEvent",
630 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
632 "isConstructor" : false,
634 "memberOf" : "Roo.util.Observable",
641 "name" : "eventName",
648 "type" : "Object...",
649 "desc" : "Variable number of parameters are passed to handlers",
657 "desc" : "returns false if any of the handlers return false otherwise it returns true"
662 "name" : "hasListener",
663 "desc" : "Checks to see if this object has any listeners for a specified event",
665 "isConstructor" : false,
667 "memberOf" : "Roo.util.Observable",
674 "name" : "eventName",
676 "desc" : "The name of the event to check for",
684 "desc" : "True if the event is being listened for, else false"
690 "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.",
692 "isConstructor" : false,
694 "memberOf" : "Roo.util.Observable",
702 "type" : "Observable",
703 "desc" : "The Observable to capture",
709 "desc" : "The function to call",
715 "desc" : "(optional) The scope (this object) for the fn",
723 "name" : "addListener",
724 "desc" : "Appends an event handler to this component",
726 "isConstructor" : false,
728 "memberOf" : "Roo.util.Observable",
735 "name" : "eventName",
737 "desc" : "The type of event to listen for",
743 "desc" : "The method the event invokes",
749 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
755 "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>",
765 "name" : "deactivate",
766 "desc" : "Fires when this panel is activated.",
775 "type" : "Roo.ContentPanel",
785 "desc" : "Fires when this panel is resized if fitToFrame is true.",
794 "type" : "Roo.ContentPanel",
801 "desc" : "The width after any component adjustments",
807 "desc" : "The height after any component adjustments",
816 "desc" : "Fires when this tab is created",
825 "type" : "Roo.ContentPanel",
835 "desc" : "Fires when this panel is activated.",
844 "type" : "Roo.ContentPanel",