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",
35 "desc" : "The default top page coordinate of the dialog (defaults to center screen)",
36 "memberOf" : "Roo.BasicDialog",
43 "desc" : "True to show the dialog modally, preventing user interaction with the rest of the page (defaults to false)",
44 "memberOf" : "Roo.BasicDialog",
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",
57 "name" : "animateTarget",
58 "type" : "String/Element",
59 "desc" : "Id or element from which the dialog should animate while opening\n(defaults to null with no animation)",
60 "memberOf" : "Roo.BasicDialog",
66 "type" : "Boolean/String",
67 "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right\nshadow (defaults to false)",
68 "memberOf" : "Roo.BasicDialog",
73 "name" : "autoScroll",
75 "desc" : "True to allow the dialog body contents to overflow and display scrollbars (defaults to false)",
76 "memberOf" : "Roo.BasicDialog",
81 "name" : "collapsible",
83 "desc" : "False to remove the built-in top-right corner collapse button (defaults to true)",
84 "memberOf" : "Roo.BasicDialog",
91 "desc" : "If true, all elements with class 'x-dlg-tab' will get automatically converted to tabs (defaults to false)",
92 "memberOf" : "Roo.BasicDialog",
97 "name" : "shadowOffset",
99 "desc" : "The number of pixels to offset the shadow if displayed (defaults to 5)",
100 "memberOf" : "Roo.BasicDialog",
107 "desc" : "Array of buttons",
108 "memberOf" : "Roo.BasicDialog",
113 "name" : "minButtonWidth",
115 "desc" : "Minimum width of all dialog buttons (defaults to 75)",
116 "memberOf" : "Roo.BasicDialog",
123 "desc" : "Default text to display in the title bar (defaults to null)",
124 "memberOf" : "Roo.BasicDialog",
131 "desc" : "The minimum allowable width for a resizable dialog (defaults to 200)",
132 "memberOf" : "Roo.BasicDialog",
137 "name" : "buttonAlign",
139 "desc" : "Valid values are \"left,\" \"center\" and \"right\" (defaults to \"right\")",
140 "memberOf" : "Roo.BasicDialog",
145 "name" : "autoCreate",
146 "type" : "Boolean/DomHelper",
147 "desc" : "True to auto create from scratch, or using a DomHelper Object (defaults to false)",
148 "memberOf" : "Roo.BasicDialog",
153 "name" : "minHeight",
155 "desc" : "The minimum allowable height for a resizable dialog (defaults to 80)",
156 "memberOf" : "Roo.BasicDialog",
161 "name" : "proxyDrag",
163 "desc" : "True to drag a lightweight proxy element rather than the dialog itself, used when\ndraggable = true (defaults to false)",
164 "memberOf" : "Roo.BasicDialog",
171 "desc" : "True to create an iframe shim that prevents selects from showing through (defaults to false)",
172 "memberOf" : "Roo.BasicDialog",
179 "desc" : "Width of the dialog in pixels (can also be set via CSS). Determined by browser if unspecified.",
180 "memberOf" : "Roo.BasicDialog",
185 "name" : "constraintoviewport",
187 "desc" : "True to keep the dialog constrained within the visible viewport boundaries (defaults to true)",
188 "memberOf" : "Roo.BasicDialog",
193 "name" : "syncHeightBeforeShow",
195 "desc" : "True to cause the dimensions to be recalculated before the dialog is shown (defaults to false)",
196 "memberOf" : "Roo.BasicDialog",
203 "desc" : "The tag name of tab elements, used when autoTabs = true (defaults to 'div')",
204 "memberOf" : "Roo.BasicDialog",
209 "name" : "resizable",
211 "desc" : "False to disable manual dialog resizing (defaults to true)",
212 "memberOf" : "Roo.BasicDialog",
219 "desc" : "False to remove the built-in top-right corner close button (defaults to true)",
220 "memberOf" : "Roo.BasicDialog",
225 "name" : "fixedcenter",
227 "desc" : "True to ensure that anytime the dialog is shown or resized it gets centered (defaults to false)",
228 "memberOf" : "Roo.BasicDialog",
235 "desc" : "Height of the dialog in pixels (can also be set via CSS). Determined by browser if unspecified.",
236 "memberOf" : "Roo.BasicDialog",
241 "name" : "resizeHandles",
243 "desc" : "Which resize handles to display - see the {@link Roo.Resizable} handles config\nproperty for valid values (defaults to 'all')",
244 "memberOf" : "Roo.BasicDialog",
251 "desc" : "The default left page coordinate of the dialog (defaults to center screen)",
252 "memberOf" : "Roo.BasicDialog",
257 "name" : "draggable",
259 "desc" : "False to disable dragging of the dialog within the viewport (defaults to true)",
260 "memberOf" : "Roo.BasicDialog",
268 "desc" : "Expands a collapsed dialog back to its normal state. Equivalent to the user\nclicking the expand dialog button.",
270 "isConstructor" : false,
272 "memberOf" : "Roo.BasicDialog",
284 "desc" : "Aligns the dialog to the specified element",
286 "isConstructor" : false,
288 "memberOf" : "Roo.BasicDialog",
296 "type" : "String/HTMLElement/Roo.Element",
297 "desc" : "The element to align to.",
303 "desc" : "The position to align to (see {@link Roo.Element#alignTo} for more details).",
309 "desc" : "(optional) Offset the positioning by [x, y]",
316 "type" : "Roo.BasicDialog",
323 "desc" : "Sets the dialog title text",
325 "isConstructor" : false,
327 "memberOf" : "Roo.BasicDialog",
336 "desc" : "The title text to display",
343 "type" : "Roo.BasicDialog",
349 "name" : "isVisible",
350 "desc" : "Returns true if the dialog is visible",
352 "isConstructor" : false,
354 "memberOf" : "Roo.BasicDialog",
371 "desc" : "Resizes the dialog.",
373 "isConstructor" : false,
375 "memberOf" : "Roo.BasicDialog",
397 "type" : "Roo.BasicDialog",
404 "desc" : "Centers this dialog in the viewport",
406 "isConstructor" : false,
408 "memberOf" : "Roo.BasicDialog",
418 "type" : "Roo.BasicDialog",
425 "desc" : "Collapses the dialog to its minimized state (only the title bar is visible).\nEquivalent to the user clicking the collapse dialog button.",
427 "isConstructor" : false,
429 "memberOf" : "Roo.BasicDialog",
441 "desc" : "Reinitializes the tabs component, clearing out old tabs and finding new ones.",
443 "isConstructor" : false,
445 "memberOf" : "Roo.BasicDialog",
455 "type" : "Roo.TabPanel",
456 "desc" : "The tabs component"
462 "desc" : "Brings this dialog to the front of any other visible dialogs",
464 "isConstructor" : false,
466 "memberOf" : "Roo.BasicDialog",
476 "type" : "Roo.BasicDialog",
483 "desc" : "Moves the dialog's top-left corner to the specified point",
485 "isConstructor" : false,
487 "memberOf" : "Roo.BasicDialog",
509 "type" : "Roo.BasicDialog",
516 "desc" : "Hides the dialog.",
518 "isConstructor" : false,
520 "memberOf" : "Roo.BasicDialog",
529 "desc" : "(optional) Function to call when the dialog is hidden",
536 "type" : "Roo.BasicDialog",
543 "desc" : "Destroys this dialog and all its supporting elements (including any tabs, shim,\nshadow, proxy, mask, etc.) Also removes all event listeners.",
545 "isConstructor" : false,
547 "memberOf" : "Roo.BasicDialog",
556 "desc" : "(optional) true to remove the element from the DOM",
565 "desc" : "Shows the dialog.",
567 "isConstructor" : false,
569 "memberOf" : "Roo.BasicDialog",
576 "name" : "animateTarget",
577 "type" : "String/HTMLElement/Roo.Element",
578 "desc" : "(optional) Reset the animation target",
585 "type" : "Roo.BasicDialog",
592 "desc" : "Anchors an element to another element and realigns it when the window is resized.",
594 "isConstructor" : false,
596 "memberOf" : "Roo.BasicDialog",
604 "type" : "String/HTMLElement/Roo.Element",
605 "desc" : "The element to align to.",
611 "desc" : "The position to align to (see {@link Roo.Element#alignTo} for more details)",
617 "desc" : "(optional) Offset the positioning by [x, y]",
621 "name" : "monitorScroll",
622 "type" : "Boolean/Number",
623 "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).",
630 "type" : "Roo.BasicDialog",
636 "name" : "addButton",
637 "desc" : "Adds a button to the footer section of the dialog.",
639 "isConstructor" : false,
641 "memberOf" : "Roo.BasicDialog",
649 "type" : "String/Object",
650 "desc" : "A string becomes the button text, an object can either be a Button config\nobject or a valid Roo.DomHelper element config",
656 "desc" : "The function called when the button is clicked",
662 "desc" : "(optional) The scope of the handler function (accepts position as a property)",
669 "type" : "Roo.Button",
670 "desc" : "The new button"
675 "name" : "addKeyListener",
676 "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.",
678 "isConstructor" : false,
680 "memberOf" : "Roo.BasicDialog",
688 "type" : "Number/Array/Object",
689 "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)}",
695 "desc" : "The function to call",
701 "desc" : "(optional) The scope of the function",
708 "type" : "Roo.BasicDialog",
715 "desc" : "Focuses the dialog. If a defaultButton is set, it will receive focus, otherwise the\ndialog itself will receive focus.",
717 "isConstructor" : false,
719 "memberOf" : "Roo.BasicDialog",
731 "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.",
733 "isConstructor" : false,
735 "memberOf" : "Roo.BasicDialog",
745 "type" : "Roo.TabPanel",
746 "desc" : "The tabs component"
751 "name" : "setDefaultButton",
752 "desc" : "Sets the default button to be focused when the dialog is displayed.",
754 "isConstructor" : false,
756 "memberOf" : "Roo.BasicDialog",
764 "type" : "Roo.BasicDialog.Button",
765 "desc" : "The button object returned by {@link #addButton}",
772 "type" : "Roo.BasicDialog",
779 "desc" : "Sends this dialog to the back (under) of any other visible dialogs",
781 "isConstructor" : false,
783 "memberOf" : "Roo.BasicDialog",
793 "type" : "Roo.BasicDialog",
799 "name" : "setContentSize",
800 "desc" : "Resizes the dialog to fit the specified content size.",
802 "isConstructor" : false,
804 "memberOf" : "Roo.BasicDialog",
826 "type" : "Roo.BasicDialog",
832 "name" : "restoreState",
833 "desc" : "Restores the previous state of the dialog if Roo.state is configured.",
835 "isConstructor" : false,
837 "memberOf" : "Roo.BasicDialog",
847 "type" : "Roo.BasicDialog",
854 "desc" : "Returns the element for this dialog",
856 "isConstructor" : false,
858 "memberOf" : "Roo.BasicDialog",
868 "type" : "Roo.Element",
869 "desc" : "The underlying dialog Element"
874 "name" : "purgeListeners",
875 "desc" : "Removes all listeners for this object",
877 "isConstructor" : false,
879 "memberOf" : "Roo.util.Observable",
891 "desc" : "Appends an event handler to this element (shorthand for addListener)",
893 "isConstructor" : false,
895 "memberOf" : "Roo.util.Observable",
902 "name" : "eventName",
904 "desc" : "The type of event to listen for",
910 "desc" : "The method the event invokes",
916 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
922 "desc" : "(optional)",
931 "desc" : "Removes a listener (shorthand for removeListener)",
933 "isConstructor" : false,
935 "memberOf" : "Roo.util.Observable",
942 "name" : "eventName",
944 "desc" : "The type of event to listen for",
950 "desc" : "The handler to remove",
956 "desc" : "(optional) The scope (this object) for the handler",
964 "name" : "addEvents",
965 "desc" : "Used to define events on this Observable",
967 "isConstructor" : false,
969 "memberOf" : "Roo.util.Observable",
978 "desc" : "The object with the events defined",
986 "name" : "releaseCapture",
987 "desc" : "Removes <b>all</b> added captures from the Observable.",
989 "isConstructor" : false,
991 "memberOf" : "Roo.util.Observable",
999 "type" : "Observable",
1000 "desc" : "The Observable to release",
1001 "isOptional" : false
1008 "name" : "removeListener",
1009 "desc" : "Removes a listener",
1011 "isConstructor" : false,
1012 "isPrivate" : false,
1013 "memberOf" : "Roo.util.Observable",
1020 "name" : "eventName",
1022 "desc" : "The type of event to listen for",
1023 "isOptional" : false
1027 "type" : "Function",
1028 "desc" : "The handler to remove",
1029 "isOptional" : false
1034 "desc" : "(optional) The scope (this object) for the handler",
1035 "isOptional" : false
1042 "name" : "fireEvent",
1043 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
1045 "isConstructor" : false,
1046 "isPrivate" : false,
1047 "memberOf" : "Roo.util.Observable",
1054 "name" : "eventName",
1057 "isOptional" : false
1061 "type" : "Object...",
1062 "desc" : "Variable number of parameters are passed to handlers",
1063 "isOptional" : false
1070 "desc" : "returns false if any of the handlers return false otherwise it returns true"
1075 "name" : "hasListener",
1076 "desc" : "Checks to see if this object has any listeners for a specified event",
1078 "isConstructor" : false,
1079 "isPrivate" : false,
1080 "memberOf" : "Roo.util.Observable",
1087 "name" : "eventName",
1089 "desc" : "The name of the event to check for",
1090 "isOptional" : false
1097 "desc" : "True if the event is being listened for, else false"
1103 "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.",
1105 "isConstructor" : false,
1106 "isPrivate" : false,
1107 "memberOf" : "Roo.util.Observable",
1115 "type" : "Observable",
1116 "desc" : "The Observable to capture",
1117 "isOptional" : false
1121 "type" : "Function",
1122 "desc" : "The function to call",
1123 "isOptional" : false
1128 "desc" : "(optional) The scope (this object) for the fn",
1129 "isOptional" : false
1136 "name" : "addListener",
1137 "desc" : "Appends an event handler to this component",
1139 "isConstructor" : false,
1140 "isPrivate" : false,
1141 "memberOf" : "Roo.util.Observable",
1148 "name" : "eventName",
1150 "desc" : "The type of event to listen for",
1151 "isOptional" : false
1155 "type" : "Function",
1156 "desc" : "The method the event invokes",
1157 "isOptional" : false
1162 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1163 "isOptional" : false
1168 "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>",
1169 "isOptional" : false
1179 "desc" : "Fires when this dialog is moved by the user.",
1180 "memberOf" : "Roo.BasicDialog",
1188 "type" : "Roo.BasicDialog",
1190 "isOptional" : false
1195 "desc" : "The new page X",
1196 "isOptional" : false
1201 "desc" : "The new page Y",
1202 "isOptional" : false
1210 "desc" : "Fires when this dialog is resized by the user.",
1211 "memberOf" : "Roo.BasicDialog",
1219 "type" : "Roo.BasicDialog",
1221 "isOptional" : false
1226 "desc" : "The new width",
1227 "isOptional" : false
1232 "desc" : "The new height",
1233 "isOptional" : false
1240 "name" : "beforehide",
1241 "desc" : "Fires before this dialog is hidden.",
1242 "memberOf" : "Roo.BasicDialog",
1250 "type" : "Roo.BasicDialog",
1252 "isOptional" : false
1259 "name" : "beforeshow",
1260 "desc" : "Fires before this dialog is shown.",
1261 "memberOf" : "Roo.BasicDialog",
1269 "type" : "Roo.BasicDialog",
1271 "isOptional" : false
1279 "desc" : "Fires when this dialog is hidden.",
1280 "memberOf" : "Roo.BasicDialog",
1288 "type" : "Roo.BasicDialog",
1290 "isOptional" : false
1298 "desc" : "Fires when this dialog is shown.",
1299 "memberOf" : "Roo.BasicDialog",
1307 "type" : "Roo.BasicDialog",
1309 "isOptional" : false
1317 "desc" : "Fires when a key is pressed",
1318 "memberOf" : "Roo.BasicDialog",
1326 "type" : "Roo.BasicDialog",
1328 "isOptional" : false
1332 "type" : "Roo.EventObject",
1334 "isOptional" : false