2 "name" : "Roo.BasicDialog",
6 "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 "memberOf" : "BasicDialog",
18 "type" : "String/HTMLElement/Roo.Element",
19 "desc" : "The container element or DOM node, or its id",
25 "desc" : "Configuration options",
34 "desc" : "The default top page coordinate of the dialog (defaults to center screen)",
35 "memberOf" : "Roo.BasicDialog",
41 "desc" : "True to show the dialog modally, preventing user interaction with the rest of the page (defaults to false)",
42 "memberOf" : "Roo.BasicDialog",
48 "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>",
49 "memberOf" : "Roo.util.Observable",
53 "name" : "animateTarget",
54 "type" : "String/Element",
55 "desc" : "Id or element from which the dialog should animate while opening\n(defaults to null with no animation)",
56 "memberOf" : "Roo.BasicDialog",
61 "type" : "Boolean/String",
62 "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right\nshadow (defaults to false)",
63 "memberOf" : "Roo.BasicDialog",
67 "name" : "autoScroll",
69 "desc" : "True to allow the dialog body contents to overflow and display scrollbars (defaults to false)",
70 "memberOf" : "Roo.BasicDialog",
74 "name" : "collapsible",
76 "desc" : "False to remove the built-in top-right corner collapse button (defaults to true)",
77 "memberOf" : "Roo.BasicDialog",
83 "desc" : "If true, all elements with class 'x-dlg-tab' will get automatically converted to tabs (defaults to false)",
84 "memberOf" : "Roo.BasicDialog",
88 "name" : "shadowOffset",
90 "desc" : "The number of pixels to offset the shadow if displayed (defaults to 5)",
91 "memberOf" : "Roo.BasicDialog",
97 "desc" : "Array of buttons",
98 "memberOf" : "Roo.BasicDialog",
102 "name" : "minButtonWidth",
104 "desc" : "Minimum width of all dialog buttons (defaults to 75)",
105 "memberOf" : "Roo.BasicDialog",
111 "desc" : "Default text to display in the title bar (defaults to null)",
112 "memberOf" : "Roo.BasicDialog",
118 "desc" : "The minimum allowable width for a resizable dialog (defaults to 200)",
119 "memberOf" : "Roo.BasicDialog",
123 "name" : "buttonAlign",
125 "desc" : "Valid values are \"left,\" \"center\" and \"right\" (defaults to \"right\")",
126 "memberOf" : "Roo.BasicDialog",
130 "name" : "autoCreate",
131 "type" : "Boolean/DomHelper",
132 "desc" : "True to auto create from scratch, or using a DomHelper Object (defaults to false)",
133 "memberOf" : "Roo.BasicDialog",
137 "name" : "minHeight",
139 "desc" : "The minimum allowable height for a resizable dialog (defaults to 80)",
140 "memberOf" : "Roo.BasicDialog",
144 "name" : "proxyDrag",
146 "desc" : "True to drag a lightweight proxy element rather than the dialog itself, used when\ndraggable = true (defaults to false)",
147 "memberOf" : "Roo.BasicDialog",
153 "desc" : "True to create an iframe shim that prevents selects from showing through (defaults to false)",
154 "memberOf" : "Roo.BasicDialog",
160 "desc" : "Width of the dialog in pixels (can also be set via CSS). Determined by browser if unspecified.",
161 "memberOf" : "Roo.BasicDialog",
165 "name" : "constraintoviewport",
167 "desc" : "True to keep the dialog constrained within the visible viewport boundaries (defaults to true)",
168 "memberOf" : "Roo.BasicDialog",
172 "name" : "syncHeightBeforeShow",
174 "desc" : "True to cause the dimensions to be recalculated before the dialog is shown (defaults to false)",
175 "memberOf" : "Roo.BasicDialog",
181 "desc" : "The tag name of tab elements, used when autoTabs = true (defaults to 'div')",
182 "memberOf" : "Roo.BasicDialog",
186 "name" : "resizable",
188 "desc" : "False to disable manual dialog resizing (defaults to true)",
189 "memberOf" : "Roo.BasicDialog",
195 "desc" : "False to remove the built-in top-right corner close button (defaults to true)",
196 "memberOf" : "Roo.BasicDialog",
200 "name" : "fixedcenter",
202 "desc" : "True to ensure that anytime the dialog is shown or resized it gets centered (defaults to false)",
203 "memberOf" : "Roo.BasicDialog",
209 "desc" : "Height of the dialog in pixels (can also be set via CSS). Determined by browser if unspecified.",
210 "memberOf" : "Roo.BasicDialog",
214 "name" : "resizeHandles",
216 "desc" : "Which resize handles to display - see the {@link Roo.Resizable} handles config\nproperty for valid values (defaults to 'all')",
217 "memberOf" : "Roo.BasicDialog",
223 "desc" : "The default left page coordinate of the dialog (defaults to center screen)",
224 "memberOf" : "Roo.BasicDialog",
228 "name" : "draggable",
230 "desc" : "False to disable dragging of the dialog within the viewport (defaults to true)",
231 "memberOf" : "Roo.BasicDialog",
238 "desc" : "Expands a collapsed dialog back to its normal state. Equivalent to the user\nclicking the expand dialog button.",
240 "isConstructor" : false,
242 "memberOf" : "Roo.BasicDialog",
252 "desc" : "Aligns the dialog to the specified element",
254 "isConstructor" : false,
256 "memberOf" : "Roo.BasicDialog",
264 "type" : "String/HTMLElement/Roo.Element",
265 "desc" : "The element to align to.",
271 "desc" : "The position to align to (see {@link Roo.Element#alignTo} for more details).",
277 "desc" : "(optional) Offset the positioning by [x, y]",
284 "type" : "Roo.BasicDialog",
291 "desc" : "Sets the dialog title text",
293 "isConstructor" : false,
295 "memberOf" : "Roo.BasicDialog",
304 "desc" : "The title text to display",
311 "type" : "Roo.BasicDialog",
317 "name" : "isVisible",
318 "desc" : "Returns true if the dialog is visible",
320 "isConstructor" : false,
322 "memberOf" : "Roo.BasicDialog",
338 "desc" : "Resizes the dialog.",
340 "isConstructor" : false,
342 "memberOf" : "Roo.BasicDialog",
364 "type" : "Roo.BasicDialog",
371 "desc" : "Centers this dialog in the viewport",
373 "isConstructor" : false,
375 "memberOf" : "Roo.BasicDialog",
384 "type" : "Roo.BasicDialog",
391 "desc" : "Collapses the dialog to its minimized state (only the title bar is visible).\nEquivalent to the user clicking the collapse dialog button.",
393 "isConstructor" : false,
395 "memberOf" : "Roo.BasicDialog",
405 "desc" : "Reinitializes the tabs component, clearing out old tabs and finding new ones.",
407 "isConstructor" : false,
409 "memberOf" : "Roo.BasicDialog",
418 "type" : "Roo.TabPanel",
419 "desc" : "The tabs component"
425 "desc" : "Brings this dialog to the front of any other visible dialogs",
427 "isConstructor" : false,
429 "memberOf" : "Roo.BasicDialog",
438 "type" : "Roo.BasicDialog",
445 "desc" : "Moves the dialog's top-left corner to the specified point",
447 "isConstructor" : false,
449 "memberOf" : "Roo.BasicDialog",
471 "type" : "Roo.BasicDialog",
478 "desc" : "Hides the dialog.",
480 "isConstructor" : false,
482 "memberOf" : "Roo.BasicDialog",
491 "desc" : "(optional) Function to call when the dialog is hidden",
498 "type" : "Roo.BasicDialog",
505 "desc" : "Destroys this dialog and all its supporting elements (including any tabs, shim,\nshadow, proxy, mask, etc.) Also removes all event listeners.",
507 "isConstructor" : false,
509 "memberOf" : "Roo.BasicDialog",
518 "desc" : "(optional) true to remove the element from the DOM",
526 "desc" : "Shows the dialog.",
528 "isConstructor" : false,
530 "memberOf" : "Roo.BasicDialog",
537 "name" : "animateTarget",
538 "type" : "String/HTMLElement/Roo.Element",
539 "desc" : "(optional) Reset the animation target",
546 "type" : "Roo.BasicDialog",
553 "desc" : "Anchors an element to another element and realigns it when the window is resized.",
555 "isConstructor" : false,
557 "memberOf" : "Roo.BasicDialog",
565 "type" : "String/HTMLElement/Roo.Element",
566 "desc" : "The element to align to.",
572 "desc" : "The position to align to (see {@link Roo.Element#alignTo} for more details)",
578 "desc" : "(optional) Offset the positioning by [x, y]",
582 "name" : "monitorScroll",
583 "type" : "Boolean/Number",
584 "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).",
591 "type" : "Roo.BasicDialog",
597 "name" : "addButton",
598 "desc" : "Adds a button to the footer section of the dialog.",
600 "isConstructor" : false,
602 "memberOf" : "Roo.BasicDialog",
610 "type" : "String/Object",
611 "desc" : "A string becomes the button text, an object can either be a Button config\nobject or a valid Roo.DomHelper element config",
617 "desc" : "The function called when the button is clicked",
623 "desc" : "(optional) The scope of the handler function (accepts position as a property)",
630 "type" : "Roo.Button",
631 "desc" : "The new button"
636 "name" : "addKeyListener",
637 "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.",
639 "isConstructor" : false,
641 "memberOf" : "Roo.BasicDialog",
649 "type" : "Number/Array/Object",
650 "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)}",
656 "desc" : "The function to call",
662 "desc" : "(optional) The scope of the function",
669 "type" : "Roo.BasicDialog",
676 "desc" : "Focuses the dialog. If a defaultButton is set, it will receive focus, otherwise the\ndialog itself will receive focus.",
678 "isConstructor" : false,
680 "memberOf" : "Roo.BasicDialog",
690 "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.",
692 "isConstructor" : false,
694 "memberOf" : "Roo.BasicDialog",
703 "type" : "Roo.TabPanel",
704 "desc" : "The tabs component"
709 "name" : "setDefaultButton",
710 "desc" : "Sets the default button to be focused when the dialog is displayed.",
712 "isConstructor" : false,
714 "memberOf" : "Roo.BasicDialog",
722 "type" : "Roo.BasicDialog.Button",
723 "desc" : "The button object returned by {@link #addButton}",
730 "type" : "Roo.BasicDialog",
737 "desc" : "Sends this dialog to the back (under) of any other visible dialogs",
739 "isConstructor" : false,
741 "memberOf" : "Roo.BasicDialog",
750 "type" : "Roo.BasicDialog",
756 "name" : "setContentSize",
757 "desc" : "Resizes the dialog to fit the specified content size.",
759 "isConstructor" : false,
761 "memberOf" : "Roo.BasicDialog",
783 "type" : "Roo.BasicDialog",
789 "name" : "restoreState",
790 "desc" : "Restores the previous state of the dialog if Roo.state is configured.",
792 "isConstructor" : false,
794 "memberOf" : "Roo.BasicDialog",
803 "type" : "Roo.BasicDialog",
810 "desc" : "Returns the element for this dialog",
812 "isConstructor" : false,
814 "memberOf" : "Roo.BasicDialog",
823 "type" : "Roo.Element",
824 "desc" : "The underlying dialog Element"
829 "name" : "purgeListeners",
830 "desc" : "Removes all listeners for this object",
832 "isConstructor" : false,
834 "memberOf" : "Roo.util.Observable",
844 "desc" : "Appends an event handler to this element (shorthand for addListener)",
846 "isConstructor" : false,
848 "memberOf" : "Roo.util.Observable",
855 "name" : "eventName",
857 "desc" : "The type of event to listen for",
863 "desc" : "The method the event invokes",
869 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
875 "desc" : "(optional)",
883 "desc" : "Removes a listener (shorthand for removeListener)",
885 "isConstructor" : false,
887 "memberOf" : "Roo.util.Observable",
894 "name" : "eventName",
896 "desc" : "The type of event to listen for",
902 "desc" : "The handler to remove",
908 "desc" : "(optional) The scope (this object) for the handler",
915 "name" : "addEvents",
916 "desc" : "Used to define events on this Observable",
918 "isConstructor" : false,
920 "memberOf" : "Roo.util.Observable",
929 "desc" : "The object with the events defined",
936 "name" : "releaseCapture",
937 "desc" : "Removes <b>all</b> added captures from the Observable.",
939 "isConstructor" : false,
941 "memberOf" : "Roo.util.Observable",
949 "type" : "Observable",
950 "desc" : "The Observable to release",
957 "name" : "removeListener",
958 "desc" : "Removes a listener",
960 "isConstructor" : false,
962 "memberOf" : "Roo.util.Observable",
969 "name" : "eventName",
971 "desc" : "The type of event to listen for",
977 "desc" : "The handler to remove",
983 "desc" : "(optional) The scope (this object) for the handler",
990 "name" : "fireEvent",
991 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
993 "isConstructor" : false,
995 "memberOf" : "Roo.util.Observable",
1002 "name" : "eventName",
1005 "isOptional" : false
1009 "type" : "Object...",
1010 "desc" : "Variable number of parameters are passed to handlers",
1011 "isOptional" : false
1018 "desc" : "returns false if any of the handlers return false otherwise it returns true"
1023 "name" : "hasListener",
1024 "desc" : "Checks to see if this object has any listeners for a specified event",
1026 "isConstructor" : false,
1027 "isPrivate" : false,
1028 "memberOf" : "Roo.util.Observable",
1035 "name" : "eventName",
1037 "desc" : "The name of the event to check for",
1038 "isOptional" : false
1045 "desc" : "True if the event is being listened for, else false"
1051 "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.",
1053 "isConstructor" : false,
1054 "isPrivate" : false,
1055 "memberOf" : "Roo.util.Observable",
1063 "type" : "Observable",
1064 "desc" : "The Observable to capture",
1065 "isOptional" : false
1069 "type" : "Function",
1070 "desc" : "The function to call",
1071 "isOptional" : false
1076 "desc" : "(optional) The scope (this object) for the fn",
1077 "isOptional" : false
1083 "name" : "addListener",
1084 "desc" : "Appends an event handler to this component",
1086 "isConstructor" : false,
1087 "isPrivate" : false,
1088 "memberOf" : "Roo.util.Observable",
1095 "name" : "eventName",
1097 "desc" : "The type of event to listen for",
1098 "isOptional" : false
1102 "type" : "Function",
1103 "desc" : "The method the event invokes",
1104 "isOptional" : false
1109 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1110 "isOptional" : false
1115 "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>",
1116 "isOptional" : false
1125 "desc" : "Fires when this dialog is moved by the user.",
1126 "memberOf" : "Roo.BasicDialog",
1134 "type" : "Roo.BasicDialog",
1136 "isOptional" : false
1141 "desc" : "The new page X",
1142 "isOptional" : false
1147 "desc" : "The new page Y",
1148 "isOptional" : false
1155 "desc" : "Fires when this dialog is resized by the user.",
1156 "memberOf" : "Roo.BasicDialog",
1164 "type" : "Roo.BasicDialog",
1166 "isOptional" : false
1171 "desc" : "The new width",
1172 "isOptional" : false
1177 "desc" : "The new height",
1178 "isOptional" : false
1184 "name" : "beforehide",
1185 "desc" : "Fires before this dialog is hidden.",
1186 "memberOf" : "Roo.BasicDialog",
1194 "type" : "Roo.BasicDialog",
1196 "isOptional" : false
1202 "name" : "beforeshow",
1203 "desc" : "Fires before this dialog is shown.",
1204 "memberOf" : "Roo.BasicDialog",
1212 "type" : "Roo.BasicDialog",
1214 "isOptional" : false
1221 "desc" : "Fires when this dialog is hidden.",
1222 "memberOf" : "Roo.BasicDialog",
1230 "type" : "Roo.BasicDialog",
1232 "isOptional" : false
1239 "desc" : "Fires when this dialog is shown.",
1240 "memberOf" : "Roo.BasicDialog",
1248 "type" : "Roo.BasicDialog",
1250 "isOptional" : false
1257 "desc" : "Fires when a key is pressed",
1258 "memberOf" : "Roo.BasicDialog",
1266 "type" : "Roo.BasicDialog",
1268 "isOptional" : false
1272 "type" : "Roo.EventObject",
1274 "isOptional" : false