2 "name" : "Roo.GridPanel",
7 "desc" : "Create a new GridPanel.",
11 "memberOf" : "GridPanel",
19 "type" : "Roo.grid.Grid",
20 "desc" : "The grid for this panel",
25 "type" : "String/Object",
26 "desc" : "A string to set only the panel's title, or a config object",
37 "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
38 "memberOf" : "Roo.ContentPanel"
43 "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>",
44 "memberOf" : "Roo.util.Observable"
47 "name" : "autoScroll",
49 "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
50 "memberOf" : "Roo.ContentPanel"
53 "name" : "fitToFrame",
55 "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
56 "memberOf" : "Roo.ContentPanel"
59 "name" : "background",
61 "desc" : "True if the panel should not be activated when it is added (defaults to false)",
62 "memberOf" : "Roo.ContentPanel"
66 "type" : "Roo.Toolbar",
67 "desc" : "A toolbar for this panel",
68 "memberOf" : "Roo.ContentPanel"
73 "desc" : "[required] (center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
74 "memberOf" : "Roo.ContentPanel"
79 "desc" : "Raw content to fill content panel with (uses setContent on construction.)",
80 "memberOf" : "Roo.ContentPanel"
84 "type" : "Roo.menu.Menu",
85 "desc" : "popup menu",
86 "memberOf" : "Roo.ContentPanel"
91 "desc" : "The title for this panel",
92 "memberOf" : "Roo.ContentPanel"
97 "desc" : "Extra style to add to the content panel",
98 "memberOf" : "Roo.ContentPanel"
101 "name" : "autoCreate",
102 "type" : "Boolean|Object",
103 "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
104 "memberOf" : "Roo.ContentPanel"
107 "name" : "fitContainer",
109 "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
110 "memberOf" : "Roo.ContentPanel"
115 "desc" : "True if the panel can be closed/removed",
116 "memberOf" : "Roo.ContentPanel"
120 "type" : "String|Object",
121 "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
122 "memberOf" : "Roo.ContentPanel"
125 "name" : "adjustments",
127 "desc" : "Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])",
128 "memberOf" : "Roo.ContentPanel"
133 "desc" : "Calls {@link #setUrl} with this value",
134 "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"
147 "desc" : "Returns the grid for this panel",
148 "sig" : "()\n{\n\n}",
152 "isConstructor" : false,
164 "type" : "Roo.grid.Grid",
172 "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.",
173 "sig" : "(url, params, callback, discardUrl)",
175 "memberOf" : "Roo.ContentPanel",
177 "isConstructor" : false,
188 "type" : "Object/String/Function",
189 "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.",
194 "type" : "String/Object",
195 "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}",
201 "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)",
205 "name" : "discardUrl",
207 "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.",
214 "type" : "Roo.ContentPanel",
220 "name" : "getUpdateManager",
222 "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
223 "sig" : "()\n{\n\n}",
225 "memberOf" : "Roo.ContentPanel",
227 "isConstructor" : false,
239 "type" : "Roo.UpdateManager",
240 "desc" : "The UpdateManager"
245 "name" : "isClosable",
247 "desc" : "Returns true is this panel was configured to be closable",
248 "sig" : "()\n{\n\n}",
250 "memberOf" : "Roo.ContentPanel",
252 "isConstructor" : false,
272 "desc" : "Destroys this panel",
273 "sig" : "()\n{\n\n}",
275 "memberOf" : "Roo.ContentPanel",
277 "isConstructor" : false,
291 "desc" : "Returns this panel's element - used by regiosn to add.",
292 "sig" : "()\n{\n\n}",
294 "memberOf" : "Roo.ContentPanel",
296 "isConstructor" : false,
308 "type" : "Roo.Element",
314 "name" : "setContent",
316 "desc" : "Updates this panel's element",
317 "sig" : "(content, loadScripts)",
319 "memberOf" : "Roo.ContentPanel",
321 "isConstructor" : false,
333 "desc" : "The new content",
337 "name" : "loadScripts",
339 "desc" : "(optional) true to look for and process scripts",
348 "desc" : "Returns this panel's id",
349 "sig" : "()\n{\n\n}",
351 "memberOf" : "Roo.ContentPanel",
353 "isConstructor" : false,
373 "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>",
376 "memberOf" : "Roo.ContentPanel",
378 "isConstructor" : false,
390 "desc" : "Xtype definition of item to add.",
399 "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.",
400 "sig" : "()\n{\n\n}",
402 "memberOf" : "Roo.ContentPanel",
404 "isConstructor" : false,
418 "desc" : "Returns this panel's title",
419 "sig" : "()\n{\n\n}",
421 "memberOf" : "Roo.ContentPanel",
423 "isConstructor" : false,
443 "desc" : "Set this panel's title",
446 "memberOf" : "Roo.ContentPanel",
448 "isConstructor" : false,
467 "name" : "getToolbar",
469 "desc" : "Returns the toolbar for this Panel if one was configured.",
470 "sig" : "()\n{\n\n}",
472 "memberOf" : "Roo.ContentPanel",
474 "isConstructor" : false,
486 "type" : "Roo.Toolbar",
494 "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.",
495 "sig" : "(url, params, loadOnce)",
497 "memberOf" : "Roo.ContentPanel",
499 "isConstructor" : false,
510 "type" : "String/Function",
511 "desc" : "The URL to load the content from or a function to call to get the URL",
516 "type" : "String/Object",
517 "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)",
523 "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)",
530 "type" : "Roo.UpdateManager",
531 "desc" : "The UpdateManager"
536 "name" : "purgeListeners",
538 "desc" : "Removes all listeners for this object",
539 "sig" : "()\n{\n\n}",
541 "memberOf" : "Roo.util.Observable",
543 "isConstructor" : false,
557 "desc" : "Appends an event handler to this element (shorthand for addListener)",
558 "sig" : "(eventName, handler, scope, options)",
560 "memberOf" : "Roo.util.Observable",
562 "isConstructor" : false,
572 "name" : "eventName",
574 "desc" : "The type of event to listen for",
580 "desc" : "The method the event invokes",
586 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
592 "desc" : "(optional)",
601 "desc" : "Removes a listener (shorthand for removeListener)",
602 "sig" : "(eventName, handler, scope)",
604 "memberOf" : "Roo.util.Observable",
606 "isConstructor" : false,
616 "name" : "eventName",
618 "desc" : "The type of event to listen for",
624 "desc" : "The handler to remove",
630 "desc" : "(optional) The scope (this object) for the handler",
637 "name" : "addEvents",
639 "desc" : "Used to define events on this Observable",
642 "memberOf" : "Roo.util.Observable",
644 "isConstructor" : false,
656 "desc" : "The object with the events defined",
663 "name" : "releaseCapture",
665 "desc" : "Removes <b>all</b> added captures from the Observable.",
668 "memberOf" : "Roo.util.Observable",
670 "isConstructor" : false,
681 "type" : "Observable",
682 "desc" : "The Observable to release",
689 "name" : "removeListener",
691 "desc" : "Removes a listener",
692 "sig" : "(eventName, handler, scope)",
694 "memberOf" : "Roo.util.Observable",
696 "isConstructor" : false,
706 "name" : "eventName",
708 "desc" : "The type of event to listen for",
714 "desc" : "The handler to remove",
720 "desc" : "(optional) The scope (this object) for the handler",
727 "name" : "fireEvent",
729 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
730 "sig" : "(eventName, args)",
732 "memberOf" : "Roo.util.Observable",
734 "isConstructor" : false,
744 "name" : "eventName",
751 "type" : "Object...",
752 "desc" : "Variable number of parameters are passed to handlers",
760 "desc" : "returns false if any of the handlers return false otherwise it returns true"
765 "name" : "hasListener",
767 "desc" : "Checks to see if this object has any listeners for a specified event",
768 "sig" : "(eventName)",
770 "memberOf" : "Roo.util.Observable",
772 "isConstructor" : false,
782 "name" : "eventName",
784 "desc" : "The name of the event to check for",
792 "desc" : "True if the event is being listened for, else false"
799 "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.",
800 "sig" : "(o, fn, scope)",
802 "memberOf" : "Roo.util.Observable",
804 "isConstructor" : false,
815 "type" : "Observable",
816 "desc" : "The Observable to capture",
822 "desc" : "The function to call",
828 "desc" : "(optional) The scope (this object) for the fn",
835 "name" : "addListener",
837 "desc" : "Appends an event handler to this component",
838 "sig" : "(eventName, handler, scope, options)",
840 "memberOf" : "Roo.util.Observable",
842 "isConstructor" : false,
852 "name" : "eventName",
854 "desc" : "The type of event to listen for",
860 "desc" : "The method the event invokes",
866 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
872 "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>",
881 "name" : "deactivate",
883 "desc" : "Fires when this panel is activated.",
884 "sig" : "function (_self)\n{\n\n}",
885 "memberOf" : "Roo.ContentPanel",
893 "type" : "Roo.ContentPanel",
903 "desc" : "Fires when this panel is resized if fitToFrame is true.",
904 "sig" : "function (_self, width, height)\n{\n\n}",
905 "memberOf" : "Roo.ContentPanel",
913 "type" : "Roo.ContentPanel",
920 "desc" : "The width after any component adjustments",
926 "desc" : "The height after any component adjustments",
935 "desc" : "Fires when this tab is created",
936 "sig" : "function (_self)\n{\n\n}",
937 "memberOf" : "Roo.ContentPanel",
945 "type" : "Roo.ContentPanel",
955 "desc" : "Fires when this panel is activated.",
956 "sig" : "function (_self)\n{\n\n}",
957 "memberOf" : "Roo.ContentPanel",
965 "type" : "Roo.ContentPanel",