-// You can also add a custom class and use CSS inheritance rules to customize the box look.\r
-// 'x-box-blue' is a built-in alternative -- look at the related CSS definitions as an example\r
-// for how to create a custom box wrap style.\r
-Ext.get("foo").boxWrap().addClass("x-box-blue");</pre></code> <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>class</code> : String<div class="sub-desc">(optional) A base CSS class to apply to the containing wrapper element (defaults to 'x-box').
-Note that there are a number of CSS rules that are dependent on this name to make the overall effect work,
-so if you supply an alternate base class, make sure you also supply all of the necessary rules.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-center"></a>\r
- <b>center</b>( <span class="optional" title="Optional">[<code>Mixed centerIn</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Centers the Element in either the viewport, or another Element.</div>\r
- <div class="long">\r
- Centers the Element in either the viewport, or another Element. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>centerIn</code> : Mixed<div class="sub-desc">(optional) The element in which to center the element.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-child"></a>\r
- <b>child</b>( <code>String selector</code>, <span class="optional" title="Optional">[<code>Boolean returnDom</code>]</span> ) : HTMLElement/Ext.Element <div class="mdesc">\r
- <div class="short">Selects a single child at any depth below this element based on the passed CSS selector (the selector should not cont...</div>\r
- <div class="long">\r
- Selects a single child at any depth below this element based on the passed CSS selector (the selector should not contain an id). <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>selector</code> : String<div class="sub-desc">The CSS selector</div></li><li><code>returnDom</code> : Boolean<div class="sub-desc">(optional) True to return the DOM node instead of Ext.Element (defaults to false)</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>HTMLElement/Ext.Element</code><div class="sub-desc">The child Ext.Element (or DOM node if returnDom = true)</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-clean"></a>\r
- <b>clean</b>( <span class="optional" title="Optional">[<code>Boolean forceReclean</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Removes worthless text nodes</div>\r
- <div class="long">\r
- Removes worthless text nodes <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>forceReclean</code> : Boolean<div class="sub-desc">(optional) By default the element
-keeps track if it has been cleaned already so
-you can call this over and over. However, if you update the element and
-need to force a reclean, you can pass true.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-clearOpacity"></a>\r
- <b>clearOpacity</b>() : Ext.Element <div class="mdesc">\r
- <div class="short">Clears any opacity settings from this element. Required in some cases for IE.</div>\r
- <div class="long">\r
- Clears any opacity settings from this element. Required in some cases for IE. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-clearPositioning"></a>\r
- <b>clearPositioning</b>( <span class="optional" title="Optional">[<code>String value</code>]</span> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Clear positioning back to the default when the document was loaded</div>\r
- <div class="long">\r
- Clear positioning back to the default when the document was loaded <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>value</code> : String<div class="sub-desc">(optional) The value to use for the left,right,top,bottom, defaults to '' (empty string). You could use 'auto'.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-clip"></a>\r
- <b>clip</b>() : Ext.Element <div class="mdesc">\r
- <div class="short">Store the current overflow setting and clip overflow on the element - use <a ext:cls="Ext.Element" ext:member="unclip" href="output/Ext.Element.html#unclip">unclip</a> to remove</div>\r
- <div class="long">\r
- Store the current overflow setting and clip overflow on the element - use <a ext:cls="Ext.Element" ext:member="unclip" href="output/Ext.Element.html#unclip">unclip</a> to remove <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-contains"></a>\r
- <b>contains</b>( <code>HTMLElement/String el</code> ) : Boolean <div class="mdesc">\r
- <div class="short">Returns true if this element is an ancestor of the passed element</div>\r
- <div class="long">\r
- Returns true if this element is an ancestor of the passed element <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>el</code> : HTMLElement/String<div class="sub-desc">The element to check</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code><div class="sub-desc">True if this element is an ancestor of el, else false</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-createChild"></a>\r
- <b>createChild</b>( <code>Object config</code>, <span class="optional" title="Optional">[<code>HTMLElement insertBefore</code>]</span>, <span class="optional" title="Optional">[<code>Boolean returnDom</code>]</span> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child e...</div>\r
- <div class="long">\r
- Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child element. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>config</code> : Object<div class="sub-desc">DomHelper element config object. If no tag is specified (e.g., {tag:'input'}) then a div will be
-automatically generated with the specified attributes.</div></li><li><code>insertBefore</code> : HTMLElement<div class="sub-desc">(optional) a child element of this element</div></li><li><code>returnDom</code> : Boolean<div class="sub-desc">(optional) true to return the dom node instead of creating an Element</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">The new child element</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-createProxy"></a>\r
- <b>createProxy</b>( <code>String/Object config</code>, <span class="optional" title="Optional">[<code>String/HTMLElement renderTo</code>]</span>, <span class="optional" title="Optional">[<code>Boolean matchBox</code>]</span> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Creates a proxy element of this element</div>\r
- <div class="long">\r
- Creates a proxy element of this element <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>config</code> : String/Object<div class="sub-desc">The class name of the proxy element or a DomHelper config object</div></li><li><code>renderTo</code> : String/HTMLElement<div class="sub-desc">(optional) The element or element id to render the proxy to (defaults to document.body)</div></li><li><code>matchBox</code> : Boolean<div class="sub-desc">(optional) True to align and size the proxy to this element now (defaults to false)</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">The new proxy element</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-createShim"></a>\r
- <b>createShim</b>() : Ext.Element <div class="mdesc">\r
- <div class="short">Creates an iframe shim for this element to keep selects and other windowed objects from
-showing through.</div>\r
- <div class="long">\r
- Creates an iframe shim for this element to keep selects and other windowed objects from
-showing through. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">The new shim element</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-down"></a>\r
- <b>down</b>( <code>String selector</code>, <span class="optional" title="Optional">[<code>Boolean returnDom</code>]</span> ) : HTMLElement/Ext.Element <div class="mdesc">\r
- <div class="short">Selects a single *direct* child based on the passed CSS selector (the selector should not contain an id).</div>\r
- <div class="long">\r
- Selects a single *direct* child based on the passed CSS selector (the selector should not contain an id). <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>selector</code> : String<div class="sub-desc">The CSS selector</div></li><li><code>returnDom</code> : Boolean<div class="sub-desc">(optional) True to return the DOM node instead of Ext.Element (defaults to false)</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>HTMLElement/Ext.Element</code><div class="sub-desc">The child Ext.Element (or DOM node if returnDom = true)</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-enableDisplayMode"></a>\r
- <b>enableDisplayMode</b>( <span class="optional" title="Optional">[<code>String display</code>]</span> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Convenience method for setVisibilityMode(Element.DISPLAY)</div>\r
- <div class="long">\r
- Convenience method for setVisibilityMode(Element.DISPLAY) <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>display</code> : String<div class="sub-desc">(optional) What to set display to when visible</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-findParent"></a>\r
- <b>findParent</b>( <code>String selector</code>, <span class="optional" title="Optional">[<code>Number/Mixed maxDepth</code>]</span>, <span class="optional" title="Optional">[<code>Boolean returnEl</code>]</span> ) : HTMLElement <div class="mdesc">\r
- <div class="short">Looks at this node and then at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:fi...</div>\r
- <div class="long">\r
- Looks at this node and then at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child) <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>selector</code> : String<div class="sub-desc">The simple selector to test</div></li><li><code>maxDepth</code> : Number/Mixed<div class="sub-desc">(optional) The max depth to\r
- search as a number or element (defaults to 10 || document.body)</div></li><li><code>returnEl</code> : Boolean<div class="sub-desc">(optional) True to return a Ext.Element object instead of DOM node</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>HTMLElement</code><div class="sub-desc">The matching DOM node (or null if no match was found)</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-findParentNode"></a>\r
- <b>findParentNode</b>( <code>String selector</code>, <span class="optional" title="Optional">[<code>Number/Mixed maxDepth</code>]</span>, <span class="optional" title="Optional">[<code>Boolean returnEl</code>]</span> ) : HTMLElement <div class="mdesc">\r
- <div class="short">Looks at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child)</div>\r
- <div class="long">\r
- Looks at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child) <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>selector</code> : String<div class="sub-desc">The simple selector to test</div></li><li><code>maxDepth</code> : Number/Mixed<div class="sub-desc">(optional) The max depth to\r
- search as a number or element (defaults to 10 || document.body)</div></li><li><code>returnEl</code> : Boolean<div class="sub-desc">(optional) True to return a Ext.Element object instead of DOM node</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>HTMLElement</code><div class="sub-desc">The matching DOM node (or null if no match was found)</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-first"></a>\r
- <b>first</b>( <span class="optional" title="Optional">[<code>String selector</code>]</span>, <span class="optional" title="Optional">[<code>Boolean returnDom</code>]</span> ) : Ext.Element/HTMLElement <div class="mdesc">\r
- <div class="short">Gets the first child, skipping text nodes</div>\r
- <div class="long">\r
- Gets the first child, skipping text nodes <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>selector</code> : String<div class="sub-desc">(optional) Find the next sibling that matches the passed simple selector</div></li><li><code>returnDom</code> : Boolean<div class="sub-desc">(optional) True to return a raw dom node instead of an Ext.Element</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element/HTMLElement</code><div class="sub-desc">The first child or null</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-focus"></a>\r
- <b>focus</b>() : Ext.Element <div class="mdesc">\r
- <div class="short">Tries to focus the element. Any exceptions are caught and ignored.</div>\r
- <div class="long">\r
- Tries to focus the element. Any exceptions are caught and ignored. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-getAlignToXY"></a>\r
- <b>getAlignToXY</b>( <code>Mixed element</code>, <code>String position</code>, <span class="optional" title="Optional">[<code>Array offsets</code>]</span> ) : Array <div class="mdesc">\r
- <div class="short">Gets the x,y coordinates to align this element with another element. See alignTo for more info on the
-supported posit...</div>\r
- <div class="long">\r
- Gets the x,y coordinates to align this element with another element. See <a ext:cls="Ext.Element" ext:member="alignTo" href="output/Ext.Element.html#alignTo">alignTo</a> for more info on the
-supported position values. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>element</code> : Mixed<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.</div></li><li><code>offsets</code> : Array<div class="sub-desc">(optional) Offset the positioning by [x, y]</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Array</code><div class="sub-desc">[x, y]</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-getAnchorXY"></a>\r
- <b>getAnchorXY</b>( <span class="optional" title="Optional">[<code>String anchor</code>]</span>, <span class="optional" title="Optional">[<code>Boolean local</code>]</span>, <span class="optional" title="Optional">[<code>Object size</code>]</span> ) : Array <div class="mdesc">\r
- <div class="short">Gets the x,y coordinates specified by the anchor position on the element.</div>\r
- <div class="long">\r
- Gets the x,y coordinates specified by the anchor position on the element. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>anchor</code> : String<div class="sub-desc">(optional) The specified anchor position (defaults to "c"). See <a ext:cls="Ext.Element" ext:member="alignTo" href="output/Ext.Element.html#alignTo">alignTo</a>
-for details on supported anchor positions.</div></li><li><code>local</code> : Boolean<div class="sub-desc">(optional) True to get the local (element top/left-relative) anchor position instead
-of page coordinates</div></li><li><code>size</code> : Object<div class="sub-desc">(optional) An object containing the size to use for calculating anchor position
-{width: (target width), height: (target height)} (defaults to the element's current size)</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Array</code><div class="sub-desc">[x, y] An array containing the element's x and y coordinates</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-getAttributeNS"></a>\r
- <b>getAttributeNS</b>( <code>String namespace</code>, <code>String name</code> ) : String <div class="mdesc">\r
- <div class="short">Returns the value of a namespaced attribute from the element's underlying DOM node.</div>\r
- <div class="long">\r
- Returns the value of a namespaced attribute from the element's underlying DOM node. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>namespace</code> : String<div class="sub-desc">The namespace in which to look for the attribute</div></li><li><code>name</code> : String<div class="sub-desc">The attribute name</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>String</code><div class="sub-desc">The attribute value</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-getBorderWidth"></a>\r
- <b>getBorderWidth</b>( <code>String side</code> ) : Number <div class="mdesc">\r
- <div class="short">Gets the width of the border(s) for the specified side(s)</div>\r
- <div class="long">\r
- Gets the width of the border(s) for the specified side(s) <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>side</code> : String<div class="sub-desc">Can be t, l, r, b or any combination of those to add multiple values. For example,
-passing lr would get the border (l)eft width + the border (r)ight width.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Number</code><div class="sub-desc">The width of the sides passed added together</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-getBottom"></a>\r
- <b>getBottom</b>( <code>Boolean local</code> ) : Number <div class="mdesc">\r
- <div class="short">Gets the bottom Y coordinate of the element (element Y position + element height)</div>\r
- <div class="long">\r
- Gets the bottom Y coordinate of the element (element Y position + element height) <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>local</code> : Boolean<div class="sub-desc">True to get the local css position instead of page coordinate</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Number</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-getBox"></a>\r
- <b>getBox</b>( <span class="optional" title="Optional">[<code>Boolean contentBox</code>]</span>, <span class="optional" title="Optional">[<code>Boolean local</code>]</span> ) : Object <div class="mdesc">\r
- <div class="short">Return a box {x, y, width, height} that can be used to set another elements
-size/location to match this element.</div>\r
- <div class="long">\r
- Return a box {x, y, width, height} that can be used to set another elements
-size/location to match this element. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>contentBox</code> : Boolean<div class="sub-desc">(optional) If true a box for the content of the element is returned.</div></li><li><code>local</code> : Boolean<div class="sub-desc">(optional) If true the element's left and top are returned instead of page x/y.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Object</code><div class="sub-desc">box An object in the format {x, y, width, height}</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-getCenterXY"></a>\r
- <b>getCenterXY</b>() : Array <div class="mdesc">\r
- <div class="short">Calculates the x, y to center this element on the screen</div>\r
- <div class="long">\r
- Calculates the x, y to center this element on the screen <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Array</code><div class="sub-desc">The x, y values [x, y]</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-getColor"></a>\r
- <b>getColor</b>( <code>String attr</code>, <code>String defaultValue</code>, <span class="optional" title="Optional">[<code>String prefix</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Return the CSS color for the specified CSS attribute. rgb, 3 digit (like #fff) and valid values
-are convert to standa...</div>\r
- <div class="long">\r
- Return the CSS color for the specified CSS attribute. rgb, 3 digit (like #fff) and valid values
-are convert to standard 6 digit hex color. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>attr</code> : String<div class="sub-desc">The css attribute</div></li><li><code>defaultValue</code> : String<div class="sub-desc">The default value to use when a valid color isn't found</div></li><li><code>prefix</code> : String<div class="sub-desc">(optional) defaults to #. Use an empty string when working with
-color anims.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-getComputedHeight"></a>\r
- <b>getComputedHeight</b>() : Number <div class="mdesc">\r
- <div class="short">Returns either the offsetHeight or the height of this element based on CSS height adjusted by padding or borders
-when...</div>\r
- <div class="long">\r
- Returns either the offsetHeight or the height of this element based on CSS height adjusted by padding or borders
-when needed to simulate offsetHeight when offsets aren't available. This may not work on display:none elements
-if a height has not been set using CSS. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Number</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-getComputedWidth"></a>\r
- <b>getComputedWidth</b>() : Number <div class="mdesc">\r
- <div class="short">Returns either the offsetWidth or the width of this element based on CSS width adjusted by padding or borders
-when ne...</div>\r
- <div class="long">\r
- Returns either the offsetWidth or the width of this element based on CSS width adjusted by padding or borders
-when needed to simulate offsetWidth when offsets aren't available. This may not work on display:none elements
-if a width has not been set using CSS. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Number</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-getFrameWidth"></a>\r
- <b>getFrameWidth</b>( <code>String sides</code> ) : Number <div class="mdesc">\r
- <div class="short">Returns the sum width of the padding and borders for the passed "sides". See getBorderWidth()\r
- for more informat...</div>\r
- <div class="long">\r
- Returns the sum width of the padding and borders for the passed "sides". See getBorderWidth()\r
- for more information about the sides. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>sides</code> : String<div class="sub-desc"></div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Number</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-getHeight"></a>\r
- <b>getHeight</b>( <span class="optional" title="Optional">[<code>Boolean contentHeight</code>]</span> ) : Number <div class="mdesc">\r
- <div class="short">Returns the offset height of the element</div>\r
- <div class="long">\r
- Returns the offset height of the element <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>contentHeight</code> : Boolean<div class="sub-desc">(optional) true to get the height minus borders and padding</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Number</code><div class="sub-desc">The element's height</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-getLeft"></a>\r
- <b>getLeft</b>( <code>Boolean local</code> ) : Number <div class="mdesc">\r
- <div class="short">Gets the left X coordinate</div>\r
- <div class="long">\r
- Gets the left X coordinate <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>local</code> : Boolean<div class="sub-desc">True to get the local css position instead of page coordinate</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Number</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-getMargins"></a>\r
- <b>getMargins</b>( <span class="optional" title="Optional">[<code>String sides</code>]</span> ) : Object/Number <div class="mdesc">\r
- <div class="short">Returns an object with properties top, left, right and bottom representing the margins of this element unless sides i...</div>\r
- <div class="long">\r
- Returns an object with properties top, left, right and bottom representing the margins of this element unless sides is passed,
-then it returns the calculated width of the sides (see getPadding) <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>sides</code> : String<div class="sub-desc">(optional) Any combination of l, r, t, b to get the sum of those sides</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Object/Number</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-getOffsetsTo"></a>\r
- <b>getOffsetsTo</b>( <code>Mixed element</code> ) : Array <div class="mdesc">\r
- <div class="short">Returns the offsets of this element from the passed element. Both element must be part of the DOM tree and not have d...</div>\r
- <div class="long">\r
- Returns the offsets of this element from the passed element. Both element must be part of the DOM tree and not have display:none to have page coordinates. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>element</code> : Mixed<div class="sub-desc">The element to get the offsets from.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Array</code><div class="sub-desc">The XY page offsets (e.g. [100, -200])</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-getPadding"></a>\r
- <b>getPadding</b>( <code>String side</code> ) : Number <div class="mdesc">\r
- <div class="short">Gets the width of the padding(s) for the specified side(s)</div>\r
- <div class="long">\r
- Gets the width of the padding(s) for the specified side(s) <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>side</code> : String<div class="sub-desc">Can be t, l, r, b or any combination of those to add multiple values. For example,
-passing lr would get the padding (l)eft + the padding (r)ight.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Number</code><div class="sub-desc">The padding of the sides passed added together</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-getPositioning"></a>\r
- <b>getPositioning</b>() : Object <div class="mdesc">\r
- <div class="short">Gets an object with all CSS positioning properties. Useful along with setPostioning to get
-snapshot before performing...</div>\r
- <div class="long">\r
- Gets an object with all CSS positioning properties. Useful along with setPostioning to get
-snapshot before performing an update and then restoring the element. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Object</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-getRegion"></a>\r
- <b>getRegion</b>() : Region <div class="mdesc">\r
- <div class="short">Returns the region of the given element.
-The element must be part of the DOM tree to have a region (display:none or e...</div>\r
- <div class="long">\r
- Returns the region of the given element.
-The element must be part of the DOM tree to have a region (display:none or elements not appended return false). <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Region</code><div class="sub-desc">A Ext.lib.Region containing "top, left, bottom, right" member data.</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-getRight"></a>\r
- <b>getRight</b>( <code>Boolean local</code> ) : Number <div class="mdesc">\r
- <div class="short">Gets the right X coordinate of the element (element X position + element width)</div>\r
- <div class="long">\r
- Gets the right X coordinate of the element (element X position + element width) <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>local</code> : Boolean<div class="sub-desc">True to get the local css position instead of page coordinate</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Number</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-getScroll"></a>\r
- <b>getScroll</b>() : Object <div class="mdesc">\r
- <div class="short">Returns the current scroll position of the element.</div>\r
- <div class="long">\r
- Returns the current scroll position of the element. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Object</code><div class="sub-desc">An object containing the scroll position in the format {left: (scrollLeft), top: (scrollTop)}</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-getSize"></a>\r
- <b>getSize</b>( <span class="optional" title="Optional">[<code>Boolean contentSize</code>]</span> ) : Object <div class="mdesc">\r
- <div class="short">Returns the size of the element.</div>\r
- <div class="long">\r
- Returns the size of the element. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>contentSize</code> : Boolean<div class="sub-desc">(optional) true to get the width/size minus borders and padding</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Object</code><div class="sub-desc">An object containing the element's size {width: (element width), height: (element height)}</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-getStyle"></a>\r
- <b>getStyle</b>( <code>String property</code> ) : String <div class="mdesc">\r
- <div class="short">Normalizes currentStyle and computedStyle.</div>\r
- <div class="long">\r
- Normalizes currentStyle and computedStyle. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>property</code> : String<div class="sub-desc">The style property whose value is returned.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>String</code><div class="sub-desc">The current value of the style property for this element.</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-getStyles"></a>\r
- <b>getStyles</b>( <code>String style1</code>, <code>String style2</code>, <code>String etc.</code> ) : Object <div class="mdesc">\r
- <div class="short">Returns an object with properties matching the styles requested.
-For example, el.getStyles('color', 'font-size', 'wid...</div>\r
- <div class="long">\r
- Returns an object with properties matching the styles requested.
-For example, el.getStyles('color', 'font-size', 'width') might return
-{'color': '#FFFFFF', 'font-size': '13px', 'width': '100px'}. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>style1</code> : String<div class="sub-desc">A style name</div></li><li><code>style2</code> : String<div class="sub-desc">A style name</div></li><li><code>etc.</code> : String<div class="sub-desc"></div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Object</code><div class="sub-desc">The style object</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-getTextWidth"></a>\r
- <b>getTextWidth</b>( <code>String text</code>, <span class="optional" title="Optional">[<code>Number min</code>]</span>, <span class="optional" title="Optional">[<code>Number max</code>]</span> ) : Number <div class="mdesc">\r
- <div class="short">Returns the width in pixels of the passed text, or the width of the text in this Element.</div>\r
- <div class="long">\r
- Returns the width in pixels of the passed text, or the width of the text in this Element. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>text</code> : String<div class="sub-desc">The text to measure. Defaults to the innerHTML of the element.</div></li><li><code>min</code> : Number<div class="sub-desc">(Optional) The minumum value to return.</div></li><li><code>max</code> : Number<div class="sub-desc">(Optional) The maximum value to return.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Number</code><div class="sub-desc">The text width in pixels.</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-getTop"></a>\r
- <b>getTop</b>( <code>Boolean local</code> ) : Number <div class="mdesc">\r
- <div class="short">Gets the top Y coordinate</div>\r
- <div class="long">\r
- Gets the top Y coordinate <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>local</code> : Boolean<div class="sub-desc">True to get the local css position instead of page coordinate</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Number</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-getUpdater"></a>\r
- <b>getUpdater</b>() : Ext.Updater <div class="mdesc">\r
- <div class="short">Gets this element's Updater</div>\r
- <div class="long">\r
- Gets this element's Updater <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Updater</code><div class="sub-desc">The Updater</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-getValue"></a>\r
- <b>getValue</b>( <code>Boolean asNumber</code> ) : String/Number <div class="mdesc">\r
- <div class="short">Returns the value of the "value" attribute</div>\r
- <div class="long">\r
- Returns the value of the "value" attribute <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>asNumber</code> : Boolean<div class="sub-desc">true to parse the value as a number</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>String/Number</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-getViewSize"></a>\r
- <b>getViewSize</b>() : Object <div class="mdesc">\r
- <div class="short">Returns the width and height of the viewport.</div>\r
- <div class="long">\r
- Returns the width and height of the viewport. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Object</code><div class="sub-desc">An object containing the viewport's size {width: (viewport width), height: (viewport height)}</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-getWidth"></a>\r
- <b>getWidth</b>( <span class="optional" title="Optional">[<code>Boolean contentWidth</code>]</span> ) : Number <div class="mdesc">\r
- <div class="short">Returns the offset width of the element</div>\r
- <div class="long">\r
- Returns the offset width of the element <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>contentWidth</code> : Boolean<div class="sub-desc">(optional) true to get the width minus borders and padding</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Number</code><div class="sub-desc">The element's width</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-getX"></a>\r
- <b>getX</b>() : Number <div class="mdesc">\r
- <div class="short">Gets the current X position of the element based on page coordinates. Element must be part of the DOM tree to have p...</div>\r
- <div class="long">\r
- Gets the current X position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false). <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Number</code><div class="sub-desc">The X position of the element</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-getXY"></a>\r
- <b>getXY</b>() : Array <div class="mdesc">\r
- <div class="short">Gets the current position of the element based on page coordinates. Element must be part of the DOM tree to have pag...</div>\r
- <div class="long">\r
- Gets the current position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false). <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Array</code><div class="sub-desc">The XY position of the element</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-getY"></a>\r
- <b>getY</b>() : Number <div class="mdesc">\r
- <div class="short">Gets the current Y position of the element based on page coordinates. Element must be part of the DOM tree to have p...</div>\r
- <div class="long">\r
- Gets the current Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false). <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Number</code><div class="sub-desc">The Y position of the element</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-hasClass"></a>\r
- <b>hasClass</b>( <code>String className</code> ) : Boolean <div class="mdesc">\r
- <div class="short">Checks if the specified CSS class exists on this element's DOM node.</div>\r
- <div class="long">\r
- Checks if the specified CSS class exists on this element's DOM node. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>className</code> : String<div class="sub-desc">The CSS class to check for</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code><div class="sub-desc">True if the class exists, else false</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-hide"></a>\r
- <b>hide</b>( <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Hide this element - Uses display mode to determine whether to use "display" or "visibility". See <a ext:cls="Ext.Element" ext:member="setVisible" href="output/Ext.Element.html#setVisible">setVisible</a>.</div>\r
- <div class="long">\r
- Hide this element - Uses display mode to determine whether to use "display" or "visibility". See <a ext:cls="Ext.Element" ext:member="setVisible" href="output/Ext.Element.html#setVisible">setVisible</a>. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>animate</code> : Boolean/Object<div class="sub-desc">(optional) true for the default animation or a standard Element animation config object</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-hover"></a>\r
- <b>hover</b>( <code>Function overFn</code>, <code>Function outFn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Sets up event handlers to call the passed functions when the mouse is over this element. Automatically
-filters child ...</div>\r
- <div class="long">\r
- Sets up event handlers to call the passed functions when the mouse is over this element. Automatically
-filters child element mouse events. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>overFn</code> : Function<div class="sub-desc"></div></li><li><code>outFn</code> : Function<div class="sub-desc"></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional)</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-initDD"></a>\r
- <b>initDD</b>( <code>String group</code>, <code>Object config</code>, <code>Object overrides</code> ) : Ext.dd.DD <div class="mdesc">\r
- <div class="short">Initializes a <a ext:cls="Ext.dd.DD" href="output/Ext.dd.DD.html">Ext.dd.DD</a> drag drop object for this element.</div>\r
- <div class="long">\r
- Initializes a <a ext:cls="Ext.dd.DD" href="output/Ext.dd.DD.html">Ext.dd.DD</a> drag drop object for this element. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>group</code> : String<div class="sub-desc">The group the DD object is member of</div></li><li><code>config</code> : Object<div class="sub-desc">The DD config object</div></li><li><code>overrides</code> : Object<div class="sub-desc">An object containing methods to override/implement on the DD object</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.dd.DD</code><div class="sub-desc">The DD object</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-initDDProxy"></a>\r
- <b>initDDProxy</b>( <code>String group</code>, <code>Object config</code>, <code>Object overrides</code> ) : Ext.dd.DDProxy <div class="mdesc">\r
- <div class="short">Initializes a <a ext:cls="Ext.dd.DDProxy" href="output/Ext.dd.DDProxy.html">Ext.dd.DDProxy</a> object for this element.</div>\r
- <div class="long">\r
- Initializes a <a ext:cls="Ext.dd.DDProxy" href="output/Ext.dd.DDProxy.html">Ext.dd.DDProxy</a> object for this element. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>group</code> : String<div class="sub-desc">The group the DDProxy object is member of</div></li><li><code>config</code> : Object<div class="sub-desc">The DDProxy config object</div></li><li><code>overrides</code> : Object<div class="sub-desc">An object containing methods to override/implement on the DDProxy object</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.dd.DDProxy</code><div class="sub-desc">The DDProxy object</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-initDDTarget"></a>\r
- <b>initDDTarget</b>( <code>String group</code>, <code>Object config</code>, <code>Object overrides</code> ) : Ext.dd.DDTarget <div class="mdesc">\r
- <div class="short">Initializes a <a ext:cls="Ext.dd.DDTarget" href="output/Ext.dd.DDTarget.html">Ext.dd.DDTarget</a> object for this element.</div>\r
- <div class="long">\r
- Initializes a <a ext:cls="Ext.dd.DDTarget" href="output/Ext.dd.DDTarget.html">Ext.dd.DDTarget</a> object for this element. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>group</code> : String<div class="sub-desc">The group the DDTarget object is member of</div></li><li><code>config</code> : Object<div class="sub-desc">The DDTarget config object</div></li><li><code>overrides</code> : Object<div class="sub-desc">An object containing methods to override/implement on the DDTarget object</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.dd.DDTarget</code><div class="sub-desc">The DDTarget object</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-insertAfter"></a>\r
- <b>insertAfter</b>( <code>Mixed el</code> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Inserts this element after the passed element in the DOM</div>\r
- <div class="long">\r
- Inserts this element after the passed element in the DOM <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>el</code> : Mixed<div class="sub-desc">The element to insert after</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-insertBefore"></a>\r
- <b>insertBefore</b>( <code>Mixed el</code> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Inserts this element before the passed element in the DOM</div>\r
- <div class="long">\r
- Inserts this element before the passed element in the DOM <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>el</code> : Mixed<div class="sub-desc">The element before which this element will be inserted</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-insertFirst"></a>\r
- <b>insertFirst</b>( <code>Mixed/Object el</code> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Inserts (or creates) an element (or DomHelper config) as the first child of this element</div>\r
- <div class="long">\r
- Inserts (or creates) an element (or DomHelper config) as the first child of this element <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>el</code> : Mixed/Object<div class="sub-desc">The id or element to insert or a DomHelper config to create and insert</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">The new child</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-insertHtml"></a>\r
- <b>insertHtml</b>( <code>String where</code>, <code>String html</code>, <span class="optional" title="Optional">[<code>Boolean returnEl</code>]</span> ) : HTMLElement/Ext.Element <div class="mdesc">\r
- <div class="short">Inserts an html fragment into this element</div>\r
- <div class="long">\r
- Inserts an html fragment into this element <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>where</code> : String<div class="sub-desc">Where to insert the html in relation to this element - beforeBegin, afterBegin, beforeEnd, afterEnd.</div></li><li><code>html</code> : String<div class="sub-desc">The HTML fragment</div></li><li><code>returnEl</code> : Boolean<div class="sub-desc">(optional) True to return an Ext.Element (defaults to false)</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>HTMLElement/Ext.Element</code><div class="sub-desc">The inserted node (or nearest related if more than 1 inserted)</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-insertSibling"></a>\r
- <b>insertSibling</b>( <code>Mixed/Object/Array el</code>, <span class="optional" title="Optional">[<code>String where</code>]</span>, <span class="optional" title="Optional">[<code>Boolean returnDom</code>]</span> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Inserts (or creates) the passed element (or DomHelper config) as a sibling of this element</div>\r
- <div class="long">\r
- Inserts (or creates) the passed element (or DomHelper config) as a sibling of this element <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>el</code> : Mixed/Object/Array<div class="sub-desc">The id, element to insert or a DomHelper config to create and insert *or* an array of any of those.</div></li><li><code>where</code> : String<div class="sub-desc">(optional) 'before' or 'after' defaults to before</div></li><li><code>returnDom</code> : Boolean<div class="sub-desc">(optional) True to return the raw DOM element instead of Ext.Element</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">the inserted Element</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-is"></a>\r
- <b>is</b>( <code>String selector</code> ) : Boolean <div class="mdesc">\r
- <div class="short">Returns true if this element matches the passed simple selector (e.g. div.some-class or span:first-child)</div>\r
- <div class="long">\r
- Returns true if this element matches the passed simple selector (e.g. div.some-class or span:first-child) <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>selector</code> : String<div class="sub-desc">The simple selector to test</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code><div class="sub-desc">True if this element matches the selector, else false</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-isBorderBox"></a>\r
- <b>isBorderBox</b>() : Boolean <div class="mdesc">\r
- <div class="short">Tests various css rules/browsers to determine if this element uses a border box</div>\r
- <div class="long">\r
- Tests various css rules/browsers to determine if this element uses a border box <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-isDisplayed"></a>\r
- <b>isDisplayed</b>() : Boolean <div class="mdesc">\r
- <div class="short">Returns true if display is not "none"</div>\r
- <div class="long">\r
- Returns true if display is not "none" <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-isMasked"></a>\r
- <b>isMasked</b>() : Boolean <div class="mdesc">\r
- <div class="short">Returns true if this element is masked</div>\r
- <div class="long">\r
- Returns true if this element is masked <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-isScrollable"></a>\r
- <b>isScrollable</b>() : Boolean <div class="mdesc">\r
- <div class="short">Returns true if this element is scrollable.</div>\r
- <div class="long">\r
- Returns true if this element is scrollable. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-isVisible"></a>\r
- <b>isVisible</b>( <span class="optional" title="Optional">[<code>Boolean deep</code>]</span> ) : Boolean <div class="mdesc">\r
- <div class="short">Checks whether the element is currently visible using both visibility and display properties.</div>\r
- <div class="long">\r
- Checks whether the element is currently visible using both visibility and display properties. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>deep</code> : Boolean<div class="sub-desc">(optional) True to walk the dom and see if parent elements are hidden (defaults to false)</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code><div class="sub-desc">True if the element is currently visible, else false</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-last"></a>\r
- <b>last</b>( <span class="optional" title="Optional">[<code>String selector</code>]</span>, <span class="optional" title="Optional">[<code>Boolean returnDom</code>]</span> ) : Ext.Element/HTMLElement <div class="mdesc">\r
- <div class="short">Gets the last child, skipping text nodes</div>\r
- <div class="long">\r
- Gets the last child, skipping text nodes <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>selector</code> : String<div class="sub-desc">(optional) Find the previous sibling that matches the passed simple selector</div></li><li><code>returnDom</code> : Boolean<div class="sub-desc">(optional) True to return a raw dom node instead of an Ext.Element</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element/HTMLElement</code><div class="sub-desc">The last child or null</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-load"></a>\r
- <b>load</b>() : Ext.Element <div class="mdesc">\r
- <div class="short">Direct access to the Updater <a ext:cls="Ext.Updater" ext:member="update" href="output/Ext.Updater.html#update">Ext.Updater.update</a> method. The method takes the same object
-parameter as <a ext:cls="Ext.Updater" ext:member="update" href="output/Ext.Updater.html#update">Ext.Updater.update</a></div>\r
- <div class="long">\r
- Direct access to the Updater <a ext:cls="Ext.Updater" ext:member="update" href="output/Ext.Updater.html#update">Ext.Updater.update</a> method. The method takes the same object
-parameter as <a ext:cls="Ext.Updater" ext:member="update" href="output/Ext.Updater.html#update">Ext.Updater.update</a> <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-mask"></a>\r
- <b>mask</b>( <span class="optional" title="Optional">[<code>String msg</code>]</span>, <span class="optional" title="Optional">[<code>String msgCls</code>]</span> ) : Element <div class="mdesc">\r
- <div class="short">Puts a mask over this element to disable user interaction. Requires core.css.
-This method can only be applied to elem...</div>\r
- <div class="long">\r
- Puts a mask over this element to disable user interaction. Requires core.css.
-This method can only be applied to elements which accept child nodes. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>msg</code> : String<div class="sub-desc">(optional) A message to display in the mask</div></li><li><code>msgCls</code> : String<div class="sub-desc">(optional) A css class to apply to the msg element</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Element</code><div class="sub-desc">The mask element</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-move"></a>\r
- <b>move</b>( <code>String direction</code>, <code>Number distance</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Move this element relative to its current position.</div>\r
- <div class="long">\r
- Move this element relative to its current position. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>direction</code> : String<div class="sub-desc">Possible values are: "l" (or "left"), "r" (or "right"), "t" (or "top", or "up"), "b" (or "bottom", or "down").</div></li><li><code>distance</code> : Number<div class="sub-desc">How far to move the element in pixels</div></li><li><code>animate</code> : Boolean/Object<div class="sub-desc">(optional) true for the default animation or a standard Element animation config object</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-moveTo"></a>\r
- <b>moveTo</b>( <code>Number x</code>, <code>Number y</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Sets the position of the element in page coordinates, regardless of how the element is positioned.
-The element must b...</div>\r
- <div class="long">\r
- Sets the position of the element in page coordinates, regardless of how the element is positioned.
-The element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false). <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>x</code> : Number<div class="sub-desc">X value for new position (coordinates are page-based)</div></li><li><code>y</code> : Number<div class="sub-desc">Y value for new position (coordinates are page-based)</div></li><li><code>animate</code> : Boolean/Object<div class="sub-desc">(optional) True for the default animation, or a standard Element animation config object</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-next"></a>\r
- <b>next</b>( <span class="optional" title="Optional">[<code>String selector</code>]</span>, <span class="optional" title="Optional">[<code>Boolean returnDom</code>]</span> ) : Ext.Element/HTMLElement <div class="mdesc">\r
- <div class="short">Gets the next sibling, skipping text nodes</div>\r
- <div class="long">\r
- Gets the next sibling, skipping text nodes <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>selector</code> : String<div class="sub-desc">(optional) Find the next sibling that matches the passed simple selector</div></li><li><code>returnDom</code> : Boolean<div class="sub-desc">(optional) True to return a raw dom node instead of an Ext.Element</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element/HTMLElement</code><div class="sub-desc">The next sibling or null</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-on"></a>\r
- <b>on</b>( <code>String eventName</code>, <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Appends an event handler (shorthand for <a ext:cls="Ext.Element" ext:member="addListener" href="output/Ext.Element.html#addListener">addListener</a>).</div>\r
- <div class="long">\r
- Appends an event handler (shorthand for <a ext:cls="Ext.Element" ext:member="addListener" href="output/Ext.Element.html#addListener">addListener</a>). <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to handle</div></li><li><code>fn</code> : Function<div class="sub-desc">The handler function the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this element) of the handler function</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing standard <a ext:cls="Ext.Element" ext:member="addListener" href="output/Ext.Element.html#addListener">addListener</a> options</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-parent"></a>\r
- <b>parent</b>( <span class="optional" title="Optional">[<code>String selector</code>]</span>, <span class="optional" title="Optional">[<code>Boolean returnDom</code>]</span> ) : Ext.Element/HTMLElement <div class="mdesc">\r
- <div class="short">Gets the parent node for this element, optionally chaining up trying to match a selector</div>\r
- <div class="long">\r
- Gets the parent node for this element, optionally chaining up trying to match a selector <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>selector</code> : String<div class="sub-desc">(optional) Find a parent node that matches the passed simple selector</div></li><li><code>returnDom</code> : Boolean<div class="sub-desc">(optional) True to return a raw dom node instead of an Ext.Element</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element/HTMLElement</code><div class="sub-desc">The parent node or null</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-position"></a>\r
- <b>position</b>( <span class="optional" title="Optional">[<code>String pos</code>]</span>, <span class="optional" title="Optional">[<code>Number zIndex</code>]</span>, <span class="optional" title="Optional">[<code>Number x</code>]</span>, <span class="optional" title="Optional">[<code>Number y</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Initializes positioning on this element. If a desired position is not passed, it will make the
-the element positioned...</div>\r
- <div class="long">\r
- Initializes positioning on this element. If a desired position is not passed, it will make the
-the element positioned relative IF it is not already positioned. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>pos</code> : String<div class="sub-desc">(optional) Positioning to use "relative", "absolute" or "fixed"</div></li><li><code>zIndex</code> : Number<div class="sub-desc">(optional) The zIndex to apply</div></li><li><code>x</code> : Number<div class="sub-desc">(optional) Set the page X position</div></li><li><code>y</code> : Number<div class="sub-desc">(optional) Set the page Y position</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-prev"></a>\r
- <b>prev</b>( <span class="optional" title="Optional">[<code>String selector</code>]</span>, <span class="optional" title="Optional">[<code>Boolean returnDom</code>]</span> ) : Ext.Element/HTMLElement <div class="mdesc">\r
- <div class="short">Gets the previous sibling, skipping text nodes</div>\r
- <div class="long">\r
- Gets the previous sibling, skipping text nodes <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>selector</code> : String<div class="sub-desc">(optional) Find the previous sibling that matches the passed simple selector</div></li><li><code>returnDom</code> : Boolean<div class="sub-desc">(optional) True to return a raw dom node instead of an Ext.Element</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element/HTMLElement</code><div class="sub-desc">The previous sibling or null</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-query"></a>\r
- <b>query</b>( <code>String selector</code> ) : Array <div class="mdesc">\r
- <div class="short">Selects child nodes based on the passed CSS selector (the selector should not contain an id).</div>\r
- <div class="long">\r
- Selects child nodes based on the passed CSS selector (the selector should not contain an id). <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>selector</code> : String<div class="sub-desc">The CSS selector</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Array</code><div class="sub-desc">An array of the matched nodes</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-radioClass"></a>\r
- <b>radioClass</b>( <code>String/Array className</code> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Adds one or more CSS classes to this element and removes the same class(es) from all siblings.</div>\r
- <div class="long">\r
- Adds one or more CSS classes to this element and removes the same class(es) from all siblings. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>className</code> : String/Array<div class="sub-desc">The CSS class to add, or an array of classes</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-relayEvent"></a>\r
- <b>relayEvent</b>( <code>String eventName</code>, <code>Object object</code> ) : void <div class="mdesc">\r
- <div class="short">Create an event handler on this element such that when the event fires and is handled by this element,
-it will be rel...</div>\r
- <div class="long">\r
- Create an event handler on this element such that when the event fires and is handled by this element,
-it will be relayed to another object (i.e., fired again as if it originated from that object instead). <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to relay</div></li><li><code>object</code> : Object<div class="sub-desc">Any object that extends <a ext:cls="Ext.util.Observable" href="output/Ext.util.Observable.html">Ext.util.Observable</a> that will provide the context
-for firing the relayed event</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-remove"></a>\r
- <b>remove</b>() : void <div class="mdesc">\r
- <div class="short">Removes this element from the DOM and deletes it from the cache</div>\r
- <div class="long">\r
- Removes this element from the DOM and deletes it from the cache <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-removeAllListeners"></a>\r
- <b>removeAllListeners</b>() : Ext.Element <div class="mdesc">\r
- <div class="short">Removes all previous added listeners from this element</div>\r
- <div class="long">\r
- Removes all previous added listeners from this element <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-removeClass"></a>\r
- <b>removeClass</b>( <code>String/Array className</code> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Removes one or more CSS classes from the element.</div>\r
- <div class="long">\r
- Removes one or more CSS classes from the element. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>className</code> : String/Array<div class="sub-desc">The CSS class to remove, or an array of classes</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-removeListener"></a>\r
- <b>removeListener</b>( <code>String eventName</code>, <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Removes an event handler from this element. The shorthand version un is equivalent. Example:
-el.removeListener('cli...</div>\r
- <div class="long">\r
- Removes an event handler from this element. The shorthand version <a ext:cls="Ext.Element" ext:member="un" href="output/Ext.Element.html#un">un</a> is equivalent. Example:
-<pre><code>el.removeListener(<em>'click'</em>, <b>this</b>.handlerFn);
-<i>// or</i>
-el.un(<em>'click'</em>, <b>this</b>.handlerFn);</code></pre> <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>eventName</code> : String<div class="sub-desc">the type of event to remove</div></li><li><code>fn</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 (The <tt>this</tt> reference) of the handler function. Defaults
-to this Element.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-repaint"></a>\r
- <b>repaint</b>() : Ext.Element <div class="mdesc">\r
- <div class="short">Forces the browser to repaint this element</div>\r
- <div class="long">\r
- Forces the browser to repaint this element <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-replace"></a>\r
- <b>replace</b>( <code>Mixed el</code> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Replaces the passed element with this element</div>\r
- <div class="long">\r
- Replaces the passed element with this element <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>el</code> : Mixed<div class="sub-desc">The element to replace</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-replaceClass"></a>\r
- <b>replaceClass</b>( <code>String oldClassName</code>, <code>String newClassName</code> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Replaces a CSS class on the element with another. If the old name does not exist, the new name will simply be added.</div>\r
- <div class="long">\r
- Replaces a CSS class on the element with another. If the old name does not exist, the new name will simply be added. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>oldClassName</code> : String<div class="sub-desc">The CSS class to replace</div></li><li><code>newClassName</code> : String<div class="sub-desc">The replacement CSS class</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-replaceWith"></a>\r
- <b>replaceWith</b>( <code>Mixed/Object el</code> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Replaces this element with the passed element</div>\r
- <div class="long">\r
- Replaces this element with the passed element <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>el</code> : Mixed/Object<div class="sub-desc">The new element or a DomHelper config of an element to create</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-scroll"></a>\r
- <b>scroll</b>( <code>String direction</code>, <code>Number distance</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span> ) : Boolean <div class="mdesc">\r
- <div class="short">Scrolls this element the specified direction. Does bounds checking to make sure the scroll is
-within this element's s...</div>\r
- <div class="long">\r
- Scrolls this element the specified direction. Does bounds checking to make sure the scroll is
-within this element's scrollable range. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>direction</code> : String<div class="sub-desc">Possible values are: "l" (or "left"), "r" (or "right"), "t" (or "top", or "up"), "b" (or "bottom", or "down").</div></li><li><code>distance</code> : Number<div class="sub-desc">How far to scroll the element in pixels</div></li><li><code>animate</code> : Boolean/Object<div class="sub-desc">(optional) true for the default animation or a standard Element animation config object</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code><div class="sub-desc">Returns true if a scroll was triggered or false if the element was scrolled as far as it could go.</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-scrollIntoView"></a>\r
- <b>scrollIntoView</b>( <span class="optional" title="Optional">[<code>Mixed container</code>]</span>, <span class="optional" title="Optional">[<code>Boolean hscroll</code>]</span> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Scrolls this element into view within the passed container.</div>\r
- <div class="long">\r
- Scrolls this element into view within the passed container. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>container</code> : Mixed<div class="sub-desc">(optional) The container element to scroll (defaults to document.body). Should be a
-string (id), dom node, or Ext.Element.</div></li><li><code>hscroll</code> : Boolean<div class="sub-desc">(optional) False to disable horizontal scroll (defaults to true)</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-scrollTo"></a>\r
- <b>scrollTo</b>( <code>String side</code>, <code>Number value</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span> ) : Element <div class="mdesc">\r
- <div class="short">Scrolls this element the specified scroll point. It does NOT do bounds checking so if you scroll to a weird value it ...</div>\r
- <div class="long">\r
- Scrolls this element the specified scroll point. It does NOT do bounds checking so if you scroll to a weird value it will try to do it. For auto bounds checking, use scroll(). <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>side</code> : String<div class="sub-desc">Either "left" for scrollLeft values or "top" for scrollTop values.</div></li><li><code>value</code> : Number<div class="sub-desc">The new scroll value</div></li><li><code>animate</code> : Boolean/Object<div class="sub-desc">(optional) true for the default animation or a standard Element animation config object</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-select"></a>\r
- <b>select</b>( <code>String selector</code>, <span class="optional" title="Optional">[<code>Boolean unique</code>]</span> ) : CompositeElement/CompositeElementLite <div class="mdesc">\r
- <div class="short">Creates a <a ext:cls="Ext.CompositeElement" href="output/Ext.CompositeElement.html">Ext.CompositeElement</a> for child nodes based on the passed CSS selector (the selector should not contain an id).</div>\r
- <div class="long">\r
- Creates a <a ext:cls="Ext.CompositeElement" href="output/Ext.CompositeElement.html">Ext.CompositeElement</a> for child nodes based on the passed CSS selector (the selector should not contain an id). <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>selector</code> : String<div class="sub-desc">The CSS selector</div></li><li><code>unique</code> : Boolean<div class="sub-desc">(optional) True to create a unique Ext.Element for each child (defaults to false, which creates a single shared flyweight object)</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>CompositeElement/CompositeElementLite</code><div class="sub-desc">The composite element</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-set"></a>\r
- <b>set</b>( <code>Object o</code>, <span class="optional" title="Optional">[<code>Boolean useSet</code>]</span> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Sets the passed attributes as attributes of this element (a style attribute can be a string, object or function)</div>\r
- <div class="long">\r
- Sets the passed attributes as attributes of this element (a style attribute can be a string, object or function) <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>o</code> : Object<div class="sub-desc">The object with the attributes</div></li><li><code>useSet</code> : Boolean<div class="sub-desc">(optional) false to override the default setAttribute to use expandos.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-setBottom"></a>\r
- <b>setBottom</b>( <code>String bottom</code> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Sets the element's CSS bottom style.</div>\r
- <div class="long">\r
- Sets the element's CSS bottom style. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>bottom</code> : String<div class="sub-desc">The bottom CSS property value</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-setBounds"></a>\r
- <b>setBounds</b>( <code>Number x</code>, <code>Number y</code>, <code>Number width</code>, <code>Number height</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Sets the element's position and size in one shot. If animation is true then width, height, x and y will be animated c...</div>\r
- <div class="long">\r
- Sets the element's position and size in one shot. If animation is true then width, height, x and y will be animated concurrently. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>x</code> : Number<div class="sub-desc">X value for new position (coordinates are page-based)</div></li><li><code>y</code> : Number<div class="sub-desc">Y value for new position (coordinates are page-based)</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><li><code>animate</code> : Boolean/Object<div class="sub-desc">(optional) true for the default animation or a standard Element animation config object</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-setBox"></a>\r
- <b>setBox</b>( <code>Object box</code>, <span class="optional" title="Optional">[<code>Boolean adjust</code>]</span>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Sets the element's box. Use getBox() on another element to get a box obj. If animate is true then width, height, x an...</div>\r
- <div class="long">\r
- Sets the element's box. Use getBox() on another element to get a box obj. If animate is true then width, height, x and y will be animated concurrently. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>box</code> : Object<div class="sub-desc">The box to fill {x, y, width, height}</div></li><li><code>adjust</code> : Boolean<div class="sub-desc">(optional) Whether to adjust for box-model issues automatically</div></li><li><code>animate</code> : Boolean/Object<div class="sub-desc">(optional) true for the default animation or a standard Element animation config object</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-setDisplayed"></a>\r
- <b>setDisplayed</b>( <code>Mixed value</code> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Sets the CSS display property. Uses originalDisplay if the specified value is a boolean true.</div>\r
- <div class="long">\r
- Sets the CSS display property. Uses originalDisplay if the specified value is a boolean true. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>value</code> : Mixed<div class="sub-desc">Boolean value to display the element using its default display, or a string to set the display directly.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-setHeight"></a>\r
- <b>setHeight</b>( <code>Number height</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Set the height of the element</div>\r
- <div class="long">\r
- Set the height of the element <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>height</code> : Number<div class="sub-desc">The new height</div></li><li><code>animate</code> : Boolean/Object<div class="sub-desc">(optional) true for the default animation or a standard Element animation config object</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-setLeft"></a>\r
- <b>setLeft</b>( <code>String left</code> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Sets the element's left position directly using CSS style (instead of <a ext:cls="Ext.Element" ext:member="setX" href="output/Ext.Element.html#setX">setX</a>).</div>\r
- <div class="long">\r
- Sets the element's left position directly using CSS style (instead of <a ext:cls="Ext.Element" ext:member="setX" href="output/Ext.Element.html#setX">setX</a>). <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>left</code> : String<div class="sub-desc">The left CSS property value</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-setLeftTop"></a>\r
- <b>setLeftTop</b>( <code>String left</code>, <code>String top</code> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Quick set left and top adding default units</div>\r
- <div class="long">\r
- Quick set left and top adding default units <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>left</code> : String<div class="sub-desc">The left CSS property value</div></li><li><code>top</code> : String<div class="sub-desc">The top CSS property value</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-setLocation"></a>\r
- <b>setLocation</b>( <code>Number x</code>, <code>Number y</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Sets the position of the element in page coordinates, regardless of how the element is positioned.
-The element must b...</div>\r
- <div class="long">\r
- Sets the position of the element in page coordinates, regardless of how the element is positioned.
-The element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false). <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>x</code> : Number<div class="sub-desc">X value for new position (coordinates are page-based)</div></li><li><code>y</code> : Number<div class="sub-desc">Y value for new position (coordinates are page-based)</div></li><li><code>animate</code> : Boolean/Object<div class="sub-desc">(optional) True for the default animation, or a standard Element animation config object</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-setOpacity"></a>\r
- <b>setOpacity</b>( <code>Float opacity</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Set the opacity of the element</div>\r
- <div class="long">\r
- Set the opacity of the element <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>opacity</code> : Float<div class="sub-desc">The new opacity. 0 = transparent, .5 = 50% visibile, 1 = fully visible, etc</div></li><li><code>animate</code> : Boolean/Object<div class="sub-desc">(optional) true for the default animation or a standard Element animation config object</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-setPositioning"></a>\r
- <b>setPositioning</b>( <code>Object posCfg</code> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Set positioning with an object returned by getPositioning().</div>\r
- <div class="long">\r
- Set positioning with an object returned by getPositioning(). <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>posCfg</code> : Object<div class="sub-desc"></div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-setRegion"></a>\r
- <b>setRegion</b>( <code>Ext.lib.Region region</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Sets the element's position and size the specified region. If animation is true then width, height, x and y will be a...</div>\r
- <div class="long">\r
- Sets the element's position and size the specified region. If animation is true then width, height, x and y will be animated concurrently. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>region</code> : Ext.lib.Region<div class="sub-desc">The region to fill</div></li><li><code>animate</code> : Boolean/Object<div class="sub-desc">(optional) true for the default animation or a standard Element animation config object</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-setRight"></a>\r
- <b>setRight</b>( <code>String right</code> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Sets the element's CSS right style.</div>\r
- <div class="long">\r
- Sets the element's CSS right style. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>right</code> : String<div class="sub-desc">The right CSS property value</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-setSize"></a>\r
- <b>setSize</b>( <code>Number width</code>, <code>Number height</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Set the size of the element. If animation is true, both width an height will be animated concurrently.</div>\r
- <div class="long">\r
- Set the size of the element. If animation is true, both width an height will be animated concurrently. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><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><li><code>animate</code> : Boolean/Object<div class="sub-desc">(optional) true for the default animation or a standard Element animation config object</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-setStyle"></a>\r
- <b>setStyle</b>( <code>String/Object property</code>, <span class="optional" title="Optional">[<code>String value</code>]</span> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Wrapper for setting style properties, also takes single object parameter of multiple styles.</div>\r
- <div class="long">\r
- Wrapper for setting style properties, also takes single object parameter of multiple styles. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>property</code> : String/Object<div class="sub-desc">The style property to be set, or an object of multiple styles.</div></li><li><code>value</code> : String<div class="sub-desc">(optional) The value to apply to the given property, or null if an object was passed.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-setTop"></a>\r
- <b>setTop</b>( <code>String top</code> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Sets the element's top position directly using CSS style (instead of <a ext:cls="Ext.Element" ext:member="setY" href="output/Ext.Element.html#setY">setY</a>).</div>\r
- <div class="long">\r
- Sets the element's top position directly using CSS style (instead of <a ext:cls="Ext.Element" ext:member="setY" href="output/Ext.Element.html#setY">setY</a>). <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>top</code> : String<div class="sub-desc">The top CSS property value</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-setVisibilityMode"></a>\r
- <b>setVisibilityMode</b>( <code>visMode Element.VISIBILITY</code> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Sets the element's visibility mode. When setVisible() is called it
-will use this to determine whether to set the visi...</div>\r
- <div class="long">\r
- Sets the element's visibility mode. When setVisible() is called it
-will use this to determine whether to set the visibility or the display property. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>Element.VISIBILITY</code> : visMode<div class="sub-desc">or Element.DISPLAY</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-setVisible"></a>\r
- <b>setVisible</b>( <code>Boolean visible</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Sets the visibility of the element (see details). If the visibilityMode is set to Element.DISPLAY, it will use
-the di...</div>\r
- <div class="long">\r
- Sets the visibility of the element (see details). If the visibilityMode is set to Element.DISPLAY, it will use
-the display property to hide the element, otherwise it uses visibility. The default is to hide and show using the visibility property. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>visible</code> : Boolean<div class="sub-desc">Whether the element is visible</div></li><li><code>animate</code> : Boolean/Object<div class="sub-desc">(optional) True for the default animation, or a standard Element animation config object</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-setWidth"></a>\r
- <b>setWidth</b>( <code>Number width</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Set the width of the element</div>\r
- <div class="long">\r
- Set the width of the element <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>width</code> : Number<div class="sub-desc">The new width</div></li><li><code>animate</code> : Boolean/Object<div class="sub-desc">(optional) true for the default animation or a standard Element animation config object</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-setX"></a>\r
- <b>setX</b>( <code>Number The</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Sets the X position of the element based on page coordinates. Element must be part of the DOM tree to have page coor...</div>\r
- <div class="long">\r
- Sets the X position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false). <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>The</code> : Number<div class="sub-desc">X position of the element</div></li><li><code>animate</code> : Boolean/Object<div class="sub-desc">(optional) True for the default animation, or a standard Element animation config object</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-setXY"></a>\r
- <b>setXY</b>( <code>Array pos</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Sets the position of the element in page coordinates, regardless of how the element is positioned.
-The element must b...</div>\r
- <div class="long">\r
- Sets the position of the element in page coordinates, regardless of how the element is positioned.
-The element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false). <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>pos</code> : Array<div class="sub-desc">Contains X & Y [x, y] values for new position (coordinates are page-based)</div></li><li><code>animate</code> : Boolean/Object<div class="sub-desc">(optional) True for the default animation, or a standard Element animation config object</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-setY"></a>\r
- <b>setY</b>( <code>Number The</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Sets the Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coor...</div>\r
- <div class="long">\r
- Sets the Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false). <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>The</code> : Number<div class="sub-desc">Y position of the element</div></li><li><code>animate</code> : Boolean/Object<div class="sub-desc">(optional) True for the default animation, or a standard Element animation config object</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-show"></a>\r
- <b>show</b>( <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Show this element - Uses display mode to determine whether to use "display" or "visibility". See <a ext:cls="Ext.Element" ext:member="setVisible" href="output/Ext.Element.html#setVisible">setVisible</a>.</div>\r
- <div class="long">\r
- Show this element - Uses display mode to determine whether to use "display" or "visibility". See <a ext:cls="Ext.Element" ext:member="setVisible" href="output/Ext.Element.html#setVisible">setVisible</a>. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>animate</code> : Boolean/Object<div class="sub-desc">(optional) true for the default animation or a standard Element animation config object</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-swallowEvent"></a>\r
- <b>swallowEvent</b>( <code>String/Array eventName</code>, <span class="optional" title="Optional">[<code>Boolean preventDefault</code>]</span> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Stops the specified event(s) from bubbling and optionally prevents the default action</div>\r
- <div class="long">\r
- Stops the specified event(s) from bubbling and optionally prevents the default action <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>eventName</code> : String/Array<div class="sub-desc">an event / array of events to stop from bubbling</div></li><li><code>preventDefault</code> : Boolean<div class="sub-desc">(optional) true to prevent the default action too</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-toggle"></a>\r
- <b>toggle</b>( <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Toggles the element's visibility or display, depending on visibility mode.</div>\r
- <div class="long">\r
- Toggles the element's visibility or display, depending on visibility mode. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>animate</code> : Boolean/Object<div class="sub-desc">(optional) True for the default animation, or a standard Element animation config object</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-toggleClass"></a>\r
- <b>toggleClass</b>( <code>String className</code> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Toggles the specified CSS class on this element (removes it if it already exists, otherwise adds it).</div>\r
- <div class="long">\r
- Toggles the specified CSS class on this element (removes it if it already exists, otherwise adds it). <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>className</code> : String<div class="sub-desc">The CSS class to toggle</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-translatePoints"></a>\r
- <b>translatePoints</b>( <code>Number/Array x</code>, <span class="optional" title="Optional">[<code>Number y</code>]</span> ) : Object <div class="mdesc">\r
- <div class="short">Translates the passed page coordinates into left/top css values for this element</div>\r
- <div class="long">\r
- Translates the passed page coordinates into left/top css values for this element <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>x</code> : Number/Array<div class="sub-desc">The page x or an array containing [x, y]</div></li><li><code>y</code> : Number<div class="sub-desc">(optional) The page y, required if x is not an array</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Object</code><div class="sub-desc">An object with left and top properties. e.g. {left: (value), top: (value)}</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-un"></a>\r
- <b>un</b>( <code>String eventName</code>, <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Removes an event handler from this element (shorthand for <a ext:cls="Ext.Element" ext:member="removeListener" href="output/Ext.Element.html#removeListener">removeListener</a>).</div>\r
- <div class="long">\r
- Removes an event handler from this element (shorthand for <a ext:cls="Ext.Element" ext:member="removeListener" href="output/Ext.Element.html#removeListener">removeListener</a>). <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>eventName</code> : String<div class="sub-desc">the type of event to remove</div></li><li><code>fn</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 (The <tt>this</tt> reference) of the handler function. Defaults
-to this Element.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-unclip"></a>\r
- <b>unclip</b>() : Ext.Element <div class="mdesc">\r
- <div class="short">Return clipping (overflow) to original clipping before clip() was called</div>\r
- <div class="long">\r
- Return clipping (overflow) to original clipping before clip() was called <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-unmask"></a>\r
- <b>unmask</b>() : void <div class="mdesc">\r
- <div class="short">Removes a previously applied mask.</div>\r
- <div class="long">\r
- Removes a previously applied mask. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-unselectable"></a>\r
- <b>unselectable</b>() : Ext.Element <div class="mdesc">\r
- <div class="short">Disables text selection for this element (normalized across browsers)</div>\r
- <div class="long">\r
- Disables text selection for this element (normalized across browsers) <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-up"></a>\r
- <b>up</b>( <code>String selector</code>, <span class="optional" title="Optional">[<code>Number/Mixed maxDepth</code>]</span> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Walks up the dom looking for a parent node that matches the passed simple selector (e.g. div.some-class or span:first...</div>\r
- <div class="long">\r
- Walks up the dom looking for a parent node that matches the passed simple selector (e.g. div.some-class or span:first-child).
-This is a shortcut for findParentNode() that always returns an Ext.Element. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>selector</code> : String<div class="sub-desc">The simple selector to test</div></li><li><code>maxDepth</code> : Number/Mixed<div class="sub-desc">(optional) The max depth to\r
- search as a number or element (defaults to 10 || document.body)</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">The matching DOM node (or null if no match was found)</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-update"></a>\r
- <b>update</b>( <code>String html</code>, <span class="optional" title="Optional">[<code>Boolean loadScripts</code>]</span>, <span class="optional" title="Optional">[<code>Function callback</code>]</span> ) : Ext.Element <div class="mdesc">\r
- <div class="short">Update the innerHTML of this element, optionally searching for and processing scripts</div>\r
- <div class="long">\r
- Update the innerHTML of this element, optionally searching for and processing scripts <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>html</code> : String<div class="sub-desc">The new HTML</div></li><li><code>loadScripts</code> : Boolean<div class="sub-desc">(optional) True to look for and process scripts (defaults to false)</div></li><li><code>callback</code> : Function<div class="sub-desc">(optional) For async script loading you can be notified when the update completes</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Element-wrap"></a>\r
- <b>wrap</b>( <span class="optional" title="Optional">[<code>Object config</code>]</span>, <span class="optional" title="Optional">[<code>Boolean returnDom</code>]</span> ) : HTMLElement/Element <div class="mdesc">\r
- <div class="short">Creates and wraps this element with another element</div>\r
- <div class="long">\r
- Creates and wraps this element with another element <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>config</code> : Object<div class="sub-desc">(optional) DomHelper element config object for the wrapper element or null for an empty div</div></li><li><code>returnDom</code> : Boolean<div class="sub-desc">(optional) True to return the raw DOM element instead of Ext.Element</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>HTMLElement/Element</code><div class="sub-desc">The newly created wrapper element</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Element</td>\r
- </tr>\r
- </table>
- <a id="Ext.Element-events"></a>
- <h2>Public Events</h2>
- <div class="no-members">This class has no public events.</div>
- </div>
\ No newline at end of file