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)",
46 "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
47 "memberOf" : "Roo.ContentPanel",
53 "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>",
54 "memberOf" : "Roo.util.Observable",
58 "name" : "autoScroll",
60 "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
61 "memberOf" : "Roo.ContentPanel",
65 "name" : "fitToFrame",
67 "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
68 "memberOf" : "Roo.ContentPanel",
72 "name" : "background",
74 "desc" : "True if the panel should not be activated when it is added (defaults to false)",
75 "memberOf" : "Roo.ContentPanel",
81 "desc" : "A toolbar for this panel",
82 "memberOf" : "Roo.ContentPanel",
88 "desc" : "which region to put this panel on (when used with xtype constructors)",
89 "memberOf" : "Roo.ContentPanel",
101 "desc" : "Raw content to fill content panel with (uses setContent on construction.)",
102 "memberOf" : "Roo.ContentPanel",
108 "desc" : "The title for this panel",
109 "memberOf" : "Roo.ContentPanel",
115 "desc" : "Extra style to add to the content panel",
116 "memberOf" : "Roo.ContentPanel",
120 "name" : "autoCreate",
121 "type" : "Boolean/Object",
122 "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
123 "memberOf" : "Roo.ContentPanel",
127 "name" : "fitContainer",
129 "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
130 "memberOf" : "Roo.ContentPanel",
136 "desc" : "True if the panel can be closed/removed",
137 "memberOf" : "Roo.ContentPanel",
142 "type" : "String/Object",
143 "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
144 "memberOf" : "Roo.ContentPanel",
148 "name" : "adjustments",
150 "desc" : "Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])",
151 "memberOf" : "Roo.ContentPanel",
157 "desc" : "Calls {@link #setUrl} with this value",
158 "memberOf" : "Roo.ContentPanel",
163 "type" : "String/HTMLElement/Element",
164 "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
165 "memberOf" : "Roo.ContentPanel",
172 "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.",
174 "isConstructor" : false,
176 "memberOf" : "Roo.ContentPanel",
184 "type" : "Object/String/Function",
185 "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.",
190 "type" : "String/Object",
191 "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}",
197 "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)",
201 "name" : "discardUrl",
203 "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.",
210 "type" : "Roo.ContentPanel",
216 "name" : "getUpdateManager",
217 "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
219 "isConstructor" : false,
221 "memberOf" : "Roo.ContentPanel",
230 "type" : "Roo.UpdateManager",
231 "desc" : "The UpdateManager"
236 "name" : "isClosable",
237 "desc" : "Returns true is this panel was configured to be closable",
239 "isConstructor" : false,
241 "memberOf" : "Roo.ContentPanel",
257 "desc" : "Destroys this panel",
259 "isConstructor" : false,
261 "memberOf" : "Roo.ContentPanel",
271 "desc" : "Returns this panel's element - used by regiosn to add.",
273 "isConstructor" : false,
275 "memberOf" : "Roo.ContentPanel",
284 "type" : "Roo.Element",
290 "name" : "setContent",
291 "desc" : "Updates this panel's element",
293 "isConstructor" : false,
295 "memberOf" : "Roo.ContentPanel",
304 "desc" : "The new content",
308 "name" : "loadScripts",
310 "desc" : "(optional) true to look for and process scripts",
318 "desc" : "Returns this panel's id",
320 "isConstructor" : false,
322 "memberOf" : "Roo.ContentPanel",
338 "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>",
340 "isConstructor" : false,
342 "memberOf" : "Roo.ContentPanel",
351 "desc" : "Xtype definition of item to add.",
359 "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.",
361 "isConstructor" : false,
363 "memberOf" : "Roo.ContentPanel",
373 "desc" : "Returns this panel's title",
375 "isConstructor" : false,
377 "memberOf" : "Roo.ContentPanel",
393 "desc" : "Set this panel's title",
395 "isConstructor" : false,
397 "memberOf" : "Roo.ContentPanel",
413 "name" : "getToolbar",
414 "desc" : "Returns the toolbar for this Panel if one was configured.",
416 "isConstructor" : false,
418 "memberOf" : "Roo.ContentPanel",
427 "type" : "Roo.Toolbar",
434 "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.",
436 "isConstructor" : false,
438 "memberOf" : "Roo.ContentPanel",
446 "type" : "String/Function",
447 "desc" : "The URL to load the content from or a function to call to get the URL",
452 "type" : "String/Object",
453 "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)",
459 "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)",
466 "type" : "Roo.UpdateManager",
467 "desc" : "The UpdateManager"
472 "name" : "purgeListeners",
473 "desc" : "Removes all listeners for this object",
475 "isConstructor" : false,
477 "memberOf" : "Roo.util.Observable",
487 "desc" : "Appends an event handler to this element (shorthand for addListener)",
489 "isConstructor" : false,
491 "memberOf" : "Roo.util.Observable",
498 "name" : "eventName",
500 "desc" : "The type of event to listen for",
506 "desc" : "The method the event invokes",
512 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
518 "desc" : "(optional)",
526 "desc" : "Removes a listener (shorthand for removeListener)",
528 "isConstructor" : false,
530 "memberOf" : "Roo.util.Observable",
537 "name" : "eventName",
539 "desc" : "The type of event to listen for",
545 "desc" : "The handler to remove",
551 "desc" : "(optional) The scope (this object) for the handler",
558 "name" : "addEvents",
559 "desc" : "Used to define events on this Observable",
561 "isConstructor" : false,
563 "memberOf" : "Roo.util.Observable",
572 "desc" : "The object with the events defined",
579 "name" : "releaseCapture",
580 "desc" : "Removes <b>all</b> added captures from the Observable.",
582 "isConstructor" : false,
584 "memberOf" : "Roo.util.Observable",
592 "type" : "Observable",
593 "desc" : "The Observable to release",
600 "name" : "removeListener",
601 "desc" : "Removes a listener",
603 "isConstructor" : false,
605 "memberOf" : "Roo.util.Observable",
612 "name" : "eventName",
614 "desc" : "The type of event to listen for",
620 "desc" : "The handler to remove",
626 "desc" : "(optional) The scope (this object) for the handler",
633 "name" : "fireEvent",
634 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
636 "isConstructor" : false,
638 "memberOf" : "Roo.util.Observable",
645 "name" : "eventName",
652 "type" : "Object...",
653 "desc" : "Variable number of parameters are passed to handlers",
661 "desc" : "returns false if any of the handlers return false otherwise it returns true"
666 "name" : "hasListener",
667 "desc" : "Checks to see if this object has any listeners for a specified event",
669 "isConstructor" : false,
671 "memberOf" : "Roo.util.Observable",
678 "name" : "eventName",
680 "desc" : "The name of the event to check for",
688 "desc" : "True if the event is being listened for, else false"
694 "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.",
696 "isConstructor" : false,
698 "memberOf" : "Roo.util.Observable",
706 "type" : "Observable",
707 "desc" : "The Observable to capture",
713 "desc" : "The function to call",
719 "desc" : "(optional) The scope (this object) for the fn",
726 "name" : "addListener",
727 "desc" : "Appends an event handler to this component",
729 "isConstructor" : false,
731 "memberOf" : "Roo.util.Observable",
738 "name" : "eventName",
740 "desc" : "The type of event to listen for",
746 "desc" : "The method the event invokes",
752 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
758 "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>",
767 "name" : "deactivate",
768 "desc" : "Fires when this panel is activated.",
769 "memberOf" : "Roo.ContentPanel",
777 "type" : "Roo.ContentPanel",
786 "desc" : "Fires when this panel is resized if fitToFrame is true.",
787 "memberOf" : "Roo.ContentPanel",
795 "type" : "Roo.ContentPanel",
802 "desc" : "The width after any component adjustments",
808 "desc" : "The height after any component adjustments",
816 "desc" : "Fires when this tab is created",
817 "memberOf" : "Roo.ContentPanel",
825 "type" : "Roo.ContentPanel",
834 "desc" : "Fires when this panel is activated.",
835 "memberOf" : "Roo.ContentPanel",
843 "type" : "Roo.ContentPanel",