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)",
54 "desc" : "True to show the dialog modally, preventing user interaction with the rest of the page (defaults to false)",
60 "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>",
61 "memberOf" : "Roo.util.Observable"
64 "name" : "animateTarget",
65 "type" : "String/Element",
66 "desc" : "Id or element from which the dialog should animate while opening\n(defaults to null with no animation)",
71 "type" : "Boolean/String",
72 "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right\nshadow (defaults to false)",
76 "name" : "autoScroll",
78 "desc" : "True to allow the dialog body contents to overflow and display scrollbars (defaults to false)",
82 "name" : "collapsible",
84 "desc" : "False to remove the built-in top-right corner collapse button (defaults to true)",
90 "desc" : "If true, all elements with class 'x-dlg-tab' will get automatically converted to tabs (defaults to false)",
94 "name" : "shadowOffset",
96 "desc" : "The number of pixels to offset the shadow if displayed (defaults to 5)",
102 "desc" : "Array of buttons",
106 "name" : "minButtonWidth",
108 "desc" : "Minimum width of all dialog buttons (defaults to 75)",
114 "desc" : "Default text to display in the title bar (defaults to null)",
120 "desc" : "The minimum allowable width for a resizable dialog (defaults to 200)",
124 "name" : "buttonAlign",
126 "desc" : "Valid values are \"left,\" \"center\" and \"right\" (defaults to \"right\")",
130 "name" : "autoCreate",
131 "type" : "Boolean/DomHelper",
132 "desc" : "True to auto create from scratch, or using a DomHelper Object (defaults to false)",
136 "name" : "minHeight",
138 "desc" : "The minimum allowable height for a resizable dialog (defaults to 80)",
142 "name" : "proxyDrag",
144 "desc" : "True to drag a lightweight proxy element rather than the dialog itself, used when\ndraggable = true (defaults to false)",
150 "desc" : "True to create an iframe shim that prevents selects from showing through (defaults to false)",
156 "desc" : "Width of the dialog in pixels (can also be set via CSS). Determined by browser if unspecified.",
160 "name" : "constraintoviewport",
162 "desc" : "True to keep the dialog constrained within the visible viewport boundaries (defaults to true)",
166 "name" : "syncHeightBeforeShow",
168 "desc" : "True to cause the dimensions to be recalculated before the dialog is shown (defaults to false)",
174 "desc" : "The tag name of tab elements, used when autoTabs = true (defaults to 'div')",
178 "name" : "resizable",
180 "desc" : "False to disable manual dialog resizing (defaults to true)",
186 "desc" : "False to remove the built-in top-right corner close button (defaults to true)",
190 "name" : "fixedcenter",
192 "desc" : "True to ensure that anytime the dialog is shown or resized it gets centered (defaults to false)",
198 "desc" : "Height of the dialog in pixels (can also be set via CSS). Determined by browser if unspecified.",
202 "name" : "resizeHandles",
204 "desc" : "Which resize handles to display - see the {@link Roo.Resizable} handles config\nproperty for valid values (defaults to 'all')",
210 "desc" : "The default left page coordinate of the dialog (defaults to center screen)",
214 "name" : "draggable",
216 "desc" : "False to disable dragging of the dialog within the viewport (defaults to true)",
224 "desc" : "Expands a collapsed dialog back to its normal state. Equivalent to the user\nclicking the expand dialog button.",
225 "sig" : "()\n{\n\n}",
229 "isConstructor" : false,
243 "desc" : "Aligns the dialog to the specified element",
244 "sig" : "(element, position, offsets)",
248 "isConstructor" : false,
259 "type" : "String/HTMLElement/Roo.Element",
260 "desc" : "The element to align to.",
266 "desc" : "The position to align to (see {@link Roo.Element#alignTo} for more details).",
272 "desc" : "(optional) Offset the positioning by [x, y]",
279 "type" : "Roo.BasicDialog",
287 "desc" : "Sets the dialog title text",
292 "isConstructor" : false,
304 "desc" : "The title text to display",
311 "type" : "Roo.BasicDialog",
317 "name" : "isVisible",
319 "desc" : "Returns true if the dialog is visible",
320 "sig" : "()\n{\n\n}",
324 "isConstructor" : false,
344 "desc" : "Resizes the dialog.",
345 "sig" : "(width, height)",
349 "isConstructor" : false,
374 "type" : "Roo.BasicDialog",
382 "desc" : "Centers this dialog in the viewport",
383 "sig" : "()\n{\n\n}",
387 "isConstructor" : false,
399 "type" : "Roo.BasicDialog",
407 "desc" : "Collapses the dialog to its minimized state (only the title bar is visible).\nEquivalent to the user clicking the collapse dialog button.",
408 "sig" : "()\n{\n\n}",
412 "isConstructor" : false,
426 "desc" : "Reinitializes the tabs component, clearing out old tabs and finding new ones.",
427 "sig" : "()\n{\n\n}",
431 "isConstructor" : false,
443 "type" : "Roo.TabPanel",
444 "desc" : "The tabs component"
451 "desc" : "Brings this dialog to the front of any other visible dialogs",
452 "sig" : "()\n{\n\n}",
456 "isConstructor" : false,
468 "type" : "Roo.BasicDialog",
476 "desc" : "Moves the dialog's top-left corner to the specified point",
481 "isConstructor" : false,
506 "type" : "Roo.BasicDialog",
514 "desc" : "Hides the dialog.",
515 "sig" : "(callback)",
519 "isConstructor" : false,
531 "desc" : "(optional) Function to call when the dialog is hidden",
538 "type" : "Roo.BasicDialog",
546 "desc" : "Destroys this dialog and all its supporting elements (including any tabs, shim,\nshadow, proxy, mask, etc.) Also removes all event listeners.",
547 "sig" : "(removeEl)",
551 "isConstructor" : false,
563 "desc" : "(optional) true to remove the element from the DOM",
572 "desc" : "Shows the dialog.",
573 "sig" : "(animateTarget)",
577 "isConstructor" : false,
587 "name" : "animateTarget",
588 "type" : "String/HTMLElement/Roo.Element",
589 "desc" : "(optional) Reset the animation target",
596 "type" : "Roo.BasicDialog",
604 "desc" : "Anchors an element to another element and realigns it when the window is resized.",
605 "sig" : "(element, position, offsets, monitorScroll)",
609 "isConstructor" : false,
620 "type" : "String/HTMLElement/Roo.Element",
621 "desc" : "The element to align to.",
627 "desc" : "The position to align to (see {@link Roo.Element#alignTo} for more details)",
633 "desc" : "(optional) Offset the positioning by [x, y]",
637 "name" : "monitorScroll",
638 "type" : "Boolean/Number",
639 "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).",
646 "type" : "Roo.BasicDialog",
652 "name" : "addButton",
654 "desc" : "Adds a button to the footer section of the dialog.",
655 "sig" : "(config, handler, scope)",
659 "isConstructor" : false,
670 "type" : "String/Object",
671 "desc" : "A string becomes the button text, an object can either be a Button config\nobject or a valid Roo.DomHelper element config",
677 "desc" : "The function called when the button is clicked",
683 "desc" : "(optional) The scope of the handler function (accepts position as a property)",
690 "type" : "Roo.Button",
691 "desc" : "The new button"
696 "name" : "addKeyListener",
698 "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.",
699 "sig" : "(key, fn, scope)",
703 "isConstructor" : false,
714 "type" : "Number/Array/Object",
715 "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)}",
721 "desc" : "The function to call",
727 "desc" : "(optional) The scope of the function",
734 "type" : "Roo.BasicDialog",
742 "desc" : "Focuses the dialog. If a defaultButton is set, it will receive focus, otherwise the\ndialog itself will receive focus.",
743 "sig" : "()\n{\n\n}",
747 "isConstructor" : false,
761 "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.",
762 "sig" : "()\n{\n\n}",
766 "isConstructor" : false,
778 "type" : "Roo.TabPanel",
779 "desc" : "The tabs component"
784 "name" : "setDefaultButton",
786 "desc" : "Sets the default button to be focused when the dialog is displayed.",
791 "isConstructor" : false,
802 "type" : "Roo.BasicDialog.Button",
803 "desc" : "The button object returned by {@link #addButton}",
810 "type" : "Roo.BasicDialog",
818 "desc" : "Sends this dialog to the back (under) of any other visible dialogs",
819 "sig" : "()\n{\n\n}",
823 "isConstructor" : false,
835 "type" : "Roo.BasicDialog",
841 "name" : "setContentSize",
843 "desc" : "Resizes the dialog to fit the specified content size.",
844 "sig" : "(width, height)",
848 "isConstructor" : false,
873 "type" : "Roo.BasicDialog",
879 "name" : "restoreState",
881 "desc" : "Restores the previous state of the dialog if Roo.state is configured.",
882 "sig" : "()\n{\n\n}",
886 "isConstructor" : false,
898 "type" : "Roo.BasicDialog",
906 "desc" : "Returns the element for this dialog",
907 "sig" : "()\n{\n\n}",
911 "isConstructor" : false,
923 "type" : "Roo.Element",
924 "desc" : "The underlying dialog Element"
929 "name" : "purgeListeners",
931 "desc" : "Removes all listeners for this object",
932 "sig" : "()\n{\n\n}",
934 "memberOf" : "Roo.util.Observable",
936 "isConstructor" : false,
950 "desc" : "Appends an event handler to this element (shorthand for addListener)",
951 "sig" : "(eventName, handler, scope, options)",
953 "memberOf" : "Roo.util.Observable",
955 "isConstructor" : false,
965 "name" : "eventName",
967 "desc" : "The type of event to listen for",
973 "desc" : "The method the event invokes",
979 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
985 "desc" : "(optional)",
994 "desc" : "Removes a listener (shorthand for removeListener)",
995 "sig" : "(eventName, handler, scope)",
997 "memberOf" : "Roo.util.Observable",
999 "isConstructor" : false,
1000 "isPrivate" : false,
1009 "name" : "eventName",
1011 "desc" : "The type of event to listen for",
1012 "isOptional" : false
1016 "type" : "Function",
1017 "desc" : "The handler to remove",
1018 "isOptional" : false
1023 "desc" : "(optional) The scope (this object) for the handler",
1024 "isOptional" : false
1030 "name" : "addEvents",
1031 "type" : "function",
1032 "desc" : "Used to define events on this Observable",
1035 "memberOf" : "Roo.util.Observable",
1037 "isConstructor" : false,
1038 "isPrivate" : false,
1049 "desc" : "The object with the events defined",
1050 "isOptional" : false
1056 "name" : "releaseCapture",
1057 "type" : "function",
1058 "desc" : "Removes <b>all</b> added captures from the Observable.",
1061 "memberOf" : "Roo.util.Observable",
1063 "isConstructor" : false,
1064 "isPrivate" : false,
1074 "type" : "Observable",
1075 "desc" : "The Observable to release",
1076 "isOptional" : false
1082 "name" : "removeListener",
1083 "type" : "function",
1084 "desc" : "Removes a listener",
1085 "sig" : "(eventName, handler, scope)",
1087 "memberOf" : "Roo.util.Observable",
1089 "isConstructor" : false,
1090 "isPrivate" : false,
1099 "name" : "eventName",
1101 "desc" : "The type of event to listen for",
1102 "isOptional" : false
1106 "type" : "Function",
1107 "desc" : "The handler to remove",
1108 "isOptional" : false
1113 "desc" : "(optional) The scope (this object) for the handler",
1114 "isOptional" : false
1120 "name" : "fireEvent",
1121 "type" : "function",
1122 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
1123 "sig" : "(eventName, args)",
1125 "memberOf" : "Roo.util.Observable",
1127 "isConstructor" : false,
1128 "isPrivate" : false,
1137 "name" : "eventName",
1140 "isOptional" : false
1144 "type" : "Object...",
1145 "desc" : "Variable number of parameters are passed to handlers",
1146 "isOptional" : false
1153 "desc" : "returns false if any of the handlers return false otherwise it returns true"
1158 "name" : "hasListener",
1159 "type" : "function",
1160 "desc" : "Checks to see if this object has any listeners for a specified event",
1161 "sig" : "(eventName)",
1163 "memberOf" : "Roo.util.Observable",
1165 "isConstructor" : false,
1166 "isPrivate" : false,
1175 "name" : "eventName",
1177 "desc" : "The name of the event to check for",
1178 "isOptional" : false
1185 "desc" : "True if the event is being listened for, else false"
1191 "type" : "function",
1192 "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.",
1193 "sig" : "(o, fn, scope)",
1195 "memberOf" : "Roo.util.Observable",
1197 "isConstructor" : false,
1198 "isPrivate" : false,
1208 "type" : "Observable",
1209 "desc" : "The Observable to capture",
1210 "isOptional" : false
1214 "type" : "Function",
1215 "desc" : "The function to call",
1216 "isOptional" : false
1221 "desc" : "(optional) The scope (this object) for the fn",
1222 "isOptional" : false
1228 "name" : "addListener",
1229 "type" : "function",
1230 "desc" : "Appends an event handler to this component",
1231 "sig" : "(eventName, handler, scope, options)",
1233 "memberOf" : "Roo.util.Observable",
1235 "isConstructor" : false,
1236 "isPrivate" : false,
1245 "name" : "eventName",
1247 "desc" : "The type of event to listen for",
1248 "isOptional" : false
1252 "type" : "Function",
1253 "desc" : "The method the event invokes",
1254 "isOptional" : false
1259 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1260 "isOptional" : false
1265 "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>",
1266 "isOptional" : false
1275 "type" : "function",
1276 "desc" : "Fires when this dialog is moved by the user.",
1277 "sig" : "function (_self, x, y)\n{\n\n}",
1286 "type" : "Roo.BasicDialog",
1288 "isOptional" : false
1293 "desc" : "The new page X",
1294 "isOptional" : false
1299 "desc" : "The new page Y",
1300 "isOptional" : false
1307 "type" : "function",
1308 "desc" : "Fires when this dialog is resized by the user.",
1309 "sig" : "function (_self, width, height)\n{\n\n}",
1318 "type" : "Roo.BasicDialog",
1320 "isOptional" : false
1325 "desc" : "The new width",
1326 "isOptional" : false
1331 "desc" : "The new height",
1332 "isOptional" : false
1338 "name" : "beforehide",
1339 "type" : "function",
1340 "desc" : "Fires before this dialog is hidden.",
1341 "sig" : "function (_self)\n{\n\n}",
1350 "type" : "Roo.BasicDialog",
1352 "isOptional" : false
1358 "name" : "beforeshow",
1359 "type" : "function",
1360 "desc" : "Fires before this dialog is shown.",
1361 "sig" : "function (_self)\n{\n\n}",
1370 "type" : "Roo.BasicDialog",
1372 "isOptional" : false
1379 "type" : "function",
1380 "desc" : "Fires when this dialog is hidden.",
1381 "sig" : "function (_self)\n{\n\n}",
1390 "type" : "Roo.BasicDialog",
1392 "isOptional" : false
1399 "type" : "function",
1400 "desc" : "Fires when this dialog is shown.",
1401 "sig" : "function (_self)\n{\n\n}",
1410 "type" : "Roo.BasicDialog",
1412 "isOptional" : false
1419 "type" : "function",
1420 "desc" : "Fires when a key is pressed",
1421 "sig" : "function (_self, e)\n{\n\n}",
1430 "type" : "Roo.BasicDialog",
1432 "isOptional" : false
1436 "type" : "Roo.EventObject",
1438 "isOptional" : false