1554 lines
No EOL
85 KiB
HTML
1554 lines
No EOL
85 KiB
HTML
<!doctype html public "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
<html>
|
|
<head>
|
|
<title>Ext.BasicDialog</title>
|
|
<link rel="stylesheet" type="text/css" href="../resources/reset.css"/>
|
|
<link rel="stylesheet" type="text/css" href="../resources/style.css" media="screen"/>
|
|
<link rel="stylesheet" type="text/css" href="../resources/print.css" media="print">
|
|
<!-- GC -->
|
|
</head>
|
|
<body>
|
|
<div class="body-wrap">
|
|
<div class="top-tools">
|
|
<img src="../resources/print.gif" width="16" height="16" align="absmiddle"> <a href="Ext.BasicDialog.html" target="_blank">Print Friendly</a><br/>
|
|
|
|
</div>
|
|
<h1>Class Ext.BasicDialog</h1>
|
|
<table cellspacing="0">
|
|
<tr><td class="label">Package:</td><td>Ext</td></tr>
|
|
<tr><td class="label">Class:</td><td>BasicDialog</td></tr>
|
|
<tr><td class="label">Extends:</td><td><a href="Ext.util.Observable.html">Observable</a></td></tr>
|
|
<tr><td class="label">Subclasses:</td><td><a href="Ext.LayoutDialog.html">LayoutDialog</a></td></tr>
|
|
<tr><td class="label">Defined In:</td><td><a href="BasicDialog.jss.html">BasicDialog.js</a></td></tr>
|
|
</table>
|
|
<div class="description">
|
|
Lightweight Dialog Class. The code below shows the creation of a typical dialog using existing HTML markup:
|
|
<pre class="highlighted"><code>var dlg = <b>new</b> Ext.BasicDialog("my-dlg", {
|
|
height: 200,
|
|
width: 300,
|
|
minHeight: 100,
|
|
minWidth: 150,
|
|
modal: true,
|
|
proxyDrag: true,
|
|
shadow: true
|
|
});
|
|
dlg.addKeyListener(27, dlg.hide, dlg); <i>// ESC can also close the dialog</i>
|
|
dlg.addButton('OK', dlg.hide, dlg); <i>// Could call a save <b>function</b> instead of hiding</i>
|
|
dlg.addButton('Cancel', dlg.hide, dlg);
|
|
dlg.show();</code></pre>
|
|
<b>A Dialog should always be a direct child of the body element.</b> </div>
|
|
<br />
|
|
<a href="#properties">Properties</a>
|
|
- <a href="#methods">Methods</a>
|
|
- <a href="#events">Events</a>
|
|
- <a href="#configs">Config Options</a>
|
|
<hr />
|
|
<a name="properties"></a>
|
|
<h2>Public Properties</h2>
|
|
<table cellspacing="0" class="member-table">
|
|
<tr>
|
|
<th class="sig-header" colspan="2">Property</th>
|
|
<th class="msource-header">Defined By</th>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#body">body</a> : Ext.Element</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">The body element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#buttons">buttons</a> : Array</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Array of all the buttons that have been added to this dialog via addButton</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#footer">footer</a> : Ext.Element</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">The footer element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#header">header</a> : Ext.Element</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">The header element</td>
|
|
</tr>
|
|
</table>
|
|
<a name="methods"></a>
|
|
<h2>Public Methods</h2>
|
|
<table cellspacing="0" class="member-table">
|
|
<tr>
|
|
<th class="sig-header" colspan="2">Method</th>
|
|
<th class="msource-header">Defined By</th>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#BasicDialog">BasicDialog</a>(<code>String/HTMLElement/Ext.Element el</code>, <code>Object config</code>)</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Create a new BasicDialog.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#addButton">addButton</a>(<code>String/Object config</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>) : Ext.Button</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Adds a button to the footer section of the dialog.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#addEvents">addEvents</a>(<code>Object object</code>) : void</td>
|
|
<td class="msource" rowspan="2"><a href="Ext.util.Observable.html#addEvents">Observable</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Copies any events from the passed object onto this object if they do not already exist. The passed object
|
|
must also ...</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#addKeyListener">addKeyListener</a>(<code>Number/Array/Object key</code>, <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>) : Ext.BasicDialog</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Adds a key listener for when this dialog is displayed. This allows you to hook in a function that will be
|
|
executed i...</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#addListener">addListener</a>(<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span>) : void</td>
|
|
<td class="msource" rowspan="2"><a href="Ext.util.Observable.html#addListener">Observable</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Appends an event handler to this component</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#alignTo">alignTo</a>(<code>String/HTMLElement/Ext.Element element</code>, <code>String position</code>, <span class="optional" title="Optional">[<code>Array offsets</code>]</span>) : Ext.BasicDialog</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Aligns the dialog to the specified element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#anchorTo">anchorTo</a>(<code>String/HTMLElement/Ext.Element element</code>, <code>String position</code>, <span class="optional" title="Optional">[<code>Array offsets</code>]</span>, <span class="optional" title="Optional">[<code>Boolean/Number monitorScroll</code>]</span>) : Ext.BasicDialog</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Anchors an element to another element and realigns it when the window is resized.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#center">center</a>() : Ext.BasicDialog</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Centers this dialog in the viewport</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#collapse">collapse</a>() : void</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Collapses the dialog to its minimized state (only the title bar is visible).
|
|
Equivalent to the user clicking the coll...</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#destroy">destroy</a>(<span class="optional" title="Optional">[<code>Boolean removeEl</code>]</span>) : void</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Destroys this dialog and all its supporting elements (including any tabs, shim,
|
|
shadow, proxy, mask, etc.) Also remo...</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#expand">expand</a>() : void</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Expands a collapsed dialog back to its normal state. Equivalent to the user
|
|
clicking the expand dialog button.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#fireEvent">fireEvent</a>(<code>String eventName</code>, <code>Object... args</code>) : Boolean</td>
|
|
<td class="msource" rowspan="2"><a href="Ext.util.Observable.html#fireEvent">Observable</a></td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Fires the specified event with the passed parameters (minus the event name).</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#focus">focus</a>() : void</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Focuses the dialog. If a defaultButton is set, it will receive focus, otherwise the
|
|
dialog itself will receive focus.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getEl">getEl</a>() : Ext.Element</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Returns the element for this dialog</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getTabs">getTabs</a>() : Ext.TabPanel</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Returns the TabPanel component (creates it if it doesn't exist).
|
|
Note: If you wish to simply check for the existence ...</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#hasListener">hasListener</a>(<code>String eventName</code>) : Boolean</td>
|
|
<td class="msource" rowspan="2"><a href="Ext.util.Observable.html#hasListener">Observable</a></td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Checks to see if this object is currently listening for a specified event</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#hide">hide</a>(<span class="optional" title="Optional">[<code>Function callback</code>]</span>) : Ext.BasicDialog</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Hides the dialog.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#initTabs">initTabs</a>() : Ext.TabPanel</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Reinitializes the tabs component, clearing out old tabs and finding new ones.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#isVisible">isVisible</a>() : Boolean</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Returns true if the dialog is visible</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#moveTo">moveTo</a>(<code>Number x</code>, <code>Number y</code>) : Ext.BasicDialog</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Moves the dialog's top-left corner to the specified point</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#on">on</a>(<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object options</code>]</span>) : void</td>
|
|
<td class="msource" rowspan="2"><a href="Ext.util.Observable.html#on">Observable</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Appends an event handler to this element (shorthand for addListener)</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#purgeListeners">purgeListeners</a>() : void</td>
|
|
<td class="msource" rowspan="2"><a href="Ext.util.Observable.html#purgeListeners">Observable</a></td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Removes all listeners for this object</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#removeListener">removeListener</a>(<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>) : void</td>
|
|
<td class="msource" rowspan="2"><a href="Ext.util.Observable.html#removeListener">Observable</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Removes a listener</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#resizeTo">resizeTo</a>(<code>Number width</code>, <code>Number height</code>) : Ext.BasicDialog</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Resizes the dialog.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#restoreState">restoreState</a>() : Ext.BasicDialog</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Restores the previous state of the dialog if Ext.state is configured.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setContentSize">setContentSize</a>(<code>Number width</code>, <code>Number height</code>) : Ext.BasicDialog</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Resizes the dialog to fit the specified content size.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setDefaultButton">setDefaultButton</a>(<code>Ext.BasicDialog.Button btn</code>) : Ext.BasicDialog</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Sets the default button to be focused when the dialog is displayed.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setTitle">setTitle</a>(<code>String text</code>) : Ext.BasicDialog</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Sets the dialog title text</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#show">show</a>(<span class="optional" title="Optional">[<code>String/HTMLElement/Ext.Element animateTarget</code>]</span>) : Ext.BasicDialog</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Shows the dialog.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#toBack">toBack</a>() : Ext.BasicDialog</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Sends this dialog to the back (under) of any other visible dialogs</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#toFront">toFront</a>() : Ext.BasicDialog</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Brings this dialog to the front of any other visible dialogs</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#un">un</a>(<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>) : void</td>
|
|
<td class="msource" rowspan="2"><a href="Ext.util.Observable.html#un">Observable</a></td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Removes a listener (shorthand for removeListener)</td>
|
|
</tr>
|
|
</table>
|
|
<a name="events"></a>
|
|
<h2>Public Events</h2>
|
|
<table cellspacing="0" class="member-table">
|
|
<tr>
|
|
<th class="sig-header" colspan="2">Event</th>
|
|
<th class="msource-header">Defined By</th>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#event-beforehide">beforehide</a> : (<code>Ext.BasicDialog this</code>)</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Fires before this dialog is hidden.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#event-beforeshow">beforeshow</a> : (<code>Ext.BasicDialog this</code>)</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Fires before this dialog is shown.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#event-hide">hide</a> : (<code>Ext.BasicDialog this</code>)</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Fires when this dialog is hidden.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#event-keydown">keydown</a> : (<code>Ext.BasicDialog this</code>, <code>Ext.EventObject e</code>)</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Fires when a key is pressed</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#event-move">move</a> : (<code>Ext.BasicDialog this</code>, <code>Number x</code>, <code>Number y</code>)</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Fires when this dialog is moved by the user.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#event-resize">resize</a> : (<code>Ext.BasicDialog this</code>, <code>Number width</code>, <code>Number height</code>)</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Fires when this dialog is resized by the user.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#event-show">show</a> : (<code>Ext.BasicDialog this</code>)</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Fires when this dialog is shown.</td>
|
|
</tr>
|
|
</table>
|
|
<a name="configs"></a>
|
|
<h2>Config Options</h2>
|
|
<table cellspacing="0" class="member-table">
|
|
<tr>
|
|
<th class="sig-header" colspan="2">Config Options</th>
|
|
<th class="msource-header">Defined By</th>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#config-animateTarget">animateTarget</a> : String/Element</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Id or element from which the dialog should animate while opening (defaults to null with no animation)</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#config-autoCreate">autoCreate</a> : Boolean/DomHelper</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">True to auto create from scratch, or using a DomHelper Object (defaults to false)</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#config-autoScroll">autoScroll</a> : Boolean</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">True to allow the dialog body contents to overflow and display scrollbars (defaults to false)</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#config-autoTabs">autoTabs</a> : Boolean</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">If true, all elements with class 'x-dlg-tab' will get automatically converted to tabs (defaults to false)</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#config-buttonAlign">buttonAlign</a> : String</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Valid values are "left," "center" and "right" (defaults to "right")</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#config-closable">closable</a> : Boolean</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">False to remove the built-in top-right corner close button (defaults to true)</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#config-collapsible">collapsible</a> : Boolean</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">False to remove the built-in top-right corner collapse button (defaults to true)</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#config-constraintoviewport">constraintoviewport</a> : Boolean</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">True to keep the dialog constrained within the visible viewport boundaries (defaults to true)</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#config-draggable">draggable</a> : Boolean</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">False to disable dragging of the dialog within the viewport (defaults to true)</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#config-fixedcenter">fixedcenter</a> : Boolean</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">True to ensure that anytime the dialog is shown or resized it gets centered (defaults to false)</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#config-height">height</a> : Number</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Height of the dialog in pixels (can also be set via CSS). Determined by browser if unspecified.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#config-minButtonWidth">minButtonWidth</a> : Number</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Minimum width of all dialog buttons (defaults to 75)</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#config-minHeight">minHeight</a> : Number</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">The minimum allowable height for a resizable dialog (defaults to 80)</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#config-minWidth">minWidth</a> : Number</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">The minimum allowable width for a resizable dialog (defaults to 200)</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#config-modal">modal</a> : Boolean</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">True to show the dialog modally, preventing user interaction with the rest of the page (defaults to false)</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#config-proxyDrag">proxyDrag</a> : Boolean</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">True to drag a lightweight proxy element rather than the dialog itself, used when draggable = true (defaults to false)</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#config-resizable">resizable</a> : Boolean</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">False to disable manual dialog resizing (defaults to true)</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#config-resizeHandles">resizeHandles</a> : String</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Which resize handles to display - see the <a href="Ext.Resizable.html">Ext.Resizable</a> handles config property for valid values (defaults to 'all')</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#config-shadow">shadow</a> : Boolean/String</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">True or "sides" for the default effect, "frame" for 4-way shadow, and "drop" for bottom-right shadow (defaults to false)</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#config-shadowOffset">shadowOffset</a> : Number</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">The number of pixels to offset the shadow if displayed (defaults to 5)</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#config-shim">shim</a> : Boolean</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">True to create an iframe shim that prevents selects from showing through (defaults to false)</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#config-syncHeightBeforeShow">syncHeightBeforeShow</a> : Boolean</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">True to cause the dimensions to be recalculated before the dialog is shown (defaults to false)</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#config-tabTag">tabTag</a> : String</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">The tag name of tab elements, used when autoTabs = true (defaults to 'div')</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#config-title">title</a> : String</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Default text to display in the title bar (defaults to null)</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#config-width">width</a> : Number</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Width of the dialog in pixels (can also be set via CSS). Determined by browser if unspecified.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#config-x">x</a> : Number</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">The default top page coordinate of the dialog (defaults to center screen)</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#config-y">y</a> : Number</td>
|
|
<td class="msource" rowspan="2">BasicDialog</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">The default left page coordinate of the dialog (defaults to center screen)</td>
|
|
</tr>
|
|
</table>
|
|
<h2 class="mdetail-head">Property Details</h2>
|
|
<div class="detail-wrap">
|
|
<a name="body"></a>
|
|
<div class="mdetail">
|
|
<h3>body</i></h3>
|
|
<code>public Ext.Element body</code>
|
|
<div class="mdetail-desc">
|
|
The body element </div>
|
|
<div class="mdetail-def">This property is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="buttons"></a>
|
|
<div class="mdetail alt">
|
|
<h3>buttons</i></h3>
|
|
<code>public Array buttons</code>
|
|
<div class="mdetail-desc">
|
|
Array of all the buttons that have been added to this dialog via addButton </div>
|
|
<div class="mdetail-def">This property is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="footer"></a>
|
|
<div class="mdetail">
|
|
<h3>footer</i></h3>
|
|
<code>public Ext.Element footer</code>
|
|
<div class="mdetail-desc">
|
|
The footer element </div>
|
|
<div class="mdetail-def">This property is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="header"></a>
|
|
<div class="mdetail alt">
|
|
<h3>header</i></h3>
|
|
<code>public Ext.Element header</code>
|
|
<div class="mdetail-desc">
|
|
The header element </div>
|
|
<div class="mdetail-def">This property is defined by BasicDialog.</div>
|
|
</div>
|
|
</div>
|
|
|
|
<a name="BasicDialog"></a>
|
|
<h2 class="mdetail-head">Constructor Details</h2>
|
|
<div class="detail-wrap">
|
|
<div class="mdetail">
|
|
<h3>BasicDialog</i></h3>
|
|
<code>public function BasicDialog(<code>String/HTMLElement/Ext.Element el</code>, <code>Object config</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Create a new BasicDialog. <div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>el</code> : String/HTMLElement/Ext.Element<div class="sub-desc">The container element or DOM node, or its id</div></li><li><code>config</code> : Object<div class="sub-desc">Configuration options</div></li> </ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<h2 class="mdetail-head">Method Details</h2>
|
|
<div class="detail-wrap">
|
|
<a name="addButton"></a>
|
|
<div class="mdetail">
|
|
<h3>addButton</i></h3>
|
|
<code>public function addButton(<code>String/Object config</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Adds a button to the footer section of the dialog.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>config</code> : String/Object<div class="sub-desc">A string becomes the button text, an object can either be a Button config object or a valid Ext.DomHelper element config</div></li><li><code>handler</code> : Function<div class="sub-desc">The function called when the button is clicked</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope of the handler function</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Button</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="addEvents"></a>
|
|
<div class="mdetail alt">
|
|
<h3>addEvents</i></h3>
|
|
<code>public function addEvents(<code>Object object</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Copies any events from the passed object onto this object if they do not already exist. The passed object
|
|
must also inherit from Observable for this method to have any effect.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>object</code> : Object<div class="sub-desc">The object from which to copy events</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by <a href="Ext.util.Observable.html#addEvents">Observable</a>.</div>
|
|
</div>
|
|
<a name="addKeyListener"></a>
|
|
<div class="mdetail">
|
|
<h3>addKeyListener</i></h3>
|
|
<code>public function addKeyListener(<code>Number/Array/Object key</code>, <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Adds a key listener for when this dialog is displayed. This allows you to hook in a function that will be
|
|
executed in response to a particular key being pressed while the dialog is active.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>key</code> : Number/Array/Object<div class="sub-desc">Either the numeric key code, array of key codes or an object with the following options: {key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)}</div></li><li><code>fn</code> : Function<div class="sub-desc">The function to call</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope of the function</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.BasicDialog</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="addListener"></a>
|
|
<div class="mdetail alt">
|
|
<h3>addListener</i></h3>
|
|
<code>public function addListener(<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Appends an event handler to this component
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration properties. This may contain any of the following properties:<ul> <li>scope {Object} The scope in which to execute the handler function. The handler function's "this" context.</li> <li>delegate {String} A simple selector to filter the target or look for a descendant of the target</li> <li>stopEvent {Boolean} True to stop the event. That is stop propagation, and prevent the default action.</li> <li>preventDefault {Boolean} True to prevent the default action</li> <li>stopPropagation {Boolean} True to prevent event propagation</li> <li>normalized {Boolean} False to pass a browser event to the handler function instead of an Ext.EventObject</li> <li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li> <li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li> <li>buffer {Number} Causes the handler to be scheduled to run in an <a href="Ext.util.DelayedTask.html">Ext.util.DelayedTask</a> delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li> </ul> <p> <b>Combining Options</b><br> Using the options argument, it is possible to combine different types of listeners:<br> <br> A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<div style="margin: 5px 20px 20px;"> Code: <pre><code>el.on('click', this.onClick, this, { single: true, delay: 100, stopEvent : true, forumId: 4 });</pre> <p> The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers. <p> <b>Attaching multiple handlers in 1 call</b><br> Code: <pre><code>el.on({ 'click' : { fn: this.onClick scope: this, delay: 100 }, 'mouseover' : { fn: this.onMouseOver scope: this }, 'mouseout' : { fn: this.onMouseOut scope: this } });</pre> <p> Or a shorthand syntax:<br> Code: <pre><code>el.on({ 'click' : this.onClick, 'mouseover' : this.onMouseOver, 'mouseout' : this.onMouseOut scope: this });</pre></div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by <a href="Ext.util.Observable.html#addListener">Observable</a>.</div>
|
|
</div>
|
|
<a name="alignTo"></a>
|
|
<div class="mdetail">
|
|
<h3>alignTo</i></h3>
|
|
<code>public function alignTo(<code>String/HTMLElement/Ext.Element element</code>, <code>String position</code>, <span class="optional" title="Optional">[<code>Array offsets</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Aligns the dialog to the specified element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>element</code> : String/HTMLElement/Ext.Element<div class="sub-desc">The element to align to.</div></li><li><code>position</code> : String<div class="sub-desc">The position to align to (see <a href="Ext.Element.html#alignTo">Ext.Element.alignTo</a> for more details).</div></li><li><code>offsets</code> : Array<div class="sub-desc">(optional) Offset the positioning by [x, y]</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.BasicDialog</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="anchorTo"></a>
|
|
<div class="mdetail alt">
|
|
<h3>anchorTo</i></h3>
|
|
<code>public function anchorTo(<code>String/HTMLElement/Ext.Element element</code>, <code>String position</code>, <span class="optional" title="Optional">[<code>Array offsets</code>]</span>, <span class="optional" title="Optional">[<code>Boolean/Number monitorScroll</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Anchors an element to another element and realigns it when the window is resized.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>element</code> : String/HTMLElement/Ext.Element<div class="sub-desc">The element to align to.</div></li><li><code>position</code> : String<div class="sub-desc">The position to align to (see <a href="Ext.Element.html#alignTo">Ext.Element.alignTo</a> for more details)</div></li><li><code>offsets</code> : Array<div class="sub-desc">(optional) Offset the positioning by [x, y]</div></li><li><code>monitorScroll</code> : Boolean/Number<div class="sub-desc">(optional) true to monitor body scroll and reposition. If this parameter is a number, it is used as the buffer delay (defaults to 50ms).</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.BasicDialog</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="center"></a>
|
|
<div class="mdetail">
|
|
<h3>center</i></h3>
|
|
<code>public function center()</code>
|
|
<div class="mdetail-desc">
|
|
Centers this dialog in the viewport
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.BasicDialog</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="collapse"></a>
|
|
<div class="mdetail alt">
|
|
<h3>collapse</i></h3>
|
|
<code>public function collapse()</code>
|
|
<div class="mdetail-desc">
|
|
Collapses the dialog to its minimized state (only the title bar is visible).
|
|
Equivalent to the user clicking the collapse dialog button.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="destroy"></a>
|
|
<div class="mdetail">
|
|
<h3>destroy</i></h3>
|
|
<code>public function destroy(<span class="optional" title="Optional">[<code>Boolean removeEl</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Destroys this dialog and all its supporting elements (including any tabs, shim,
|
|
shadow, proxy, mask, etc.) Also removes all event listeners.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>removeEl</code> : Boolean<div class="sub-desc">(optional) true to remove the element from the DOM</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="expand"></a>
|
|
<div class="mdetail alt">
|
|
<h3>expand</i></h3>
|
|
<code>public function expand()</code>
|
|
<div class="mdetail-desc">
|
|
Expands a collapsed dialog back to its normal state. Equivalent to the user
|
|
clicking the expand dialog button.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="fireEvent"></a>
|
|
<div class="mdetail">
|
|
<h3>fireEvent</i></h3>
|
|
<code>public function fireEvent(<code>String eventName</code>, <code>Object... args</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Fires the specified event with the passed parameters (minus the event name).
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>eventName</code> : String<div class="sub-desc"></div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by <a href="Ext.util.Observable.html#fireEvent">Observable</a>.</div>
|
|
</div>
|
|
<a name="focus"></a>
|
|
<div class="mdetail alt">
|
|
<h3>focus</i></h3>
|
|
<code>public function focus()</code>
|
|
<div class="mdetail-desc">
|
|
Focuses the dialog. If a defaultButton is set, it will receive focus, otherwise the
|
|
dialog itself will receive focus.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="getEl"></a>
|
|
<div class="mdetail">
|
|
<h3>getEl</i></h3>
|
|
<code>public function getEl()</code>
|
|
<div class="mdetail-desc">
|
|
Returns the element for this dialog
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">The underlying dialog Element</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="getTabs"></a>
|
|
<div class="mdetail alt">
|
|
<h3>getTabs</i></h3>
|
|
<code>public function getTabs()</code>
|
|
<div class="mdetail-desc">
|
|
Returns the TabPanel component (creates it if it doesn't exist).
|
|
Note: If you wish to simply check for the existence of tabs without creating them,
|
|
check for a null 'tabs' property.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.TabPanel</code><div class="sub-desc">The tabs component</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="hasListener"></a>
|
|
<div class="mdetail">
|
|
<h3>hasListener</i></h3>
|
|
<code>public function hasListener(<code>String eventName</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Checks to see if this object is currently listening for a specified event
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by <a href="Ext.util.Observable.html#hasListener">Observable</a>.</div>
|
|
</div>
|
|
<a name="hide"></a>
|
|
<div class="mdetail alt">
|
|
<h3>hide</i></h3>
|
|
<code>public function hide(<span class="optional" title="Optional">[<code>Function callback</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Hides the dialog.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>callback</code> : Function<div class="sub-desc">(optional) Function to call when the dialog is hidden</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.BasicDialog</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="initTabs"></a>
|
|
<div class="mdetail">
|
|
<h3>initTabs</i></h3>
|
|
<code>public function initTabs()</code>
|
|
<div class="mdetail-desc">
|
|
Reinitializes the tabs component, clearing out old tabs and finding new ones.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.TabPanel</code><div class="sub-desc">The tabs component</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="isVisible"></a>
|
|
<div class="mdetail alt">
|
|
<h3>isVisible</i></h3>
|
|
<code>public function isVisible()</code>
|
|
<div class="mdetail-desc">
|
|
Returns true if the dialog is visible
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Boolean</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="moveTo"></a>
|
|
<div class="mdetail">
|
|
<h3>moveTo</i></h3>
|
|
<code>public function moveTo(<code>Number x</code>, <code>Number y</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Moves the dialog's top-left corner to the specified point
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>x</code> : Number<div class="sub-desc"></div></li><li><code>y</code> : Number<div class="sub-desc"></div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.BasicDialog</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="on"></a>
|
|
<div class="mdetail alt">
|
|
<h3>on</i></h3>
|
|
<code>public function on(<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object options</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Appends an event handler to this element (shorthand for addListener)
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by <a href="Ext.util.Observable.html#on">Observable</a>.</div>
|
|
</div>
|
|
<a name="purgeListeners"></a>
|
|
<div class="mdetail">
|
|
<h3>purgeListeners</i></h3>
|
|
<code>public function purgeListeners()</code>
|
|
<div class="mdetail-desc">
|
|
Removes all listeners for this object
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by <a href="Ext.util.Observable.html#purgeListeners">Observable</a>.</div>
|
|
</div>
|
|
<a name="removeListener"></a>
|
|
<div class="mdetail alt">
|
|
<h3>removeListener</i></h3>
|
|
<code>public function removeListener(<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Removes a listener
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by <a href="Ext.util.Observable.html#removeListener">Observable</a>.</div>
|
|
</div>
|
|
<a name="resizeTo"></a>
|
|
<div class="mdetail">
|
|
<h3>resizeTo</i></h3>
|
|
<code>public function resizeTo(<code>Number width</code>, <code>Number height</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Resizes the dialog.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>width</code> : Number<div class="sub-desc"></div></li><li><code>height</code> : Number<div class="sub-desc"></div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.BasicDialog</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="restoreState"></a>
|
|
<div class="mdetail alt">
|
|
<h3>restoreState</i></h3>
|
|
<code>public function restoreState()</code>
|
|
<div class="mdetail-desc">
|
|
Restores the previous state of the dialog if Ext.state is configured.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.BasicDialog</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="setContentSize"></a>
|
|
<div class="mdetail">
|
|
<h3>setContentSize</i></h3>
|
|
<code>public function setContentSize(<code>Number width</code>, <code>Number height</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Resizes the dialog to fit the specified content size.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>width</code> : Number<div class="sub-desc"></div></li><li><code>height</code> : Number<div class="sub-desc"></div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.BasicDialog</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="setDefaultButton"></a>
|
|
<div class="mdetail alt">
|
|
<h3>setDefaultButton</i></h3>
|
|
<code>public function setDefaultButton(<code>Ext.BasicDialog.Button btn</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Sets the default button to be focused when the dialog is displayed.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>btn</code> : Ext.BasicDialog.Button<div class="sub-desc">The button object returned by <a href="#addButton">addButton</a></div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.BasicDialog</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="setTitle"></a>
|
|
<div class="mdetail">
|
|
<h3>setTitle</i></h3>
|
|
<code>public function setTitle(<code>String text</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Sets the dialog title text
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>text</code> : String<div class="sub-desc">The title text to display</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.BasicDialog</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="show"></a>
|
|
<div class="mdetail alt">
|
|
<h3>show</i></h3>
|
|
<code>public function show(<span class="optional" title="Optional">[<code>String/HTMLElement/Ext.Element animateTarget</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Shows the dialog.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>animateTarget</code> : String/HTMLElement/Ext.Element<div class="sub-desc">(optional) Reset the animation target</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.BasicDialog</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="toBack"></a>
|
|
<div class="mdetail">
|
|
<h3>toBack</i></h3>
|
|
<code>public function toBack()</code>
|
|
<div class="mdetail-desc">
|
|
Sends this dialog to the back (under) of any other visible dialogs
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.BasicDialog</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="toFront"></a>
|
|
<div class="mdetail alt">
|
|
<h3>toFront</i></h3>
|
|
<code>public function toFront()</code>
|
|
<div class="mdetail-desc">
|
|
Brings this dialog to the front of any other visible dialogs
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.BasicDialog</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="un"></a>
|
|
<div class="mdetail">
|
|
<h3>un</i></h3>
|
|
<code>public function un(<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Removes a listener (shorthand for removeListener)
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by <a href="Ext.util.Observable.html#un">Observable</a>.</div>
|
|
</div>
|
|
</div>
|
|
|
|
<h2 class="mdetail-head">Event Details</h2>
|
|
<div class="detail-wrap">
|
|
<a name="event-beforehide"></a>
|
|
<div class="mdetail">
|
|
<h3>beforehide</i></h3>
|
|
<code>public event beforehide</code>
|
|
<div class="mdetail-desc">
|
|
Fires before this dialog is hidden.
|
|
<div class="mdetail-params">
|
|
<strong style="font-weight:normal;">Subscribers will be called with the following parameters:</strong>
|
|
<ul><li><code>this</code> : Ext.BasicDialog<div class="sub-desc"></div></li> </ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This event is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="event-beforeshow"></a>
|
|
<div class="mdetail alt">
|
|
<h3>beforeshow</i></h3>
|
|
<code>public event beforeshow</code>
|
|
<div class="mdetail-desc">
|
|
Fires before this dialog is shown.
|
|
<div class="mdetail-params">
|
|
<strong style="font-weight:normal;">Subscribers will be called with the following parameters:</strong>
|
|
<ul><li><code>this</code> : Ext.BasicDialog<div class="sub-desc"></div></li> </ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This event is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="event-hide"></a>
|
|
<div class="mdetail">
|
|
<h3>hide</i></h3>
|
|
<code>public event hide</code>
|
|
<div class="mdetail-desc">
|
|
Fires when this dialog is hidden.
|
|
<div class="mdetail-params">
|
|
<strong style="font-weight:normal;">Subscribers will be called with the following parameters:</strong>
|
|
<ul><li><code>this</code> : Ext.BasicDialog<div class="sub-desc"></div></li> </ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This event is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="event-keydown"></a>
|
|
<div class="mdetail alt">
|
|
<h3>keydown</i></h3>
|
|
<code>public event keydown</code>
|
|
<div class="mdetail-desc">
|
|
Fires when a key is pressed
|
|
<div class="mdetail-params">
|
|
<strong style="font-weight:normal;">Subscribers will be called with the following parameters:</strong>
|
|
<ul><li><code>this</code> : Ext.BasicDialog<div class="sub-desc"></div></li><li><code>e</code> : Ext.EventObject<div class="sub-desc"></div></li> </ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This event is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="event-move"></a>
|
|
<div class="mdetail">
|
|
<h3>move</i></h3>
|
|
<code>public event move</code>
|
|
<div class="mdetail-desc">
|
|
Fires when this dialog is moved by the user.
|
|
<div class="mdetail-params">
|
|
<strong style="font-weight:normal;">Subscribers will be called with the following parameters:</strong>
|
|
<ul><li><code>this</code> : Ext.BasicDialog<div class="sub-desc"></div></li><li><code>x</code> : Number<div class="sub-desc">The new page X</div></li><li><code>y</code> : Number<div class="sub-desc">The new page Y</div></li> </ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This event is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="event-resize"></a>
|
|
<div class="mdetail alt">
|
|
<h3>resize</i></h3>
|
|
<code>public event resize</code>
|
|
<div class="mdetail-desc">
|
|
Fires when this dialog is resized by the user.
|
|
<div class="mdetail-params">
|
|
<strong style="font-weight:normal;">Subscribers will be called with the following parameters:</strong>
|
|
<ul><li><code>this</code> : Ext.BasicDialog<div class="sub-desc"></div></li><li><code>width</code> : Number<div class="sub-desc">The new width</div></li><li><code>height</code> : Number<div class="sub-desc">The new height</div></li> </ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This event is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="event-show"></a>
|
|
<div class="mdetail">
|
|
<h3>show</i></h3>
|
|
<code>public event show</code>
|
|
<div class="mdetail-desc">
|
|
Fires when this dialog is shown.
|
|
<div class="mdetail-params">
|
|
<strong style="font-weight:normal;">Subscribers will be called with the following parameters:</strong>
|
|
<ul><li><code>this</code> : Ext.BasicDialog<div class="sub-desc"></div></li> </ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This event is defined by BasicDialog.</div>
|
|
</div>
|
|
</div>
|
|
<h2 class="mdetail-head">Config Details</h2>
|
|
<div class="detail-wrap">
|
|
<a name="config-animateTarget"></a>
|
|
<div class="mdetail">
|
|
<h3>animateTarget</i></h3>
|
|
<code>animateTarget : String/Element</code>
|
|
<div class="mdetail-desc">
|
|
Id or element from which the dialog should animate while opening (defaults to null with no animation) </div>
|
|
<div class="mdetail-def">This config option is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="config-autoCreate"></a>
|
|
<div class="mdetail alt">
|
|
<h3>autoCreate</i></h3>
|
|
<code>autoCreate : Boolean/DomHelper</code>
|
|
<div class="mdetail-desc">
|
|
True to auto create from scratch, or using a DomHelper Object (defaults to false) </div>
|
|
<div class="mdetail-def">This config option is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="config-autoScroll"></a>
|
|
<div class="mdetail">
|
|
<h3>autoScroll</i></h3>
|
|
<code>autoScroll : Boolean</code>
|
|
<div class="mdetail-desc">
|
|
True to allow the dialog body contents to overflow and display scrollbars (defaults to false) </div>
|
|
<div class="mdetail-def">This config option is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="config-autoTabs"></a>
|
|
<div class="mdetail alt">
|
|
<h3>autoTabs</i></h3>
|
|
<code>autoTabs : Boolean</code>
|
|
<div class="mdetail-desc">
|
|
If true, all elements with class 'x-dlg-tab' will get automatically converted to tabs (defaults to false) </div>
|
|
<div class="mdetail-def">This config option is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="config-buttonAlign"></a>
|
|
<div class="mdetail">
|
|
<h3>buttonAlign</i></h3>
|
|
<code>buttonAlign : String</code>
|
|
<div class="mdetail-desc">
|
|
Valid values are "left," "center" and "right" (defaults to "right") </div>
|
|
<div class="mdetail-def">This config option is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="config-closable"></a>
|
|
<div class="mdetail alt">
|
|
<h3>closable</i></h3>
|
|
<code>closable : Boolean</code>
|
|
<div class="mdetail-desc">
|
|
False to remove the built-in top-right corner close button (defaults to true) </div>
|
|
<div class="mdetail-def">This config option is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="config-collapsible"></a>
|
|
<div class="mdetail">
|
|
<h3>collapsible</i></h3>
|
|
<code>collapsible : Boolean</code>
|
|
<div class="mdetail-desc">
|
|
False to remove the built-in top-right corner collapse button (defaults to true) </div>
|
|
<div class="mdetail-def">This config option is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="config-constraintoviewport"></a>
|
|
<div class="mdetail alt">
|
|
<h3>constraintoviewport</i></h3>
|
|
<code>constraintoviewport : Boolean</code>
|
|
<div class="mdetail-desc">
|
|
True to keep the dialog constrained within the visible viewport boundaries (defaults to true) </div>
|
|
<div class="mdetail-def">This config option is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="config-draggable"></a>
|
|
<div class="mdetail">
|
|
<h3>draggable</i></h3>
|
|
<code>draggable : Boolean</code>
|
|
<div class="mdetail-desc">
|
|
False to disable dragging of the dialog within the viewport (defaults to true) </div>
|
|
<div class="mdetail-def">This config option is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="config-fixedcenter"></a>
|
|
<div class="mdetail alt">
|
|
<h3>fixedcenter</i></h3>
|
|
<code>fixedcenter : Boolean</code>
|
|
<div class="mdetail-desc">
|
|
True to ensure that anytime the dialog is shown or resized it gets centered (defaults to false) </div>
|
|
<div class="mdetail-def">This config option is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="config-height"></a>
|
|
<div class="mdetail">
|
|
<h3>height</i></h3>
|
|
<code>height : Number</code>
|
|
<div class="mdetail-desc">
|
|
Height of the dialog in pixels (can also be set via CSS). Determined by browser if unspecified. </div>
|
|
<div class="mdetail-def">This config option is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="config-minButtonWidth"></a>
|
|
<div class="mdetail alt">
|
|
<h3>minButtonWidth</i></h3>
|
|
<code>minButtonWidth : Number</code>
|
|
<div class="mdetail-desc">
|
|
Minimum width of all dialog buttons (defaults to 75) </div>
|
|
<div class="mdetail-def">This config option is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="config-minHeight"></a>
|
|
<div class="mdetail">
|
|
<h3>minHeight</i></h3>
|
|
<code>minHeight : Number</code>
|
|
<div class="mdetail-desc">
|
|
The minimum allowable height for a resizable dialog (defaults to 80) </div>
|
|
<div class="mdetail-def">This config option is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="config-minWidth"></a>
|
|
<div class="mdetail alt">
|
|
<h3>minWidth</i></h3>
|
|
<code>minWidth : Number</code>
|
|
<div class="mdetail-desc">
|
|
The minimum allowable width for a resizable dialog (defaults to 200) </div>
|
|
<div class="mdetail-def">This config option is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="config-modal"></a>
|
|
<div class="mdetail">
|
|
<h3>modal</i></h3>
|
|
<code>modal : Boolean</code>
|
|
<div class="mdetail-desc">
|
|
True to show the dialog modally, preventing user interaction with the rest of the page (defaults to false) </div>
|
|
<div class="mdetail-def">This config option is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="config-proxyDrag"></a>
|
|
<div class="mdetail alt">
|
|
<h3>proxyDrag</i></h3>
|
|
<code>proxyDrag : Boolean</code>
|
|
<div class="mdetail-desc">
|
|
True to drag a lightweight proxy element rather than the dialog itself, used when draggable = true (defaults to false) </div>
|
|
<div class="mdetail-def">This config option is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="config-resizable"></a>
|
|
<div class="mdetail">
|
|
<h3>resizable</i></h3>
|
|
<code>resizable : Boolean</code>
|
|
<div class="mdetail-desc">
|
|
False to disable manual dialog resizing (defaults to true) </div>
|
|
<div class="mdetail-def">This config option is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="config-resizeHandles"></a>
|
|
<div class="mdetail alt">
|
|
<h3>resizeHandles</i></h3>
|
|
<code>resizeHandles : String</code>
|
|
<div class="mdetail-desc">
|
|
Which resize handles to display - see the <a href="Ext.Resizable.html">Ext.Resizable</a> handles config property for valid values (defaults to 'all') </div>
|
|
<div class="mdetail-def">This config option is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="config-shadow"></a>
|
|
<div class="mdetail">
|
|
<h3>shadow</i></h3>
|
|
<code>shadow : Boolean/String</code>
|
|
<div class="mdetail-desc">
|
|
True or "sides" for the default effect, "frame" for 4-way shadow, and "drop" for bottom-right shadow (defaults to false) </div>
|
|
<div class="mdetail-def">This config option is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="config-shadowOffset"></a>
|
|
<div class="mdetail alt">
|
|
<h3>shadowOffset</i></h3>
|
|
<code>shadowOffset : Number</code>
|
|
<div class="mdetail-desc">
|
|
The number of pixels to offset the shadow if displayed (defaults to 5) </div>
|
|
<div class="mdetail-def">This config option is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="config-shim"></a>
|
|
<div class="mdetail">
|
|
<h3>shim</i></h3>
|
|
<code>shim : Boolean</code>
|
|
<div class="mdetail-desc">
|
|
True to create an iframe shim that prevents selects from showing through (defaults to false) </div>
|
|
<div class="mdetail-def">This config option is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="config-syncHeightBeforeShow"></a>
|
|
<div class="mdetail alt">
|
|
<h3>syncHeightBeforeShow</i></h3>
|
|
<code>syncHeightBeforeShow : Boolean</code>
|
|
<div class="mdetail-desc">
|
|
True to cause the dimensions to be recalculated before the dialog is shown (defaults to false) </div>
|
|
<div class="mdetail-def">This config option is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="config-tabTag"></a>
|
|
<div class="mdetail">
|
|
<h3>tabTag</i></h3>
|
|
<code>tabTag : String</code>
|
|
<div class="mdetail-desc">
|
|
The tag name of tab elements, used when autoTabs = true (defaults to 'div') </div>
|
|
<div class="mdetail-def">This config option is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="config-title"></a>
|
|
<div class="mdetail alt">
|
|
<h3>title</i></h3>
|
|
<code>title : String</code>
|
|
<div class="mdetail-desc">
|
|
Default text to display in the title bar (defaults to null) </div>
|
|
<div class="mdetail-def">This config option is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="config-width"></a>
|
|
<div class="mdetail">
|
|
<h3>width</i></h3>
|
|
<code>width : Number</code>
|
|
<div class="mdetail-desc">
|
|
Width of the dialog in pixels (can also be set via CSS). Determined by browser if unspecified. </div>
|
|
<div class="mdetail-def">This config option is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="config-x"></a>
|
|
<div class="mdetail alt">
|
|
<h3>x</i></h3>
|
|
<code>x : Number</code>
|
|
<div class="mdetail-desc">
|
|
The default top page coordinate of the dialog (defaults to center screen) </div>
|
|
<div class="mdetail-def">This config option is defined by BasicDialog.</div>
|
|
</div>
|
|
<a name="config-y"></a>
|
|
<div class="mdetail">
|
|
<h3>y</i></h3>
|
|
<code>y : Number</code>
|
|
<div class="mdetail-desc">
|
|
The default left page coordinate of the dialog (defaults to center screen) </div>
|
|
<div class="mdetail-def">This config option is defined by BasicDialog.</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<hr>
|
|
<div style="font-size:10px;text-align:center;color:gray;">Ext - Copyright © 2006-2007 Ext JS, LLC<br />All rights reserved.</div>
|
|
|
|
</body>
|
|
</html> |