2 "name" : "Roo.BasicDialog",
9 "desc" : "Lightweight Dialog Class. The code below shows the creation of a typical dialog using existing HTML markup:\n<pre><code>\nvar dlg = new Roo.BasicDialog(\"my-dlg\", {\n height: 200,\n width: 300,\n minHeight: 100,\n minWidth: 150,\n modal: true,\n proxyDrag: true,\n shadow: true\n});\ndlg.addKeyListener(27, dlg.hide, dlg); // ESC can also close the dialog\ndlg.addButton('OK', dlg.hide, dlg); // Could call a save function instead of hiding\ndlg.addButton('Cancel', dlg.hide, dlg);\ndlg.show();\n</code></pre>\n <b>A Dialog should always be a direct child of the body element.</b>",
10 "isSingleton" : false,
13 "memberOf" : "BasicDialog",
21 "type" : "String/HTMLElement/Roo.Element",
22 "desc" : "The container element or DOM node, or its id",
28 "desc" : "Configuration options",
39 "desc" : "The default top page coordinate of the dialog (defaults to center screen)",
45 "desc" : "True to show the dialog modally, preventing user interaction with the rest of the page (defaults to false)",
51 "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>",
52 "memberOf" : "Roo.util.Observable"
55 "name" : "animateTarget",
56 "type" : "String/Element",
57 "desc" : "Id or element from which the dialog should animate while opening\n(defaults to null with no animation)",
62 "type" : "Boolean/String",
63 "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right\nshadow (defaults to false)",
67 "name" : "autoScroll",
69 "desc" : "True to allow the dialog body contents to overflow and display scrollbars (defaults to false)",
73 "name" : "collapsible",
75 "desc" : "False to remove the built-in top-right corner collapse button (defaults to true)",
81 "desc" : "If true, all elements with class 'x-dlg-tab' will get automatically converted to tabs (defaults to false)",
85 "name" : "shadowOffset",
87 "desc" : "The number of pixels to offset the shadow if displayed (defaults to 5)",
93 "desc" : "Array of buttons",
97 "name" : "minButtonWidth",
99 "desc" : "Minimum width of all dialog buttons (defaults to 75)",
105 "desc" : "Default text to display in the title bar (defaults to null)",
111 "desc" : "The minimum allowable width for a resizable dialog (defaults to 200)",
115 "name" : "buttonAlign",
117 "desc" : "Valid values are \"left,\" \"center\" and \"right\" (defaults to \"right\")",
121 "name" : "autoCreate",
122 "type" : "Boolean/DomHelper",
123 "desc" : "True to auto create from scratch, or using a DomHelper Object (defaults to false)",
127 "name" : "minHeight",
129 "desc" : "The minimum allowable height for a resizable dialog (defaults to 80)",
133 "name" : "proxyDrag",
135 "desc" : "True to drag a lightweight proxy element rather than the dialog itself, used when\ndraggable = true (defaults to false)",
141 "desc" : "True to create an iframe shim that prevents selects from showing through (defaults to false)",
147 "desc" : "Width of the dialog in pixels (can also be set via CSS). Determined by browser if unspecified.",
151 "name" : "constraintoviewport",
153 "desc" : "True to keep the dialog constrained within the visible viewport boundaries (defaults to true)",
157 "name" : "syncHeightBeforeShow",
159 "desc" : "True to cause the dimensions to be recalculated before the dialog is shown (defaults to false)",
165 "desc" : "The tag name of tab elements, used when autoTabs = true (defaults to 'div')",
169 "name" : "resizable",
171 "desc" : "False to disable manual dialog resizing (defaults to true)",
177 "desc" : "False to remove the built-in top-right corner close button (defaults to true)",
181 "name" : "fixedcenter",
183 "desc" : "True to ensure that anytime the dialog is shown or resized it gets centered (defaults to false)",
189 "desc" : "Height of the dialog in pixels (can also be set via CSS). Determined by browser if unspecified.",
193 "name" : "resizeHandles",
195 "desc" : "Which resize handles to display - see the {@link Roo.Resizable} handles config\nproperty for valid values (defaults to 'all')",
201 "desc" : "The default left page coordinate of the dialog (defaults to center screen)",
205 "name" : "draggable",
207 "desc" : "False to disable dragging of the dialog within the viewport (defaults to true)",
215 "desc" : "Expands a collapsed dialog back to its normal state. Equivalent to the user\nclicking the expand dialog button.",
216 "sig" : "()\n{\n\n}",
220 "isConstructor" : false,
234 "desc" : "Aligns the dialog to the specified element",
235 "sig" : "(element, position, offsets)",
239 "isConstructor" : false,
250 "type" : "String/HTMLElement/Roo.Element",
251 "desc" : "The element to align to.",
257 "desc" : "The position to align to (see {@link Roo.Element#alignTo} for more details).",
263 "desc" : "(optional) Offset the positioning by [x, y]",
270 "type" : "Roo.BasicDialog",
278 "desc" : "Sets the dialog title text",
283 "isConstructor" : false,
295 "desc" : "The title text to display",
302 "type" : "Roo.BasicDialog",
308 "name" : "isVisible",
310 "desc" : "Returns true if the dialog is visible",
311 "sig" : "()\n{\n\n}",
315 "isConstructor" : false,
335 "desc" : "Resizes the dialog.",
336 "sig" : "(width, height)",
340 "isConstructor" : false,
365 "type" : "Roo.BasicDialog",
373 "desc" : "Centers this dialog in the viewport",
374 "sig" : "()\n{\n\n}",
378 "isConstructor" : false,
390 "type" : "Roo.BasicDialog",
398 "desc" : "Collapses the dialog to its minimized state (only the title bar is visible).\nEquivalent to the user clicking the collapse dialog button.",
399 "sig" : "()\n{\n\n}",
403 "isConstructor" : false,
417 "desc" : "Reinitializes the tabs component, clearing out old tabs and finding new ones.",
418 "sig" : "()\n{\n\n}",
422 "isConstructor" : false,
434 "type" : "Roo.TabPanel",
435 "desc" : "The tabs component"
442 "desc" : "Brings this dialog to the front of any other visible dialogs",
443 "sig" : "()\n{\n\n}",
447 "isConstructor" : false,
459 "type" : "Roo.BasicDialog",
467 "desc" : "Moves the dialog's top-left corner to the specified point",
472 "isConstructor" : false,
497 "type" : "Roo.BasicDialog",
505 "desc" : "Hides the dialog.",
506 "sig" : "(callback)",
510 "isConstructor" : false,
522 "desc" : "(optional) Function to call when the dialog is hidden",
529 "type" : "Roo.BasicDialog",
537 "desc" : "Destroys this dialog and all its supporting elements (including any tabs, shim,\nshadow, proxy, mask, etc.) Also removes all event listeners.",
538 "sig" : "(removeEl)",
542 "isConstructor" : false,
554 "desc" : "(optional) true to remove the element from the DOM",
563 "desc" : "Shows the dialog.",
564 "sig" : "(animateTarget)",
568 "isConstructor" : false,
578 "name" : "animateTarget",
579 "type" : "String/HTMLElement/Roo.Element",
580 "desc" : "(optional) Reset the animation target",
587 "type" : "Roo.BasicDialog",
595 "desc" : "Anchors an element to another element and realigns it when the window is resized.",
596 "sig" : "(element, position, offsets, monitorScroll)",
600 "isConstructor" : false,
611 "type" : "String/HTMLElement/Roo.Element",
612 "desc" : "The element to align to.",
618 "desc" : "The position to align to (see {@link Roo.Element#alignTo} for more details)",
624 "desc" : "(optional) Offset the positioning by [x, y]",
628 "name" : "monitorScroll",
629 "type" : "Boolean/Number",
630 "desc" : "(optional) true to monitor body scroll and reposition. If this parameter\nis a number, it is used as the buffer delay (defaults to 50ms).",
637 "type" : "Roo.BasicDialog",
643 "name" : "addButton",
645 "desc" : "Adds a button to the footer section of the dialog.",
646 "sig" : "(config, handler, scope)",
650 "isConstructor" : false,
661 "type" : "String/Object",
662 "desc" : "A string becomes the button text, an object can either be a Button config\nobject or a valid Roo.DomHelper element config",
668 "desc" : "The function called when the button is clicked",
674 "desc" : "(optional) The scope of the handler function (accepts position as a property)",
681 "type" : "Roo.Button",
682 "desc" : "The new button"
687 "name" : "addKeyListener",
689 "desc" : "Adds a key listener for when this dialog is displayed. This allows you to hook in a function that will be\nexecuted in response to a particular key being pressed while the dialog is active.",
690 "sig" : "(key, fn, scope)",
694 "isConstructor" : false,
705 "type" : "Number/Array/Object",
706 "desc" : "Either the numeric key code, array of key codes or an object with the following options:\n {key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)}",
712 "desc" : "The function to call",
718 "desc" : "(optional) The scope of the function",
725 "type" : "Roo.BasicDialog",
733 "desc" : "Focuses the dialog. If a defaultButton is set, it will receive focus, otherwise the\ndialog itself will receive focus.",
734 "sig" : "()\n{\n\n}",
738 "isConstructor" : false,
752 "desc" : "Returns the TabPanel component (creates it if it doesn't exist).\nNote: If you wish to simply check for the existence of tabs without creating them,\ncheck for a null 'tabs' property.",
753 "sig" : "()\n{\n\n}",
757 "isConstructor" : false,
769 "type" : "Roo.TabPanel",
770 "desc" : "The tabs component"
775 "name" : "setDefaultButton",
777 "desc" : "Sets the default button to be focused when the dialog is displayed.",
782 "isConstructor" : false,
793 "type" : "Roo.BasicDialog.Button",
794 "desc" : "The button object returned by {@link #addButton}",
801 "type" : "Roo.BasicDialog",
809 "desc" : "Sends this dialog to the back (under) of any other visible dialogs",
810 "sig" : "()\n{\n\n}",
814 "isConstructor" : false,
826 "type" : "Roo.BasicDialog",
832 "name" : "setContentSize",
834 "desc" : "Resizes the dialog to fit the specified content size.",
835 "sig" : "(width, height)",
839 "isConstructor" : false,
864 "type" : "Roo.BasicDialog",
870 "name" : "restoreState",
872 "desc" : "Restores the previous state of the dialog if Roo.state is configured.",
873 "sig" : "()\n{\n\n}",
877 "isConstructor" : false,
889 "type" : "Roo.BasicDialog",
897 "desc" : "Returns the element for this dialog",
898 "sig" : "()\n{\n\n}",
902 "isConstructor" : false,
914 "type" : "Roo.Element",
915 "desc" : "The underlying dialog Element"
920 "name" : "purgeListeners",
922 "desc" : "Removes all listeners for this object",
923 "sig" : "()\n{\n\n}",
925 "memberOf" : "Roo.util.Observable",
927 "isConstructor" : false,
941 "desc" : "Appends an event handler to this element (shorthand for addListener)",
942 "sig" : "(eventName, handler, scope, options)",
944 "memberOf" : "Roo.util.Observable",
946 "isConstructor" : false,
956 "name" : "eventName",
958 "desc" : "The type of event to listen for",
964 "desc" : "The method the event invokes",
970 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
976 "desc" : "(optional)",
985 "desc" : "Removes a listener (shorthand for removeListener)",
986 "sig" : "(eventName, handler, scope)",
988 "memberOf" : "Roo.util.Observable",
990 "isConstructor" : false,
1000 "name" : "eventName",
1002 "desc" : "The type of event to listen for",
1003 "isOptional" : false
1007 "type" : "Function",
1008 "desc" : "The handler to remove",
1009 "isOptional" : false
1014 "desc" : "(optional) The scope (this object) for the handler",
1015 "isOptional" : false
1021 "name" : "addEvents",
1022 "type" : "function",
1023 "desc" : "Used to define events on this Observable",
1026 "memberOf" : "Roo.util.Observable",
1028 "isConstructor" : false,
1029 "isPrivate" : false,
1040 "desc" : "The object with the events defined",
1041 "isOptional" : false
1047 "name" : "releaseCapture",
1048 "type" : "function",
1049 "desc" : "Removes <b>all</b> added captures from the Observable.",
1052 "memberOf" : "Roo.util.Observable",
1054 "isConstructor" : false,
1055 "isPrivate" : false,
1065 "type" : "Observable",
1066 "desc" : "The Observable to release",
1067 "isOptional" : false
1073 "name" : "removeListener",
1074 "type" : "function",
1075 "desc" : "Removes a listener",
1076 "sig" : "(eventName, handler, scope)",
1078 "memberOf" : "Roo.util.Observable",
1080 "isConstructor" : false,
1081 "isPrivate" : false,
1090 "name" : "eventName",
1092 "desc" : "The type of event to listen for",
1093 "isOptional" : false
1097 "type" : "Function",
1098 "desc" : "The handler to remove",
1099 "isOptional" : false
1104 "desc" : "(optional) The scope (this object) for the handler",
1105 "isOptional" : false
1111 "name" : "fireEvent",
1112 "type" : "function",
1113 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
1114 "sig" : "(eventName, args)",
1116 "memberOf" : "Roo.util.Observable",
1118 "isConstructor" : false,
1119 "isPrivate" : false,
1128 "name" : "eventName",
1131 "isOptional" : false
1135 "type" : "Object...",
1136 "desc" : "Variable number of parameters are passed to handlers",
1137 "isOptional" : false
1144 "desc" : "returns false if any of the handlers return false otherwise it returns true"
1149 "name" : "hasListener",
1150 "type" : "function",
1151 "desc" : "Checks to see if this object has any listeners for a specified event",
1152 "sig" : "(eventName)",
1154 "memberOf" : "Roo.util.Observable",
1156 "isConstructor" : false,
1157 "isPrivate" : false,
1166 "name" : "eventName",
1168 "desc" : "The name of the event to check for",
1169 "isOptional" : false
1176 "desc" : "True if the event is being listened for, else false"
1182 "type" : "function",
1183 "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.",
1184 "sig" : "(o, fn, scope)",
1186 "memberOf" : "Roo.util.Observable",
1188 "isConstructor" : false,
1189 "isPrivate" : false,
1199 "type" : "Observable",
1200 "desc" : "The Observable to capture",
1201 "isOptional" : false
1205 "type" : "Function",
1206 "desc" : "The function to call",
1207 "isOptional" : false
1212 "desc" : "(optional) The scope (this object) for the fn",
1213 "isOptional" : false
1219 "name" : "addListener",
1220 "type" : "function",
1221 "desc" : "Appends an event handler to this component",
1222 "sig" : "(eventName, handler, scope, options)",
1224 "memberOf" : "Roo.util.Observable",
1226 "isConstructor" : false,
1227 "isPrivate" : false,
1236 "name" : "eventName",
1238 "desc" : "The type of event to listen for",
1239 "isOptional" : false
1243 "type" : "Function",
1244 "desc" : "The method the event invokes",
1245 "isOptional" : false
1250 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1251 "isOptional" : false
1256 "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>",
1257 "isOptional" : false
1266 "type" : "function",
1267 "desc" : "Fires when this dialog is moved by the user.",
1268 "sig" : "function (_self, x, y)\n{\n\n}",
1277 "type" : "Roo.BasicDialog",
1279 "isOptional" : false
1284 "desc" : "The new page X",
1285 "isOptional" : false
1290 "desc" : "The new page Y",
1291 "isOptional" : false
1298 "type" : "function",
1299 "desc" : "Fires when this dialog is resized by the user.",
1300 "sig" : "function (_self, width, height)\n{\n\n}",
1309 "type" : "Roo.BasicDialog",
1311 "isOptional" : false
1316 "desc" : "The new width",
1317 "isOptional" : false
1322 "desc" : "The new height",
1323 "isOptional" : false
1329 "name" : "beforehide",
1330 "type" : "function",
1331 "desc" : "Fires before this dialog is hidden.",
1332 "sig" : "function (_self)\n{\n\n}",
1341 "type" : "Roo.BasicDialog",
1343 "isOptional" : false
1349 "name" : "beforeshow",
1350 "type" : "function",
1351 "desc" : "Fires before this dialog is shown.",
1352 "sig" : "function (_self)\n{\n\n}",
1361 "type" : "Roo.BasicDialog",
1363 "isOptional" : false
1370 "type" : "function",
1371 "desc" : "Fires when this dialog is hidden.",
1372 "sig" : "function (_self)\n{\n\n}",
1381 "type" : "Roo.BasicDialog",
1383 "isOptional" : false
1390 "type" : "function",
1391 "desc" : "Fires when this dialog is shown.",
1392 "sig" : "function (_self)\n{\n\n}",
1401 "type" : "Roo.BasicDialog",
1403 "isOptional" : false
1410 "type" : "function",
1411 "desc" : "Fires when a key is pressed",
1412 "sig" : "function (_self, e)\n{\n\n}",
1421 "type" : "Roo.BasicDialog",
1423 "isOptional" : false
1427 "type" : "Roo.EventObject",
1429 "isOptional" : false