2 "name" : "Roo.LayoutDialog",
7 "desc" : "Dialog which provides adjustments for working with a layout in a Dialog.\nAdd your necessary layout config options to the dialog's config.<br>\nExample usage (including a nested layout):\n<pre><code>\nif(!dialog){\n dialog = new Roo.LayoutDialog(\"download-dlg\", {\n modal: true,\n width:600,\n height:450,\n shadow:true,\n minWidth:500,\n minHeight:350,\n autoTabs:true,\n proxyDrag:true,\n // layout config merges with the dialog config\n center:{\n tabPosition: \"top\",\n alwaysShowTabs: true\n }\n });\n dialog.addKeyListener(27, dialog.hide, dialog);\n dialog.setDefaultButton(dialog.addButton(\"Close\", dialog.hide, dialog));\n dialog.addButton(\"Build It!\", this.getDownload, this);\n\n // we can even add nested layouts\n var innerLayout = new Roo.BorderLayout(\"dl-inner\", {\n east: {\n initialSize: 200,\n autoScroll:true,\n split:true\n },\n center: {\n autoScroll:true\n }\n });\n innerLayout.beginUpdate();\n innerLayout.add(\"east\", new Roo.ContentPanel(\"dl-details\"));\n innerLayout.add(\"center\", new Roo.ContentPanel(\"selection-panel\"));\n innerLayout.endUpdate(true);\n\n var layout = dialog.getLayout();\n layout.beginUpdate();\n layout.add(\"center\", new Roo.ContentPanel(\"standard-panel\",\n {title: \"Download the Source\", fitToFrame:true}));\n layout.add(\"center\", new Roo.NestedLayoutPanel(innerLayout,\n {title: \"Build your own roo.js\"}));\n layout.getRegion(\"center\").showPanel(sp);\n layout.endUpdate();\n}\n</code></pre>",
11 "memberOf" : "LayoutDialog",
19 "type" : "String/HTMLElement/Roo.Element",
20 "desc" : "The id of or container element, or config",
26 "desc" : "configuration options",
35 "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>",
36 "memberOf" : "Roo.util.Observable",
42 "desc" : "The default top page coordinate of the dialog (defaults to center screen)",
43 "memberOf" : "Roo.BasicDialog",
49 "desc" : "True to show the dialog modally, preventing user interaction with the rest of the page (defaults to false)",
50 "memberOf" : "Roo.BasicDialog",
54 "name" : "animateTarget",
55 "type" : "String/Element",
56 "desc" : "Id or element from which the dialog should animate while opening\n(defaults to null with no animation)",
57 "memberOf" : "Roo.BasicDialog",
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)",
64 "memberOf" : "Roo.BasicDialog",
68 "name" : "autoScroll",
70 "desc" : "True to allow the dialog body contents to overflow and display scrollbars (defaults to false)",
71 "memberOf" : "Roo.BasicDialog",
75 "name" : "collapsible",
77 "desc" : "False to remove the built-in top-right corner collapse button (defaults to true)",
78 "memberOf" : "Roo.BasicDialog",
84 "desc" : "If true, all elements with class 'x-dlg-tab' will get automatically converted to tabs (defaults to false)",
85 "memberOf" : "Roo.BasicDialog",
89 "name" : "shadowOffset",
91 "desc" : "The number of pixels to offset the shadow if displayed (defaults to 5)",
92 "memberOf" : "Roo.BasicDialog",
98 "desc" : "Array of buttons",
99 "memberOf" : "Roo.BasicDialog",
103 "name" : "minButtonWidth",
105 "desc" : "Minimum width of all dialog buttons (defaults to 75)",
106 "memberOf" : "Roo.BasicDialog",
112 "desc" : "Default text to display in the title bar (defaults to null)",
113 "memberOf" : "Roo.BasicDialog",
119 "desc" : "The minimum allowable width for a resizable dialog (defaults to 200)",
120 "memberOf" : "Roo.BasicDialog",
124 "name" : "buttonAlign",
126 "desc" : "Valid values are \"left,\" \"center\" and \"right\" (defaults to \"right\")",
127 "memberOf" : "Roo.BasicDialog",
131 "name" : "autoCreate",
132 "type" : "Boolean/DomHelper",
133 "desc" : "True to auto create from scratch, or using a DomHelper Object (defaults to false)",
134 "memberOf" : "Roo.BasicDialog",
138 "name" : "minHeight",
140 "desc" : "The minimum allowable height for a resizable dialog (defaults to 80)",
141 "memberOf" : "Roo.BasicDialog",
145 "name" : "proxyDrag",
147 "desc" : "True to drag a lightweight proxy element rather than the dialog itself, used when\ndraggable = true (defaults to false)",
148 "memberOf" : "Roo.BasicDialog",
154 "desc" : "True to create an iframe shim that prevents selects from showing through (defaults to false)",
155 "memberOf" : "Roo.BasicDialog",
161 "desc" : "Width of the dialog in pixels (can also be set via CSS). Determined by browser if unspecified.",
162 "memberOf" : "Roo.BasicDialog",
166 "name" : "constraintoviewport",
168 "desc" : "True to keep the dialog constrained within the visible viewport boundaries (defaults to true)",
169 "memberOf" : "Roo.BasicDialog",
173 "name" : "syncHeightBeforeShow",
175 "desc" : "True to cause the dimensions to be recalculated before the dialog is shown (defaults to false)",
176 "memberOf" : "Roo.BasicDialog",
182 "desc" : "The tag name of tab elements, used when autoTabs = true (defaults to 'div')",
183 "memberOf" : "Roo.BasicDialog",
187 "name" : "resizable",
189 "desc" : "False to disable manual dialog resizing (defaults to true)",
190 "memberOf" : "Roo.BasicDialog",
196 "desc" : "False to remove the built-in top-right corner close button (defaults to true)",
197 "memberOf" : "Roo.BasicDialog",
201 "name" : "fixedcenter",
203 "desc" : "True to ensure that anytime the dialog is shown or resized it gets centered (defaults to false)",
204 "memberOf" : "Roo.BasicDialog",
210 "desc" : "Height of the dialog in pixels (can also be set via CSS). Determined by browser if unspecified.",
211 "memberOf" : "Roo.BasicDialog",
215 "name" : "resizeHandles",
217 "desc" : "Which resize handles to display - see the {@link Roo.Resizable} handles config\nproperty for valid values (defaults to 'all')",
218 "memberOf" : "Roo.BasicDialog",
224 "desc" : "The default left page coordinate of the dialog (defaults to center screen)",
225 "memberOf" : "Roo.BasicDialog",
229 "name" : "draggable",
231 "desc" : "False to disable dragging of the dialog within the viewport (defaults to true)",
232 "memberOf" : "Roo.BasicDialog",
239 "desc" : "Add an xtype element (actually adds to the layout.)",
241 "isConstructor" : false,
243 "memberOf" : "Roo.LayoutDialog",
253 "desc" : "xdata xtype object data."
258 "name" : "getLayout",
259 "desc" : "Get the BorderLayout for this dialog",
261 "isConstructor" : false,
263 "memberOf" : "Roo.LayoutDialog",
272 "type" : "Roo.BorderLayout",
278 "name" : "endUpdate",
279 "desc" : "Ends update of the layout <strike>and resets display to none</strike>. Use standard beginUpdate/endUpdate on the layout.",
281 "isConstructor" : false,
283 "memberOf" : "Roo.LayoutDialog",
285 "deprecated" : "This has been deprecated: ",
292 "name" : "beginUpdate",
293 "desc" : "Begins an update of the layout <strike>and sets display to block and visibility to hidden</strike>. Use standard beginUpdate/endUpdate on the layout.",
295 "isConstructor" : false,
297 "memberOf" : "Roo.LayoutDialog",
299 "deprecated" : "This has been deprecated: ",
307 "desc" : "Expands a collapsed dialog back to its normal state. Equivalent to the user\nclicking the expand dialog button.",
309 "isConstructor" : false,
311 "memberOf" : "Roo.BasicDialog",
321 "desc" : "Aligns the dialog to the specified element",
323 "isConstructor" : false,
325 "memberOf" : "Roo.BasicDialog",
333 "type" : "String/HTMLElement/Roo.Element",
334 "desc" : "The element to align to.",
340 "desc" : "The position to align to (see {@link Roo.Element#alignTo} for more details).",
346 "desc" : "(optional) Offset the positioning by [x, y]",
353 "type" : "Roo.BasicDialog",
360 "desc" : "Sets the dialog title text",
362 "isConstructor" : false,
364 "memberOf" : "Roo.BasicDialog",
373 "desc" : "The title text to display",
380 "type" : "Roo.BasicDialog",
386 "name" : "isVisible",
387 "desc" : "Returns true if the dialog is visible",
389 "isConstructor" : false,
391 "memberOf" : "Roo.BasicDialog",
407 "desc" : "Resizes the dialog.",
409 "isConstructor" : false,
411 "memberOf" : "Roo.BasicDialog",
433 "type" : "Roo.BasicDialog",
440 "desc" : "Centers this dialog in the viewport",
442 "isConstructor" : false,
444 "memberOf" : "Roo.BasicDialog",
453 "type" : "Roo.BasicDialog",
460 "desc" : "Collapses the dialog to its minimized state (only the title bar is visible).\nEquivalent to the user clicking the collapse dialog button.",
462 "isConstructor" : false,
464 "memberOf" : "Roo.BasicDialog",
474 "desc" : "Reinitializes the tabs component, clearing out old tabs and finding new ones.",
476 "isConstructor" : false,
478 "memberOf" : "Roo.BasicDialog",
487 "type" : "Roo.TabPanel",
488 "desc" : "The tabs component"
494 "desc" : "Brings this dialog to the front of any other visible dialogs",
496 "isConstructor" : false,
498 "memberOf" : "Roo.BasicDialog",
507 "type" : "Roo.BasicDialog",
514 "desc" : "Moves the dialog's top-left corner to the specified point",
516 "isConstructor" : false,
518 "memberOf" : "Roo.BasicDialog",
540 "type" : "Roo.BasicDialog",
547 "desc" : "Hides the dialog.",
549 "isConstructor" : false,
551 "memberOf" : "Roo.BasicDialog",
560 "desc" : "(optional) Function to call when the dialog is hidden",
567 "type" : "Roo.BasicDialog",
574 "desc" : "Destroys this dialog and all its supporting elements (including any tabs, shim,\nshadow, proxy, mask, etc.) Also removes all event listeners.",
576 "isConstructor" : false,
578 "memberOf" : "Roo.BasicDialog",
587 "desc" : "(optional) true to remove the element from the DOM",
595 "desc" : "Shows the dialog.",
597 "isConstructor" : false,
599 "memberOf" : "Roo.BasicDialog",
606 "name" : "animateTarget",
607 "type" : "String/HTMLElement/Roo.Element",
608 "desc" : "(optional) Reset the animation target",
615 "type" : "Roo.BasicDialog",
622 "desc" : "Anchors an element to another element and realigns it when the window is resized.",
624 "isConstructor" : false,
626 "memberOf" : "Roo.BasicDialog",
634 "type" : "String/HTMLElement/Roo.Element",
635 "desc" : "The element to align to.",
641 "desc" : "The position to align to (see {@link Roo.Element#alignTo} for more details)",
647 "desc" : "(optional) Offset the positioning by [x, y]",
651 "name" : "monitorScroll",
652 "type" : "Boolean/Number",
653 "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).",
660 "type" : "Roo.BasicDialog",
666 "name" : "addButton",
667 "desc" : "Adds a button to the footer section of the dialog.",
669 "isConstructor" : false,
671 "memberOf" : "Roo.BasicDialog",
679 "type" : "String/Object",
680 "desc" : "A string becomes the button text, an object can either be a Button config\nobject or a valid Roo.DomHelper element config",
686 "desc" : "The function called when the button is clicked",
692 "desc" : "(optional) The scope of the handler function (accepts position as a property)",
699 "type" : "Roo.Button",
700 "desc" : "The new button"
705 "name" : "addKeyListener",
706 "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.",
708 "isConstructor" : false,
710 "memberOf" : "Roo.BasicDialog",
718 "type" : "Number/Array/Object",
719 "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)}",
725 "desc" : "The function to call",
731 "desc" : "(optional) The scope of the function",
738 "type" : "Roo.BasicDialog",
745 "desc" : "Focuses the dialog. If a defaultButton is set, it will receive focus, otherwise the\ndialog itself will receive focus.",
747 "isConstructor" : false,
749 "memberOf" : "Roo.BasicDialog",
759 "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.",
761 "isConstructor" : false,
763 "memberOf" : "Roo.BasicDialog",
772 "type" : "Roo.TabPanel",
773 "desc" : "The tabs component"
778 "name" : "setDefaultButton",
779 "desc" : "Sets the default button to be focused when the dialog is displayed.",
781 "isConstructor" : false,
783 "memberOf" : "Roo.BasicDialog",
791 "type" : "Roo.BasicDialog.Button",
792 "desc" : "The button object returned by {@link #addButton}",
799 "type" : "Roo.BasicDialog",
806 "desc" : "Sends this dialog to the back (under) of any other visible dialogs",
808 "isConstructor" : false,
810 "memberOf" : "Roo.BasicDialog",
819 "type" : "Roo.BasicDialog",
825 "name" : "setContentSize",
826 "desc" : "Resizes the dialog to fit the specified content size.",
828 "isConstructor" : false,
830 "memberOf" : "Roo.BasicDialog",
852 "type" : "Roo.BasicDialog",
858 "name" : "restoreState",
859 "desc" : "Restores the previous state of the dialog if Roo.state is configured.",
861 "isConstructor" : false,
863 "memberOf" : "Roo.BasicDialog",
872 "type" : "Roo.BasicDialog",
879 "desc" : "Returns the element for this dialog",
881 "isConstructor" : false,
883 "memberOf" : "Roo.BasicDialog",
892 "type" : "Roo.Element",
893 "desc" : "The underlying dialog Element"
898 "name" : "purgeListeners",
899 "desc" : "Removes all listeners for this object",
901 "isConstructor" : false,
903 "memberOf" : "Roo.util.Observable",
913 "desc" : "Appends an event handler to this element (shorthand for addListener)",
915 "isConstructor" : false,
917 "memberOf" : "Roo.util.Observable",
924 "name" : "eventName",
926 "desc" : "The type of event to listen for",
932 "desc" : "The method the event invokes",
938 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
944 "desc" : "(optional)",
952 "desc" : "Removes a listener (shorthand for removeListener)",
954 "isConstructor" : false,
956 "memberOf" : "Roo.util.Observable",
963 "name" : "eventName",
965 "desc" : "The type of event to listen for",
971 "desc" : "The handler to remove",
977 "desc" : "(optional) The scope (this object) for the handler",
984 "name" : "addEvents",
985 "desc" : "Used to define events on this Observable",
987 "isConstructor" : false,
989 "memberOf" : "Roo.util.Observable",
998 "desc" : "The object with the events defined",
1005 "name" : "releaseCapture",
1006 "desc" : "Removes <b>all</b> added captures from the Observable.",
1008 "isConstructor" : false,
1009 "isPrivate" : false,
1010 "memberOf" : "Roo.util.Observable",
1018 "type" : "Observable",
1019 "desc" : "The Observable to release",
1020 "isOptional" : false
1026 "name" : "removeListener",
1027 "desc" : "Removes a listener",
1029 "isConstructor" : false,
1030 "isPrivate" : false,
1031 "memberOf" : "Roo.util.Observable",
1038 "name" : "eventName",
1040 "desc" : "The type of event to listen for",
1041 "isOptional" : false
1045 "type" : "Function",
1046 "desc" : "The handler to remove",
1047 "isOptional" : false
1052 "desc" : "(optional) The scope (this object) for the handler",
1053 "isOptional" : false
1059 "name" : "fireEvent",
1060 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
1062 "isConstructor" : false,
1063 "isPrivate" : false,
1064 "memberOf" : "Roo.util.Observable",
1071 "name" : "eventName",
1074 "isOptional" : false
1078 "type" : "Object...",
1079 "desc" : "Variable number of parameters are passed to handlers",
1080 "isOptional" : false
1087 "desc" : "returns false if any of the handlers return false otherwise it returns true"
1092 "name" : "hasListener",
1093 "desc" : "Checks to see if this object has any listeners for a specified event",
1095 "isConstructor" : false,
1096 "isPrivate" : false,
1097 "memberOf" : "Roo.util.Observable",
1104 "name" : "eventName",
1106 "desc" : "The name of the event to check for",
1107 "isOptional" : false
1114 "desc" : "True if the event is being listened for, else false"
1120 "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.",
1122 "isConstructor" : false,
1123 "isPrivate" : false,
1124 "memberOf" : "Roo.util.Observable",
1132 "type" : "Observable",
1133 "desc" : "The Observable to capture",
1134 "isOptional" : false
1138 "type" : "Function",
1139 "desc" : "The function to call",
1140 "isOptional" : false
1145 "desc" : "(optional) The scope (this object) for the fn",
1146 "isOptional" : false
1152 "name" : "addListener",
1153 "desc" : "Appends an event handler to this component",
1155 "isConstructor" : false,
1156 "isPrivate" : false,
1157 "memberOf" : "Roo.util.Observable",
1164 "name" : "eventName",
1166 "desc" : "The type of event to listen for",
1167 "isOptional" : false
1171 "type" : "Function",
1172 "desc" : "The method the event invokes",
1173 "isOptional" : false
1178 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1179 "isOptional" : false
1184 "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>",
1185 "isOptional" : false
1194 "desc" : "Fires when this dialog is moved by the user.",
1195 "memberOf" : "Roo.BasicDialog",
1203 "type" : "Roo.BasicDialog",
1205 "isOptional" : false
1210 "desc" : "The new page X",
1211 "isOptional" : false
1216 "desc" : "The new page Y",
1217 "isOptional" : false
1224 "desc" : "Fires when this dialog is resized by the user.",
1225 "memberOf" : "Roo.BasicDialog",
1233 "type" : "Roo.BasicDialog",
1235 "isOptional" : false
1240 "desc" : "The new width",
1241 "isOptional" : false
1246 "desc" : "The new height",
1247 "isOptional" : false
1253 "name" : "beforehide",
1254 "desc" : "Fires before this dialog is hidden.",
1255 "memberOf" : "Roo.BasicDialog",
1263 "type" : "Roo.BasicDialog",
1265 "isOptional" : false
1271 "name" : "beforeshow",
1272 "desc" : "Fires before this dialog is shown.",
1273 "memberOf" : "Roo.BasicDialog",
1281 "type" : "Roo.BasicDialog",
1283 "isOptional" : false
1290 "desc" : "Fires when this dialog is hidden.",
1291 "memberOf" : "Roo.BasicDialog",
1299 "type" : "Roo.BasicDialog",
1301 "isOptional" : false
1308 "desc" : "Fires when this dialog is shown.",
1309 "memberOf" : "Roo.BasicDialog",
1317 "type" : "Roo.BasicDialog",
1319 "isOptional" : false
1326 "desc" : "Fires when a key is pressed",
1327 "memberOf" : "Roo.BasicDialog",
1335 "type" : "Roo.BasicDialog",
1337 "isOptional" : false
1341 "type" : "Roo.EventObject",
1343 "isOptional" : false