2 "name" : "Roo.BasicDialog",
16 "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>",
17 "isSingleton" : false,
21 "isBuilderTop" : false,
22 "memberOf" : "BasicDialog",
30 "type" : "String/HTMLElement/Roo.Element",
31 "desc" : "The container element or DOM node, or its id",
37 "desc" : "Configuration options",
48 "desc" : "The default top page coordinate of the dialog (defaults to center screen)",
56 "desc" : "True to show the dialog modally, preventing user interaction with the rest of the page (defaults to false)",
64 "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>",
65 "memberOf" : "Roo.util.Observable",
70 "name" : "animateTarget",
71 "type" : "String/Element",
72 "desc" : "Id or element from which the dialog should animate while opening\n(defaults to null with no animation)",
79 "type" : "Boolean/String",
80 "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right\nshadow (defaults to false)",
86 "name" : "autoScroll",
88 "desc" : "True to allow the dialog body contents to overflow and display scrollbars (defaults to false)",
94 "name" : "collapsible",
96 "desc" : "False to remove the built-in top-right corner collapse button (defaults to true)",
104 "desc" : "If true, all elements with class 'x-dlg-tab' will get automatically converted to tabs (defaults to false)",
106 "isOptional" : false,
110 "name" : "shadowOffset",
112 "desc" : "The number of pixels to offset the shadow if displayed (defaults to 5)",
114 "isOptional" : false,
120 "desc" : "Array of buttons",
122 "isOptional" : false,
126 "name" : "minButtonWidth",
128 "desc" : "Minimum width of all dialog buttons (defaults to 75)",
130 "isOptional" : false,
136 "desc" : "Default text to display in the title bar (defaults to null)",
138 "isOptional" : false,
144 "desc" : "The minimum allowable width for a resizable dialog (defaults to 200)",
146 "isOptional" : false,
150 "name" : "buttonAlign",
152 "desc" : "Valid values are \"left,\" \"center\" and \"right\" (defaults to \"right\")",
154 "isOptional" : false,
158 "name" : "autoCreate",
159 "type" : "Boolean/DomHelper",
160 "desc" : "True to auto create from scratch, or using a DomHelper Object (defaults to false)",
162 "isOptional" : false,
166 "name" : "minHeight",
168 "desc" : "The minimum allowable height for a resizable dialog (defaults to 80)",
170 "isOptional" : false,
174 "name" : "proxyDrag",
176 "desc" : "True to drag a lightweight proxy element rather than the dialog itself, used when\ndraggable = true (defaults to false)",
178 "isOptional" : false,
184 "desc" : "True to create an iframe shim that prevents selects from showing through (defaults to false)",
186 "isOptional" : false,
192 "desc" : "Width of the dialog in pixels (can also be set via CSS). Determined by browser if unspecified.",
194 "isOptional" : false,
198 "name" : "constraintoviewport",
200 "desc" : "True to keep the dialog constrained within the visible viewport boundaries (defaults to true)",
202 "isOptional" : false,
206 "name" : "syncHeightBeforeShow",
208 "desc" : "True to cause the dimensions to be recalculated before the dialog is shown (defaults to false)",
210 "isOptional" : false,
216 "desc" : "The tag name of tab elements, used when autoTabs = true (defaults to 'div')",
218 "isOptional" : false,
222 "name" : "resizable",
224 "desc" : "False to disable manual dialog resizing (defaults to true)",
226 "isOptional" : false,
232 "desc" : "False to remove the built-in top-right corner close button (defaults to true)",
234 "isOptional" : false,
238 "name" : "fixedcenter",
240 "desc" : "True to ensure that anytime the dialog is shown or resized it gets centered (defaults to false)",
242 "isOptional" : false,
248 "desc" : "Height of the dialog in pixels (can also be set via CSS). Determined by browser if unspecified.",
250 "isOptional" : false,
254 "name" : "resizeHandles",
256 "desc" : "Which resize handles to display - see the {@link Roo.Resizable} handles config\nproperty for valid values (defaults to 'all')",
258 "isOptional" : false,
264 "desc" : "The default left page coordinate of the dialog (defaults to center screen)",
266 "isOptional" : false,
270 "name" : "draggable",
272 "desc" : "False to disable dragging of the dialog within the viewport (defaults to true)",
274 "isOptional" : false,
282 "desc" : "Expands a collapsed dialog back to its normal state. Equivalent to the user\nclicking the expand dialog button.",
283 "sig" : "()\n{\n\n}",
287 "isConstructor" : false,
301 "desc" : "Aligns the dialog to the specified element",
302 "sig" : "(element, position, offsets)",
306 "isConstructor" : false,
317 "type" : "String/HTMLElement/Roo.Element",
318 "desc" : "The element to align to.",
324 "desc" : "The position to align to (see {@link Roo.Element#alignTo} for more details).",
330 "desc" : "(optional) Offset the positioning by [x, y]",
337 "type" : "Roo.BasicDialog",
345 "desc" : "Sets the dialog title text",
350 "isConstructor" : false,
362 "desc" : "The title text to display",
369 "type" : "Roo.BasicDialog",
375 "name" : "isVisible",
377 "desc" : "Returns true if the dialog is visible",
378 "sig" : "()\n{\n\n}",
382 "isConstructor" : false,
402 "desc" : "Resizes the dialog.",
403 "sig" : "(width, height)",
407 "isConstructor" : false,
432 "type" : "Roo.BasicDialog",
440 "desc" : "Centers this dialog in the viewport",
441 "sig" : "()\n{\n\n}",
445 "isConstructor" : false,
457 "type" : "Roo.BasicDialog",
465 "desc" : "Collapses the dialog to its minimized state (only the title bar is visible).\nEquivalent to the user clicking the collapse dialog button.",
466 "sig" : "()\n{\n\n}",
470 "isConstructor" : false,
484 "desc" : "Reinitializes the tabs component, clearing out old tabs and finding new ones.",
485 "sig" : "()\n{\n\n}",
489 "isConstructor" : false,
501 "type" : "Roo.TabPanel",
502 "desc" : "The tabs component"
509 "desc" : "Brings this dialog to the front of any other visible dialogs",
510 "sig" : "()\n{\n\n}",
514 "isConstructor" : false,
526 "type" : "Roo.BasicDialog",
534 "desc" : "Moves the dialog's top-left corner to the specified point",
539 "isConstructor" : false,
564 "type" : "Roo.BasicDialog",
572 "desc" : "Hides the dialog.",
573 "sig" : "(callback)",
577 "isConstructor" : false,
589 "desc" : "(optional) Function to call when the dialog is hidden",
596 "type" : "Roo.BasicDialog",
604 "desc" : "Destroys this dialog and all its supporting elements (including any tabs, shim,\nshadow, proxy, mask, etc.) Also removes all event listeners.",
605 "sig" : "(removeEl)",
609 "isConstructor" : false,
621 "desc" : "(optional) true to remove the element from the DOM",
630 "desc" : "Shows the dialog.",
631 "sig" : "(animateTarget)",
635 "isConstructor" : false,
645 "name" : "animateTarget",
646 "type" : "String/HTMLElement/Roo.Element",
647 "desc" : "(optional) Reset the animation target",
654 "type" : "Roo.BasicDialog",
662 "desc" : "Anchors an element to another element and realigns it when the window is resized.",
663 "sig" : "(element, position, offsets, monitorScroll)",
667 "isConstructor" : false,
678 "type" : "String/HTMLElement/Roo.Element",
679 "desc" : "The element to align to.",
685 "desc" : "The position to align to (see {@link Roo.Element#alignTo} for more details)",
691 "desc" : "(optional) Offset the positioning by [x, y]",
695 "name" : "monitorScroll",
696 "type" : "Boolean/Number",
697 "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).",
704 "type" : "Roo.BasicDialog",
710 "name" : "addButton",
712 "desc" : "Adds a button to the footer section of the dialog.",
713 "sig" : "(config, handler, scope)",
717 "isConstructor" : false,
728 "type" : "String/Object",
729 "desc" : "A string becomes the button text, an object can either be a Button config\nobject or a valid Roo.DomHelper element config",
735 "desc" : "The function called when the button is clicked",
741 "desc" : "(optional) The scope of the handler function (accepts position as a property)",
748 "type" : "Roo.Button",
749 "desc" : "The new button"
754 "name" : "addKeyListener",
756 "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.",
757 "sig" : "(key, fn, scope)",
761 "isConstructor" : false,
772 "type" : "Number/Array/Object",
773 "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)}",
779 "desc" : "The function to call",
785 "desc" : "(optional) The scope of the function",
792 "type" : "Roo.BasicDialog",
800 "desc" : "Focuses the dialog. If a defaultButton is set, it will receive focus, otherwise the\ndialog itself will receive focus.",
801 "sig" : "()\n{\n\n}",
805 "isConstructor" : false,
819 "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.",
820 "sig" : "()\n{\n\n}",
824 "isConstructor" : false,
836 "type" : "Roo.TabPanel",
837 "desc" : "The tabs component"
842 "name" : "setDefaultButton",
844 "desc" : "Sets the default button to be focused when the dialog is displayed.",
849 "isConstructor" : false,
860 "type" : "Roo.BasicDialog.Button",
861 "desc" : "The button object returned by {@link #addButton}",
868 "type" : "Roo.BasicDialog",
876 "desc" : "Sends this dialog to the back (under) of any other visible dialogs",
877 "sig" : "()\n{\n\n}",
881 "isConstructor" : false,
893 "type" : "Roo.BasicDialog",
899 "name" : "setContentSize",
901 "desc" : "Resizes the dialog to fit the specified content size.",
902 "sig" : "(width, height)",
906 "isConstructor" : false,
931 "type" : "Roo.BasicDialog",
937 "name" : "restoreState",
939 "desc" : "Restores the previous state of the dialog if Roo.state is configured.",
940 "sig" : "()\n{\n\n}",
944 "isConstructor" : false,
956 "type" : "Roo.BasicDialog",
964 "desc" : "Returns the element for this dialog",
965 "sig" : "()\n{\n\n}",
969 "isConstructor" : false,
981 "type" : "Roo.Element",
982 "desc" : "The underlying dialog Element"
987 "name" : "purgeListeners",
989 "desc" : "Removes all listeners for this object",
990 "sig" : "()\n{\n\n}",
992 "memberOf" : "Roo.util.Observable",
994 "isConstructor" : false,
1007 "type" : "function",
1008 "desc" : "Appends an event handler to this element (shorthand for addListener)",
1009 "sig" : "(eventName, handler, scope, options)",
1011 "memberOf" : "Roo.util.Observable",
1013 "isConstructor" : false,
1014 "isPrivate" : false,
1023 "name" : "eventName",
1025 "desc" : "The type of event to listen for",
1026 "isOptional" : false
1030 "type" : "Function",
1031 "desc" : "The method the event invokes",
1032 "isOptional" : false
1037 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1038 "isOptional" : false
1043 "desc" : "(optional)",
1044 "isOptional" : false
1051 "type" : "function",
1052 "desc" : "Removes a listener (shorthand for removeListener)",
1053 "sig" : "(eventName, handler, scope)",
1055 "memberOf" : "Roo.util.Observable",
1057 "isConstructor" : false,
1058 "isPrivate" : false,
1067 "name" : "eventName",
1069 "desc" : "The type of event to listen for",
1070 "isOptional" : false
1074 "type" : "Function",
1075 "desc" : "The handler to remove",
1076 "isOptional" : false
1081 "desc" : "(optional) The scope (this object) for the handler",
1082 "isOptional" : false
1088 "name" : "addEvents",
1089 "type" : "function",
1090 "desc" : "Used to define events on this Observable",
1093 "memberOf" : "Roo.util.Observable",
1095 "isConstructor" : false,
1096 "isPrivate" : false,
1107 "desc" : "The object with the events defined",
1108 "isOptional" : false
1114 "name" : "releaseCapture",
1115 "type" : "function",
1116 "desc" : "Removes <b>all</b> added captures from the Observable.",
1119 "memberOf" : "Roo.util.Observable",
1121 "isConstructor" : false,
1122 "isPrivate" : false,
1132 "type" : "Observable",
1133 "desc" : "The Observable to release",
1134 "isOptional" : false
1140 "name" : "removeListener",
1141 "type" : "function",
1142 "desc" : "Removes a listener",
1143 "sig" : "(eventName, handler, scope)",
1145 "memberOf" : "Roo.util.Observable",
1147 "isConstructor" : false,
1148 "isPrivate" : false,
1157 "name" : "eventName",
1159 "desc" : "The type of event to listen for",
1160 "isOptional" : false
1164 "type" : "Function",
1165 "desc" : "The handler to remove",
1166 "isOptional" : false
1171 "desc" : "(optional) The scope (this object) for the handler",
1172 "isOptional" : false
1178 "name" : "fireEvent",
1179 "type" : "function",
1180 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
1181 "sig" : "(eventName, args)",
1183 "memberOf" : "Roo.util.Observable",
1185 "isConstructor" : false,
1186 "isPrivate" : false,
1195 "name" : "eventName",
1198 "isOptional" : false
1202 "type" : "Object...",
1203 "desc" : "Variable number of parameters are passed to handlers",
1204 "isOptional" : false
1211 "desc" : "returns false if any of the handlers return false otherwise it returns true"
1216 "name" : "hasListener",
1217 "type" : "function",
1218 "desc" : "Checks to see if this object has any listeners for a specified event",
1219 "sig" : "(eventName)",
1221 "memberOf" : "Roo.util.Observable",
1223 "isConstructor" : false,
1224 "isPrivate" : false,
1233 "name" : "eventName",
1235 "desc" : "The name of the event to check for",
1236 "isOptional" : false
1243 "desc" : "True if the event is being listened for, else false"
1249 "type" : "function",
1250 "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.",
1251 "sig" : "(o, fn, scope)",
1253 "memberOf" : "Roo.util.Observable",
1255 "isConstructor" : false,
1256 "isPrivate" : false,
1266 "type" : "Observable",
1267 "desc" : "The Observable to capture",
1268 "isOptional" : false
1272 "type" : "Function",
1273 "desc" : "The function to call",
1274 "isOptional" : false
1279 "desc" : "(optional) The scope (this object) for the fn",
1280 "isOptional" : false
1286 "name" : "addListener",
1287 "type" : "function",
1288 "desc" : "Appends an event handler to this component",
1289 "sig" : "(eventName, handler, scope, options)",
1291 "memberOf" : "Roo.util.Observable",
1293 "isConstructor" : false,
1294 "isPrivate" : false,
1303 "name" : "eventName",
1305 "desc" : "The type of event to listen for",
1306 "isOptional" : false
1310 "type" : "Function",
1311 "desc" : "The method the event invokes",
1312 "isOptional" : false
1317 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1318 "isOptional" : false
1323 "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>",
1324 "isOptional" : false
1333 "type" : "function",
1334 "desc" : "Fires when this dialog is moved by the user.",
1335 "sig" : "function (_self, x, y)\n{\n\n}",
1344 "type" : "Roo.BasicDialog",
1346 "isOptional" : false
1351 "desc" : "The new page X",
1352 "isOptional" : false
1357 "desc" : "The new page Y",
1358 "isOptional" : false
1365 "type" : "function",
1366 "desc" : "Fires when this dialog is resized by the user.",
1367 "sig" : "function (_self, width, height)\n{\n\n}",
1376 "type" : "Roo.BasicDialog",
1378 "isOptional" : false
1383 "desc" : "The new width",
1384 "isOptional" : false
1389 "desc" : "The new height",
1390 "isOptional" : false
1396 "name" : "beforehide",
1397 "type" : "function",
1398 "desc" : "Fires before this dialog is hidden.",
1399 "sig" : "function (_self)\n{\n\n}",
1408 "type" : "Roo.BasicDialog",
1410 "isOptional" : false
1416 "name" : "beforeshow",
1417 "type" : "function",
1418 "desc" : "Fires before this dialog is shown.",
1419 "sig" : "function (_self)\n{\n\n}",
1428 "type" : "Roo.BasicDialog",
1430 "isOptional" : false
1437 "type" : "function",
1438 "desc" : "Fires when this dialog is hidden.",
1439 "sig" : "function (_self)\n{\n\n}",
1448 "type" : "Roo.BasicDialog",
1450 "isOptional" : false
1457 "type" : "function",
1458 "desc" : "Fires when this dialog is shown.",
1459 "sig" : "function (_self)\n{\n\n}",
1468 "type" : "Roo.BasicDialog",
1470 "isOptional" : false
1477 "type" : "function",
1478 "desc" : "Fires when a key is pressed",
1479 "sig" : "function (_self, e)\n{\n\n}",
1488 "type" : "Roo.BasicDialog",
1490 "isOptional" : false
1494 "type" : "Roo.EventObject",
1496 "isOptional" : false