3603 lines
No EOL
210 KiB
HTML
3603 lines
No EOL
210 KiB
HTML
<!doctype html public "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
<html>
|
|
<head>
|
|
<title>Ext.Element</title>
|
|
<link rel="stylesheet" type="text/css" href="../resources/reset.css"/>
|
|
<link rel="stylesheet" type="text/css" href="../resources/style.css" media="screen"/>
|
|
<link rel="stylesheet" type="text/css" href="../resources/print.css" media="print">
|
|
<!-- GC -->
|
|
</head>
|
|
<body>
|
|
<div class="body-wrap">
|
|
<div class="top-tools">
|
|
<img src="../resources/print.gif" width="16" height="16" align="absmiddle"> <a href="Ext.Element.html" target="_blank">Print Friendly</a><br/>
|
|
|
|
</div>
|
|
<h1>Class Ext.Element</h1>
|
|
<table cellspacing="0">
|
|
<tr><td class="label">Package:</td><td>Ext</td></tr>
|
|
<tr><td class="label">Class:</td><td>Element</td></tr>
|
|
<tr><td class="label">Extends:</td><td>Object</td></tr>
|
|
<tr><td class="label">Subclasses:</td><td><a href="Ext.Layer.html">Layer</a></td></tr>
|
|
<tr><td class="label">Defined In:</td><td><a href="Element.jss.html">Element.js</a></td></tr>
|
|
</table>
|
|
<div class="description">
|
|
Represents an Element in the DOM.<br><br>
|
|
Usage:<br>
|
|
<pre class="highlighted"><code>var el = Ext.get("my-div");
|
|
|
|
<i>// or <b>with</b> getEl</i>
|
|
<b>var</b> el = getEl("my-div");
|
|
|
|
<i>// or <b>with</b> a DOM element</i>
|
|
<b>var</b> el = Ext.get(myDivElement);</code></pre>
|
|
Using Ext.get() or getEl() instead of calling the constructor directly ensures you get the same object
|
|
each call instead of constructing a new one.<br><br>
|
|
<b>Animations</b><br />
|
|
Many of the functions for manipulating an element have an optional "animate" parameter. The animate parameter
|
|
should either be a boolean (true) or an object literal with animation options. The animation options are:
|
|
<pre>
|
|
Option Default Description
|
|
--------- -------- ---------------------------------------------
|
|
duration .35 The duration of the animation in seconds
|
|
easing easeOut The YUI easing method
|
|
callback none A function to execute when the anim completes
|
|
scope this The scope (this) of the callback function
|
|
</pre>
|
|
Also, the Anim object being used for the animation will be set on your options object as "anim", which allows you to stop or
|
|
manipulate the animation. Here's an example:
|
|
<pre><code>
|
|
var el = Ext.get("my-div");
|
|
|
|
// no animation
|
|
el.setWidth(100);
|
|
|
|
// default animation
|
|
el.setWidth(100, true);
|
|
|
|
// animation with some options set
|
|
el.setWidth(100, {
|
|
duration: 1,
|
|
callback: this.foo,
|
|
scope: this
|
|
});
|
|
|
|
// using the "anim" property to get the Anim object
|
|
var opt = {
|
|
duration: 1,
|
|
callback: this.foo,
|
|
scope: this
|
|
};
|
|
el.setWidth(100, opt);
|
|
...
|
|
if(opt.anim.isAnimated()){
|
|
opt.anim.stop();
|
|
}
|
|
</code></pre>
|
|
<b> Composite (Collections of) Elements</b><br />
|
|
For working with collections of Elements, see <a href="Ext.CompositeElement.html">Ext.CompositeElement</a> </div>
|
|
<br />
|
|
<a href="#properties">Properties</a>
|
|
- <a href="#methods">Methods</a>
|
|
- <a href="#events">Events</a>
|
|
<hr />
|
|
<a name="properties"></a>
|
|
<h2>Public Properties</h2>
|
|
<table cellspacing="0" class="member-table">
|
|
<tr>
|
|
<th class="sig-header" colspan="2">Property</th>
|
|
<th class="msource-header">Defined By</th>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#Element.DISPLAY">Element.DISPLAY</a> : Number</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc"><static> Visibility mode constant - Use display to hide element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#Element.VISIBILITY">Element.VISIBILITY</a> : Number</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc"><static> Visibility mode constant - Use visibility to hide element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#defaultUnit">defaultUnit</a> : String</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">The default unit to append to CSS values where a unit isn't provided (Defaults to px).</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#dom">dom</a> : HTMLElement</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">The DOM element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#id">id</a> : String</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">The DOM element ID</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#originalDisplay">originalDisplay</a> : String</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">The element's default display mode</td>
|
|
</tr>
|
|
</table>
|
|
<a name="methods"></a>
|
|
<h2>Public Methods</h2>
|
|
<table cellspacing="0" class="member-table">
|
|
<tr>
|
|
<th class="sig-header" colspan="2">Method</th>
|
|
<th class="msource-header">Defined By</th>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#Element">Element</a>(<code>String/HTMLElement element</code>, <span class="optional" title="Optional">[<code>Boolean forceNew</code>]</span>)</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Create a new Element directly.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#Element.fly">Element.fly</a>(<code>String/HTMLElement el</code>, <span class="optional" title="Optional">[<code>String named</code>]</span>) : Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc"><static> Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a...</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#Element.get">Element.get</a>(<code>String/HTMLElement/Element el</code>) : Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc"><static> Static method to retrieve Element objects. Uses simple caching to consistently return the same object....</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#addClass">addClass</a>(<code>String/Array className</code>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Add a CSS class to the element.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#addClassOnClick">addClassOnClick</a>(<code>String className</code>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Sets up event handlers to add and remove a css class when the mouse is down and then up on this element (a click effect)</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#addClassOnFocus">addClassOnFocus</a>(<code>String className</code>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Sets up event handlers to add and remove a css class when this element has the focus</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#addClassOnOver">addClassOnOver</a>(<code>String className</code>, <span class="optional" title="Optional">[<code>Boolean preventFlicker</code>]</span>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Sets up event handlers to add and remove a css class when the mouse is over this element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#addKeyListener">addKeyListener</a>(<code>Number/Array/Object/String key</code>, <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>) : Ext.KeyMap</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Convenience method for constructing a KeyMap</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#addKeyMap">addKeyMap</a>(<code>Object config</code>) : Ext.KeyMap</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Creates a KeyMap for this element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#addListener">addListener</a>(<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</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Appends an event handler</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#alignTo">alignTo</a>(<code>String/HTMLElement/Ext.Element element</code>, <code>String position</code>, <span class="optional" title="Optional">[<code>Array offsets</code>]</span>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Aligns this element with another element relative to the specified anchor points. If the other element is the
|
|
documen...</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#anchorTo">anchorTo</a>(<code>String/HTMLElement/Ext.Element element</code>, <code>String position</code>, <span class="optional" title="Optional">[<code>Array offsets</code>]</span>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span>, <span class="optional" title="Optional">[<code>Boolean/Number monitorScroll</code>]</span>, <code> </code>) : void</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Anchors an element to another element and realigns it when the window is resized.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#animate">animate</a>(<code>Object args</code>, <span class="optional" title="Optional">[<code>Float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>String easing</code>]</span>, <span class="optional" title="Optional">[<code>String animType</code>]</span>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Perform animation on this element.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#appendChild">appendChild</a>(<code>String/HTMLElement/Array/Element/CompositeElement el</code>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Appends the passed element(s) to this element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#appendTo">appendTo</a>(<code>String/HTMLElement/Element el</code>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Appends this element to the passed element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#applyStyles">applyStyles</a>(<code>String/Object/Function styles</code>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">More flexible version of <a href="#setStyle">setStyle</a> for setting style properties.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#autoHeight">autoHeight</a>(<span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>Float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>String easing</code>]</span>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Measures the elements content height and updates height to match. Note, this function uses setTimeout and
|
|
the new he...</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#beginMeasure">beginMeasure</a>() : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Temporarily enables offsets (width,height,x,y) for an element with display:none, use endMeasure() when done.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#blur">blur</a>() : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Tries to blur the element. Any exceptions are caught.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#center">center</a>(<span class="optional" title="Optional">[<code>String/HTMLElement/Ext.Element centerIn</code>]</span>) : void</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Centers the Element in either the viewport, or another Element.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#child">child</a>(<code>String selector</code>, <code>Boolean returnDom</code>) : Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Selects a single child based on the passed CSS selector (the selector should not contain an id)</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#clean">clean</a>(<span class="optional" title="Optional">[<code>Boolean forceReclean</code>]</span>) : void</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Removes worthless text nodes</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#clearOpacity">clearOpacity</a>() : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Clears any opacity settings from this element. Required in some cases for IE.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#clearPositioning">clearPositioning</a>(<span class="optional" title="Optional">[<code>String value</code>]</span>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Clear positioning back to the default when the document was loaded</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#clip">clip</a>() : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Store the current overflow setting and clip overflow on the element - use <a href="#unclip">unclip</a> to remove</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#contains">contains</a>(<code>HTMLElement/String el</code>) : Boolean</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Returns true if this element is an ancestor of the passed element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#createChild">createChild</a>(<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</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child e...</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#createProxy">createProxy</a>(<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</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Creates a proxy element of this element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#createShim">createShim</a>() : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Creates an iframe shim for this element to keep selects and other windowed objects from
|
|
showing through.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#down">down</a>(<code>String selector</code>, <code>Boolean returnDom</code>) : Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Selects a single *direct* child based on the passed CSS selector (the selector should not contain an id)</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#enableDisplayMode">enableDisplayMode</a>(<span class="optional" title="Optional">[<code>String display</code>]</span>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Convenience method for setVisibilityMode(Element.DISPLAY)</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#endMeasure">endMeasure</a>() : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Restores displays to before beginMeasure was called</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#findParent">findParent</a>(<code>String ss</code>, <span class="optional" title="Optional">[<code>Number/String/HTMLElement/Element maxDepth</code>]</span>, <span class="optional" title="Optional">[<code>Boolean returnEl</code>]</span>) : HTMLElement</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">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...</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#findParentNode">findParentNode</a>(<code>String ss</code>, <span class="optional" title="Optional">[<code>Number/String/HTMLElement/Element maxDepth</code>]</span>, <span class="optional" title="Optional">[<code>Boolean returnEl</code>]</span>) : HTMLElement</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Looks at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child)</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#fitToParent">fitToParent</a>(<span class="optional" title="Optional">[<code>Boolean monitorResize</code>]</span>, <span class="optional" title="Optional">[<code>String/HTMLElment/Element targetParent</code>]</span>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Sizes this element to its parent element's dimensions performing
|
|
neccessary box adjustments.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#focus">focus</a>() : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Tries to focus the element. Any exceptions are caught.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getAlignToXY">getAlignToXY</a>(<code>String/HTMLElement/Ext.Element element</code>, <code>String position</code>, <span class="optional" title="Optional">[<code>Array offsets</code>]</span>) : Array</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Gets the x,y coordinates to align this element with another element. See alignTo for more info on the
|
|
supported posit...</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getAnchorXY">getAnchorXY</a>(<span class="optional" title="Optional">[<code>String anchor</code>]</span>, <span class="optional" title="Optional">[<code>Object size</code>]</span>, <span class="optional" title="Optional">[<code>Boolean local</code>]</span>) : Array</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Gets the x,y coordinates specified by the anchor position on the element.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getBorderWidth">getBorderWidth</a>(<code>String side</code>) : Number</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Gets the width of the border(s) for the specified side(s)</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getBottom">getBottom</a>(<code>Boolean local</code>) : Number</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Gets the bottom Y coordinate of the element (element Y position + element height)</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getBox">getBox</a>(<span class="optional" title="Optional">[<code>Boolean contentBox</code>]</span>, <span class="optional" title="Optional">[<code>Boolean local</code>]</span>) : Object</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Return a box {x, y, width, height} that can be used to set another elements
|
|
size/location to match this element.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getCenterXY">getCenterXY</a>() : Array</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Calculates the x, y to center this element on the screen</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getColor">getColor</a>(<code>String attr</code>, <code>String defaultValue</code>, <span class="optional" title="Optional">[<code>String prefix</code>]</span>) : void</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Return the CSS color for the specified CSS attribute. rgb, 3 digit (like #fff) and valid values
|
|
are convert to standa...</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getComputedHeight">getComputedHeight</a>() : Number</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Returns either the offsetHeight or the height of this element based on CSS height adjusted by padding or borders
|
|
when...</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getComputedWidth">getComputedWidth</a>() : Number</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Returns either the offsetWidth or the width of this element based on CSS width adjusted by padding or borders
|
|
when ne...</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getFrameWidth">getFrameWidth</a>(<code>String sides</code>) : Number</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Returns the sum width of the padding and borders for the passed "sides". See getBorderWidth()
|
|
for more informat...</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getHeight">getHeight</a>(<span class="optional" title="Optional">[<code>Boolean contentHeight</code>]</span>) : Number</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Returns the offset height of the element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getLeft">getLeft</a>(<code>Boolean local</code>) : Number</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Gets the left X coordinate</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getMargins">getMargins</a>(<span class="optional" title="Optional">[<code>String sides</code>]</span>) : Object/Number</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Returns an object with properties top, left, right and bottom representing the margins of this element unless sides i...</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getNextSibling">getNextSibling</a>() : HTMLElement</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Gets the next sibling, skipping text nodes</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getPadding">getPadding</a>(<code>String side</code>) : Number</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Gets the width of the padding(s) for the specified side(s)</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getPositioning">getPositioning</a>() : Object</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Gets an object with all CSS positioning properties. Useful along with setPostioning to get
|
|
snapshot before performing...</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getPrevSibling">getPrevSibling</a>() : HTMLElement</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Gets the previous sibling, skipping text nodes</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getRegion">getRegion</a>() : Region</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Returns the region of the given element.
|
|
The element must be part of the DOM tree to have a region (display:none or e...</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getRight">getRight</a>(<code>Boolean local</code>) : Number</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Gets the right X coordinate of the element (element X position + element width)</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getSize">getSize</a>(<span class="optional" title="Optional">[<code>Boolean contentSize</code>]</span>) : Object</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Returns the size of the element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getStyle">getStyle</a>(<code>String property</code>) : String</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Normalizes currentStyle and computedStyle. This is not YUI getStyle, it is an optimised version.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getStyles">getStyles</a>(<code>String style1</code>, <code>String style2</code>, <code>String etc</code>) : Object</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Get an object with properties matching the styles requested.
|
|
e.g. el.getStyles('color', 'font-size', 'width') might r...</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getTop">getTop</a>(<code>Boolean local</code>) : Number</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Gets the top Y coordinate</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getUpdateManager">getUpdateManager</a>() : Ext.UpdateManager</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Gets this elements UpdateManager</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getValue">getValue</a>(<code>Boolean asNumber</code>) : String/Number</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Returns the value of the "value" attribute</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getWidth">getWidth</a>(<span class="optional" title="Optional">[<code>Boolean contentWidth</code>]</span>) : Number</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Returns the offset width of the element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getX">getX</a>() : Number</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Gets the current X position of the element based on page coordinates. Element must be part of the DOM tree to have p...</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getXY">getXY</a>() : Array</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Gets the current position of the element based on page coordinates. Element must be part of the DOM tree to have pag...</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getY">getY</a>() : Number</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Gets the current Y position of the element based on page coordinates. Element must be part of the DOM tree to have p...</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#hasClass">hasClass</a>(<code>String className</code>) : Boolean</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Checks if a CSS class is in use by the element.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#hide">hide</a>(<span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Hide this element - Uses display mode to determine whether to use "display" or "visibility". See <a href="#setVisible">setVisible</a>.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#initDD">initDD</a>(<code>String group</code>, <code>Object config</code>, <code>Object overrides</code>) : Ext.dd.DD</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Initializes a Ext.dd.DD object for this element.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#initDDProxy">initDDProxy</a>(<code>String group</code>, <code>Object config</code>, <code>Object overrides</code>) : Ext.dd.DDProxy</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Initializes a Ext.dd.DDProxy object for this element.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#initDDTarget">initDDTarget</a>(<code>String group</code>, <code>Object config</code>, <code>Object overrides</code>) : Ext.dd.DDTarget</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Initializes a Ext.dd.DDTarget object for this element.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#insertAfter">insertAfter</a>(<code>String/HTMLElement/Element el</code>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Inserts this element after the passed element in the DOM</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#insertBefore">insertBefore</a>(<code>String/HTMLElement/Element el</code>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Inserts this element before the passed element in the DOM</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#insertFirst">insertFirst</a>(<code>String/HTMLElement/Element/Object el</code>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Inserts (or creates) an element (or DomHelper config) as the first child of the this element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#insertHtml">insertHtml</a>(<code>String where</code>, <code>String html</code>) : HTMLElement</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Inserts an html fragment into this element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#insertSibling">insertSibling</a>(<code>String/HTMLElement/Element/Object el</code>, <span class="optional" title="Optional">[<code>String where</code>]</span>, <span class="optional" title="Optional">[<code>Boolean returnDom</code>]</span>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Inserts (or creates) the passed element (or DomHelper config) as a sibling of this element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#is">is</a>(<code>String ss</code>) : Boolean</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Returns true if this element matches the passed simple selector (e.g. div.some-class or span:first-child)</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#isBorderBox">isBorderBox</a>() : Boolean</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Tests various css rules/browsers to determine if this element uses a border box</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#isDisplayed">isDisplayed</a>() : Boolean</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Returns true if display is not "none"</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#isMasked">isMasked</a>() : Boolean</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Returns true if this element is masked</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#isScrollable">isScrollable</a>() : Boolean</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Returns true if this element is scrollable.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#isVisible">isVisible</a>(<code>Boolean deep</code>) : Boolean</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Checks whether the element is currently visible using both visibility and display properties.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#load">load</a>(<code>String/Function url</code>, <span class="optional" title="Optional">[<code>String/Object params</code>]</span>, <span class="optional" title="Optional">[<code>Function callback</code>]</span>, <span class="optional" title="Optional">[<code>Boolean discardUrl</code>]</span>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Direct access to the UpdateManager update() method (takes the same parameters).</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#mask">mask</a>(<span class="optional" title="Optional">[<code>String msg</code>]</span>, <span class="optional" title="Optional">[<code>String msgCls</code>]</span>) : Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Puts a mask over this element to disable user interaction. Requires core.css.
|
|
This method can only be applied to elem...</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#move">move</a>(<code>String direction</code>, <code>Number distance</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Move this element relative to its current position.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#moveTo">moveTo</a>(<code>Number x</code>, <code>Number y</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Set the position of the element in page coordinates, regardless of how the element is positioned.
|
|
The element must be...</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#position">position</a>(<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</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Initializes positioning on this element. If a desired position is not passed, it will make the
|
|
the element positioned...</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#query">query</a>(<code>String selector</code>) : Array</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Selects child nodes based on the passed CSS selector (the selector should not contain an id)</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#radioClass">radioClass</a>(<code>String className</code>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Adds the passed className to this element and removes the class from all siblings</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#remove">remove</a>() : void</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Removes this element from the DOM and deletes it from the cache</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#removeAllListeners">removeAllListeners</a>() : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Removes all previous added listeners from this element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#removeClass">removeClass</a>(<code>String/Array className</code>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Removes a CSS class from the element.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#removeListener">removeListener</a>(<code>String eventName</code>, <code>Function fn</code>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Removes an event handler from this element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#repaint">repaint</a>() : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Forces the browser to repaint this element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#replace">replace</a>(<code>String/HTMLElement/Element el</code>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Replaces the passed element with this element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#replaceClass">replaceClass</a>(<code>String oldClassName</code>, <code>String newClassName</code>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Replaces a CSS class on the element with another.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#scroll">scroll</a>(<code>String direction</code>, <code>Number distance</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span>) : Boolean</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Scrolls this element the specified direction. Does bounds checking to make sure the scroll is
|
|
within this elements s...</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#scrollIntoView">scrollIntoView</a>(<span class="optional" title="Optional">[<code>String/HTMLElement/Element container</code>]</span>, <span class="optional" title="Optional">[<code>Boolean hscroll</code>]</span>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Scrolls this element into view within the passed container.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#scrollTo">scrollTo</a>(<code>String side</code>, <code>Number value</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span>) : Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Scrolls this element the specified scroll point. It does NOT do bounds checking so if you scroll to a weird value it ...</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#select">select</a>(<code>String selector</code>, <code>Boolean unique</code>) : CompositeElement/CompositeElementLite</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Creates a CompositeElement for child nodes based on the passed CSS selector (the selector should not contain an id)</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#set">set</a>(<code>Object o</code>, <span class="optional" title="Optional">[<code>Boolean useSet</code>]</span>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Sets the passed attributes as attributes of this element (a style attribute can be a string, object or function)</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setBottom">setBottom</a>(<code>String bottom</code>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Set the element's css bottom style</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setBounds">setBounds</a>(<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</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Sets the element's position and size in one shot. If animation is true then width, height, x and y will be animated c...</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setBox">setBox</a>(<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</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Sets the element's box. Use getBox() on another element to get a box obj. If animate is true then width, height, x an...</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setDisplayed">setDisplayed</a>(<code>Boolean value</code>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Sets the css display. Uses originalDisplay if value is a boolean true.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setHeight">setHeight</a>(<code>Number height</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Set the height of the element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setLeft">setLeft</a>(<code>String left</code>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Set the element's left position directly using CSS style (instead of setX())</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setLeftTop">setLeftTop</a>() : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Quick set left and top adding default units</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setLocation">setLocation</a>(<code>Number x</code>, <code>Number y</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Set the position of the element in page coordinates, regardless of how the element is positioned.
|
|
The element must be...</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setOpacity">setOpacity</a>(<code>Float opacity</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Set the opacity of the element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setPositioning">setPositioning</a>(<code>Object posCfg</code>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Set positioning with an object returned by getPositioning().</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setRegion">setRegion</a>(<code>Ext.lib.Region region</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Sets the element's position and size the the specified region. If animation is true then width, height, x and y will ...</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setRight">setRight</a>(<code>String right</code>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Set the element's css right style</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setSize">setSize</a>(<code>Number width</code>, <code>Number height</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Set the size of the element. If animation is true, both width an height will be animated concurrently.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setStyle">setStyle</a>(<code>String/Object property</code>, <span class="optional" title="Optional">[<code>String val</code>]</span>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Wrapper for setting style properties, also takes single object parameter of multiple styles</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setTop">setTop</a>(<code>String top</code>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Set the element's top position directly using CSS style (instead of setY())</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setVisibilityMode">setVisibilityMode</a>(<code>visMode Element.VISIBILITY</code>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Sets the elements visibility mode. When setVisible() is called it
|
|
will use this to determine whether to set the visib...</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setVisible">setVisible</a>(<code>Boolean visible</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Sets the visibility of the element (see details). If the visibilityMode is set to Element.DISPLAY, it will use
|
|
the d...</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setWidth">setWidth</a>(<code>Number width</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Set the width of the element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setX">setX</a>(<code>Number The</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Sets the X position of the element based on page coordinates. Element must be part of the DOM tree to have page coor...</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setXY">setXY</a>(<code>Array pos</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Set the position of the element in page coordinates, regardless of how the element is positioned.
|
|
The element must be...</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setY">setY</a>(<code>Number The</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Sets the Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coor...</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#show">show</a>(<span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Show this element - Uses display mode to determine whether to use "display" or "visibility". See <a href="#setVisible">setVisible</a>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#swallowEvent">swallowEvent</a>(<code>String eventName</code>, <span class="optional" title="Optional">[<code>Boolean preventDefault</code>]</span>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Stops the specified event from bubbling and optionally prevents the default action</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#toggle">toggle</a>(<span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Toggles the elements visibility or display, depending on visibility mode.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#toggleClass">toggleClass</a>(<code>String className</code>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Toggles (adds or removes) the passed class.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#translatePoints">translatePoints</a>(<code>Number/Array x</code>, <code>Number y</code>, <code>Object An</code>) : void</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Translates the passed page coordinates into left/top css values for this element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#unclip">unclip</a>() : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Return clipping (overflow) to original clipping before clip() was called</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#unmask">unmask</a>() : void</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Removes a previously applied mask. If removeEl is true the mask overlay is destroyed, otherwise
|
|
it is cached for reuse.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#unselectable">unselectable</a>() : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Disables text selection for this element (normalized across browsers)</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#up">up</a>(<code>String ss</code>, <span class="optional" title="Optional">[<code>Number/String/HTMLElement/Element maxDepth</code>]</span>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Walks up the dom looking for a parent node that matches the passed simple selector (e.g. div.some-class or span:first...</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#update">update</a>(<code>String html</code>, <span class="optional" title="Optional">[<code>Boolean loadScripts</code>]</span>, <code>Function callback</code>) : Ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Update the innerHTML of this element, optionally searching for and processing scripts</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#wrap">wrap</a>(<span class="optional" title="Optional">[<code>Object config</code>]</span>, <span class="optional" title="Optional">[<code>Boolean returnDom</code>]</span>) : /HTMLElementElement</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Creates and wraps this element with another element</td>
|
|
</tr>
|
|
</table>
|
|
<a name="events"></a>
|
|
<h2>Public Events</h2>
|
|
<div class="no-members">This class has no public events.</div> <h2 class="mdetail-head">Property Details</h2>
|
|
<div class="detail-wrap">
|
|
<a name="Element.DISPLAY"></a>
|
|
<div class="mdetail">
|
|
<h3>Element.DISPLAY</i></h3>
|
|
<code>public Number Element.DISPLAY</code>
|
|
<div class="mdetail-desc">
|
|
<static> Visibility mode constant - Use display to hide element </div>
|
|
<div class="mdetail-def">This property is defined by Element.</div>
|
|
</div>
|
|
<a name="Element.VISIBILITY"></a>
|
|
<div class="mdetail alt">
|
|
<h3>Element.VISIBILITY</i></h3>
|
|
<code>public Number Element.VISIBILITY</code>
|
|
<div class="mdetail-desc">
|
|
<static> Visibility mode constant - Use visibility to hide element </div>
|
|
<div class="mdetail-def">This property is defined by Element.</div>
|
|
</div>
|
|
<a name="defaultUnit"></a>
|
|
<div class="mdetail">
|
|
<h3>defaultUnit</i></h3>
|
|
<code>public String defaultUnit</code>
|
|
<div class="mdetail-desc">
|
|
The default unit to append to CSS values where a unit isn't provided (Defaults to px). </div>
|
|
<div class="mdetail-def">This property is defined by Element.</div>
|
|
</div>
|
|
<a name="dom"></a>
|
|
<div class="mdetail alt">
|
|
<h3>dom</i></h3>
|
|
<code>public HTMLElement dom</code>
|
|
<div class="mdetail-desc">
|
|
The DOM element </div>
|
|
<div class="mdetail-def">This property is defined by Element.</div>
|
|
</div>
|
|
<a name="id"></a>
|
|
<div class="mdetail">
|
|
<h3>id</i></h3>
|
|
<code>public String id</code>
|
|
<div class="mdetail-desc">
|
|
The DOM element ID </div>
|
|
<div class="mdetail-def">This property is defined by Element.</div>
|
|
</div>
|
|
<a name="originalDisplay"></a>
|
|
<div class="mdetail alt">
|
|
<h3>originalDisplay</i></h3>
|
|
<code>public String originalDisplay</code>
|
|
<div class="mdetail-desc">
|
|
The element's default display mode </div>
|
|
<div class="mdetail-def">This property is defined by Element.</div>
|
|
</div>
|
|
</div>
|
|
|
|
<a name="Element"></a>
|
|
<h2 class="mdetail-head">Constructor Details</h2>
|
|
<div class="detail-wrap">
|
|
<div class="mdetail">
|
|
<h3>Element</i></h3>
|
|
<code>public function Element(<code>String/HTMLElement element</code>, <span class="optional" title="Optional">[<code>Boolean forceNew</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Create a new Element directly. <div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>element</code> : String/HTMLElement<div class="sub-desc"></div></li><li><code>forceNew</code> : Boolean<div class="sub-desc">(optional) By default the constructor checks to see if there is already an instance of this element in the cache and if there is it returns the same instance. This will skip that check (useful for extending this class).</div></li> </ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<h2 class="mdetail-head">Method Details</h2>
|
|
<div class="detail-wrap">
|
|
<a name="Element.fly"></a>
|
|
<div class="mdetail">
|
|
<h3>Element.fly</i></h3>
|
|
<code>public function Element.fly(<code>String/HTMLElement el</code>, <span class="optional" title="Optional">[<code>String named</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
<static> Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element -
|
|
the dom node can be overwritten by other code.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>el</code> : String/HTMLElement<div class="sub-desc">The dom node or id</div></li><li><code>named</code> : String<div class="sub-desc">(optional) Allows for creation of named reusable flyweights to prevent conflicts (e.g. internally Ext uses "_internal")</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Element</code><div class="sub-desc">The shared Element object</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="Element.get"></a>
|
|
<div class="mdetail alt">
|
|
<h3>Element.get</i></h3>
|
|
<code>public function Element.get(<code>String/HTMLElement/Element el</code>)</code>
|
|
<div class="mdetail-desc">
|
|
<static> Static method to retrieve Element objects. Uses simple caching to consistently return the same object.
|
|
Automatically fixes if an object was recreated with the same id via AJAX or DOM.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>el</code> : String/HTMLElement/Element<div class="sub-desc">The id of the node, a DOM Node or an existing Element.</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Element</code><div class="sub-desc">The Element object</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="addClass"></a>
|
|
<div class="mdetail">
|
|
<h3>addClass</i></h3>
|
|
<code>public function addClass(<code>String/Array className</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Add a CSS class to the element.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>className</code> : String/Array<div class="sub-desc">The CSS class to add or an array of classes</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="addClassOnClick"></a>
|
|
<div class="mdetail alt">
|
|
<h3>addClassOnClick</i></h3>
|
|
<code>public function addClassOnClick(<code>String className</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Sets up event handlers to add and remove a css class when the mouse is down and then up on this element (a click effect)
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>className</code> : String<div class="sub-desc"></div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="addClassOnFocus"></a>
|
|
<div class="mdetail">
|
|
<h3>addClassOnFocus</i></h3>
|
|
<code>public function addClassOnFocus(<code>String className</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Sets up event handlers to add and remove a css class when this element has the focus
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>className</code> : String<div class="sub-desc"></div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="addClassOnOver"></a>
|
|
<div class="mdetail alt">
|
|
<h3>addClassOnOver</i></h3>
|
|
<code>public function addClassOnOver(<code>String className</code>, <span class="optional" title="Optional">[<code>Boolean preventFlicker</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Sets up event handlers to add and remove a css class when the mouse is over this element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>className</code> : String<div class="sub-desc"></div></li><li><code>preventFlicker</code> : Boolean<div class="sub-desc">(optional) If set to true, it prevents flickering by filtering mouseout events for children elements</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="addKeyListener"></a>
|
|
<div class="mdetail">
|
|
<h3>addKeyListener</i></h3>
|
|
<code>public function addKeyListener(<code>Number/Array/Object/String key</code>, <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Convenience method for constructing a KeyMap
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>key</code> : Number/Array/Object/String<div class="sub-desc">Either a string with the keys to listen for, the numeric key code, array of key codes or an object with the following options: {key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)}</div></li><li><code>fn</code> : Function<div class="sub-desc">The function to call</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope of the function</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.KeyMap</code><div class="sub-desc">The KeyMap created</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="addKeyMap"></a>
|
|
<div class="mdetail alt">
|
|
<h3>addKeyMap</i></h3>
|
|
<code>public function addKeyMap(<code>Object config</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Creates a KeyMap for this element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>config</code> : Object<div class="sub-desc">The KeyMap config. See <a href="Ext.KeyMap.html">Ext.KeyMap</a> for more details</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.KeyMap</code><div class="sub-desc">The KeyMap created</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="addListener"></a>
|
|
<div class="mdetail">
|
|
<h3>addListener</i></h3>
|
|
<code>public function addListener(<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>)</code>
|
|
<div class="mdetail-desc">
|
|
Appends an event handler
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to append</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 (this object) of the fn</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)An object with standard EventManager options</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="alignTo"></a>
|
|
<div class="mdetail alt">
|
|
<h3>alignTo</i></h3>
|
|
<code>public function alignTo(<code>String/HTMLElement/Ext.Element element</code>, <code>String position</code>, <span class="optional" title="Optional">[<code>Array offsets</code>]</span>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Aligns this element with another element relative to the specified anchor points. If the other element is the
|
|
document it aligns it to the viewport.
|
|
The position parameter is optional, and can be specified in any one of the following formats:
|
|
<ul>
|
|
<li><b>Blank</b>: Defaults to aligning the element"s top-left corner to the target"s bottom-left corner ("tl-bl").</li>
|
|
<li><b>One anchor (deprecated)</b>: The passed anchor position is used as the target element's anchor point.
|
|
The element being aligned will position its top-left corner (tl) to that point. <i>This method has been
|
|
deprecated in favor of the newer two anchor syntax below</i>.</li>
|
|
<li><b>Two anchors</b>: If two values from the table below are passed separated by a dash, the first value is used as the
|
|
element"s anchor point, and the second value is used as the target"s anchor point.</li>
|
|
</ul>
|
|
In addition to the anchor points, the position parameter also supports the "?" character. If "?" is passed at the end of
|
|
the position string, the element will attempt to align as specified, but the position will be adjusted to constrain to
|
|
the viewport if necessary. Note that the element being aligned might be swapped to align to a different position than
|
|
that specified in order to enforce the viewport constraints.
|
|
Following are all of the supported anchor positions:
|
|
<pre>
|
|
Value Description
|
|
----- -----------------------------
|
|
tl The top left corner (default)
|
|
t The center of the top edge
|
|
tr The top right corner
|
|
l The center of the left edge
|
|
c In the center of the element
|
|
r The center of the right edge
|
|
bl The bottom left corner
|
|
b The center of the bottom edge
|
|
br The bottom right corner
|
|
</pre>
|
|
Example Usage:
|
|
<pre><code>
|
|
// align el to other-el using the default positioning ("tl-bl", non-constrained)
|
|
el.alignTo("other-el");
|
|
|
|
// align the top left corner of el with the top right corner of other-el (constrained to viewport)
|
|
el.alignTo("other-el", "tr?");
|
|
|
|
// align the bottom right corner of el with the center left edge of other-el
|
|
el.alignTo("other-el", "br-l?");
|
|
|
|
// align the center of el with the bottom left corner of other-el and
|
|
// adjust the x position by -6 pixels (and the y position by 0)
|
|
el.alignTo("other-el", "c-bl", [-6, 0]);
|
|
</code></pre>
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>element</code> : String/HTMLElement/Ext.Element<div class="sub-desc">The element to align to.</div></li><li><code>position</code> : String<div class="sub-desc">The position to align to.</div></li><li><code>offsets</code> : Array<div class="sub-desc">(optional) Offset the positioning by [x, y]</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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="anchorTo"></a>
|
|
<div class="mdetail">
|
|
<h3>anchorTo</i></h3>
|
|
<code>public function anchorTo(<code>String/HTMLElement/Ext.Element element</code>, <code>String position</code>, <span class="optional" title="Optional">[<code>Array offsets</code>]</span>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span>, <span class="optional" title="Optional">[<code>Boolean/Number monitorScroll</code>]</span>, <code> </code>)</code>
|
|
<div class="mdetail-desc">
|
|
Anchors an element to another element and realigns it when the window is resized.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>element</code> : String/HTMLElement/Ext.Element<div class="sub-desc">The element to align to.</div></li><li><code>position</code> : String<div class="sub-desc">The position to align to.</div></li><li><code>offsets</code> : Array<div class="sub-desc">(optional) Offset the positioning by [x, y]</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><li><code>monitorScroll</code> : Boolean/Number<div class="sub-desc">(optional) true to monitor body scroll and reposition. If this parameter is a number, it is used as the buffer delay (defaults to 50ms).</div></li><li><code></code> : <div class="sub-desc"></div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="animate"></a>
|
|
<div class="mdetail alt">
|
|
<h3>animate</i></h3>
|
|
<code>public function animate(<code>Object args</code>, <span class="optional" title="Optional">[<code>Float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>String easing</code>]</span>, <span class="optional" title="Optional">[<code>String animType</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Perform animation on this element.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>args</code> : Object<div class="sub-desc">The YUI animation control args</div></li><li><code>duration</code> : Float<div class="sub-desc">(optional) How long the animation lasts. (Defaults to .35 seconds)</div></li><li><code>onComplete</code> : Function<div class="sub-desc">(optional) Function to call when animation completes.</div></li><li><code>easing</code> : String<div class="sub-desc">(optional) Easing method to use. (Defaults to 'easeOut')</div></li><li><code>animType</code> : String<div class="sub-desc">(optional) 'run' is the default. Can be 'color', 'motion', or 'scroll'</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="appendChild"></a>
|
|
<div class="mdetail">
|
|
<h3>appendChild</i></h3>
|
|
<code>public function appendChild(<code>String/HTMLElement/Array/Element/CompositeElement el</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Appends the passed element(s) to this element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>el</code> : String/HTMLElement/Array/Element/CompositeElement<div class="sub-desc"></div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="appendTo"></a>
|
|
<div class="mdetail alt">
|
|
<h3>appendTo</i></h3>
|
|
<code>public function appendTo(<code>String/HTMLElement/Element el</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Appends this element to the passed element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>el</code> : String/HTMLElement/Element<div class="sub-desc">The new parent element</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="applyStyles"></a>
|
|
<div class="mdetail">
|
|
<h3>applyStyles</i></h3>
|
|
<code>public function applyStyles(<code>String/Object/Function styles</code>)</code>
|
|
<div class="mdetail-desc">
|
|
More flexible version of <a href="#setStyle">setStyle</a> for setting style properties.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>styles</code> : String/Object/Function<div class="sub-desc">A style specification string eg "width:100px", or object in the form {width:"100px"}, or a function which returns such a specification.</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="autoHeight"></a>
|
|
<div class="mdetail alt">
|
|
<h3>autoHeight</i></h3>
|
|
<code>public function autoHeight(<span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>Float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>String easing</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Measures the elements content height and updates height to match. Note, this function uses setTimeout and
|
|
the new height may not be available immediately.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>animate</code> : Boolean<div class="sub-desc">(optional) Animate the transition (Default is false)</div></li><li><code>duration</code> : Float<div class="sub-desc">(optional) Length of the animation. (Defaults to .35 seconds)</div></li><li><code>onComplete</code> : Function<div class="sub-desc">(optional) Function to call when animation completes.</div></li><li><code>easing</code> : String<div class="sub-desc">(optional) Easing method to use.</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="beginMeasure"></a>
|
|
<div class="mdetail">
|
|
<h3>beginMeasure</i></h3>
|
|
<code>public function beginMeasure()</code>
|
|
<div class="mdetail-desc">
|
|
Temporarily enables offsets (width,height,x,y) for an element with display:none, use endMeasure() when done.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="blur"></a>
|
|
<div class="mdetail alt">
|
|
<h3>blur</i></h3>
|
|
<code>public function blur()</code>
|
|
<div class="mdetail-desc">
|
|
Tries to blur the element. Any exceptions are caught.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="center"></a>
|
|
<div class="mdetail">
|
|
<h3>center</i></h3>
|
|
<code>public function center(<span class="optional" title="Optional">[<code>String/HTMLElement/Ext.Element centerIn</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Centers the Element in either the viewport, or another Element.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>centerIn</code> : String/HTMLElement/Ext.Element<div class="sub-desc">(optional) The element in which to center the element.</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="child"></a>
|
|
<div class="mdetail alt">
|
|
<h3>child</i></h3>
|
|
<code>public function child(<code>String selector</code>, <code>Boolean returnDom</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Selects a single child based on the passed CSS selector (the selector should not contain an id)
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>selector</code> : String<div class="sub-desc">The CSS selector</div></li><li><code>returnDom</code> : Boolean<div class="sub-desc">true to return the DOM node instead of Ext.Element</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Element</code><div class="sub-desc">The element</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="clean"></a>
|
|
<div class="mdetail">
|
|
<h3>clean</i></h3>
|
|
<code>public function clean(<span class="optional" title="Optional">[<code>Boolean forceReclean</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Removes worthless text nodes
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="clearOpacity"></a>
|
|
<div class="mdetail alt">
|
|
<h3>clearOpacity</i></h3>
|
|
<code>public function clearOpacity()</code>
|
|
<div class="mdetail-desc">
|
|
Clears any opacity settings from this element. Required in some cases for IE.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="clearPositioning"></a>
|
|
<div class="mdetail">
|
|
<h3>clearPositioning</i></h3>
|
|
<code>public function clearPositioning(<span class="optional" title="Optional">[<code>String value</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Clear positioning back to the default when the document was loaded
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="clip"></a>
|
|
<div class="mdetail alt">
|
|
<h3>clip</i></h3>
|
|
<code>public function clip()</code>
|
|
<div class="mdetail-desc">
|
|
Store the current overflow setting and clip overflow on the element - use <a href="#unclip">unclip</a> to remove
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="contains"></a>
|
|
<div class="mdetail">
|
|
<h3>contains</i></h3>
|
|
<code>public function contains(<code>HTMLElement/String el</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Returns true if this element is an ancestor of the passed element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>el</code> : HTMLElement/String<div class="sub-desc"></div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Boolean</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="createChild"></a>
|
|
<div class="mdetail alt">
|
|
<h3>createChild</i></h3>
|
|
<code>public function createChild(<code>Object config</code>, <span class="optional" title="Optional">[<code>HTMLElement insertBefore</code>]</span>, <span class="optional" title="Optional">[<code>Boolean returnDom</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child element.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>config</code> : Object<div class="sub-desc">DomHelper element config object</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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">The new child element</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="createProxy"></a>
|
|
<div class="mdetail">
|
|
<h3>createProxy</i></h3>
|
|
<code>public function createProxy(<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>)</code>
|
|
<div class="mdetail-desc">
|
|
Creates a proxy element of this element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">The new proxy element</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="createShim"></a>
|
|
<div class="mdetail alt">
|
|
<h3>createShim</i></h3>
|
|
<code>public function createShim()</code>
|
|
<div class="mdetail-desc">
|
|
Creates an iframe shim for this element to keep selects and other windowed objects from
|
|
showing through.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">The new shim element</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="down"></a>
|
|
<div class="mdetail">
|
|
<h3>down</i></h3>
|
|
<code>public function down(<code>String selector</code>, <code>Boolean returnDom</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Selects a single *direct* child based on the passed CSS selector (the selector should not contain an id)
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>selector</code> : String<div class="sub-desc">The CSS selector</div></li><li><code>returnDom</code> : Boolean<div class="sub-desc">true to return the DOM node instead of Ext.Element</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Element</code><div class="sub-desc">The element</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="enableDisplayMode"></a>
|
|
<div class="mdetail alt">
|
|
<h3>enableDisplayMode</i></h3>
|
|
<code>public function enableDisplayMode(<span class="optional" title="Optional">[<code>String display</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Convenience method for setVisibilityMode(Element.DISPLAY)
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>display</code> : String<div class="sub-desc">(optional) What to set display to when visible</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="endMeasure"></a>
|
|
<div class="mdetail">
|
|
<h3>endMeasure</i></h3>
|
|
<code>public function endMeasure()</code>
|
|
<div class="mdetail-desc">
|
|
Restores displays to before beginMeasure was called
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="findParent"></a>
|
|
<div class="mdetail alt">
|
|
<h3>findParent</i></h3>
|
|
<code>public function findParent(<code>String ss</code>, <span class="optional" title="Optional">[<code>Number/String/HTMLElement/Element maxDepth</code>]</span>, <span class="optional" title="Optional">[<code>Boolean returnEl</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
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">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>ss</code> : String<div class="sub-desc">The simple selector to test</div></li><li><code>maxDepth</code> : Number/String/HTMLElement/Element<div class="sub-desc">(optional) The max depth to 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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>HTMLElement</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="findParentNode"></a>
|
|
<div class="mdetail">
|
|
<h3>findParentNode</i></h3>
|
|
<code>public function findParentNode(<code>String ss</code>, <span class="optional" title="Optional">[<code>Number/String/HTMLElement/Element maxDepth</code>]</span>, <span class="optional" title="Optional">[<code>Boolean returnEl</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
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">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>ss</code> : String<div class="sub-desc">The simple selector to test</div></li><li><code>maxDepth</code> : Number/String/HTMLElement/Element<div class="sub-desc">(optional) The max depth to 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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>HTMLElement</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="fitToParent"></a>
|
|
<div class="mdetail alt">
|
|
<h3>fitToParent</i></h3>
|
|
<code>public function fitToParent(<span class="optional" title="Optional">[<code>Boolean monitorResize</code>]</span>, <span class="optional" title="Optional">[<code>String/HTMLElment/Element targetParent</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Sizes this element to its parent element's dimensions performing
|
|
neccessary box adjustments.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>monitorResize</code> : Boolean<div class="sub-desc">(optional) If true maintains the fit when the browser window is resized.</div></li><li><code>targetParent</code> : String/HTMLElment/Element<div class="sub-desc">(optional) The target parent, default to the parentNode.</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="focus"></a>
|
|
<div class="mdetail">
|
|
<h3>focus</i></h3>
|
|
<code>public function focus()</code>
|
|
<div class="mdetail-desc">
|
|
Tries to focus the element. Any exceptions are caught.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getAlignToXY"></a>
|
|
<div class="mdetail alt">
|
|
<h3>getAlignToXY</i></h3>
|
|
<code>public function getAlignToXY(<code>String/HTMLElement/Ext.Element element</code>, <code>String position</code>, <span class="optional" title="Optional">[<code>Array offsets</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Gets the x,y coordinates to align this element with another element. See <a href="#alignTo">alignTo</a> for more info on the
|
|
supported position values.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>element</code> : String/HTMLElement/Ext.Element<div class="sub-desc">The element to align to.</div></li><li><code>position</code> : String<div class="sub-desc">The position to align to.</div></li><li><code>offsets</code> : Array<div class="sub-desc">(optional) Offset the positioning by [x, y]</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Array</code><div class="sub-desc">[x, y]</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getAnchorXY"></a>
|
|
<div class="mdetail">
|
|
<h3>getAnchorXY</i></h3>
|
|
<code>public function getAnchorXY(<span class="optional" title="Optional">[<code>String anchor</code>]</span>, <span class="optional" title="Optional">[<code>Object size</code>]</span>, <span class="optional" title="Optional">[<code>Boolean local</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Gets the x,y coordinates specified by the anchor position on the element.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>anchor</code> : String<div class="sub-desc">(optional) The specified anchor position (defaults to "c"). See <a href="#alignTo">alignTo</a> for details on supported anchor positions.</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><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> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Array</code><div class="sub-desc">[x, y] An array containing the element's x and y coordinates</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getBorderWidth"></a>
|
|
<div class="mdetail alt">
|
|
<h3>getBorderWidth</i></h3>
|
|
<code>public function getBorderWidth(<code>String side</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Gets the width of the border(s) for the specified side(s)
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Number</code><div class="sub-desc">The width of the sides passed added together</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getBottom"></a>
|
|
<div class="mdetail">
|
|
<h3>getBottom</i></h3>
|
|
<code>public function getBottom(<code>Boolean local</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Gets the bottom Y coordinate of the element (element Y position + element height)
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>local</code> : Boolean<div class="sub-desc">True to get the local css position instead of page coordinate</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Number</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getBox"></a>
|
|
<div class="mdetail alt">
|
|
<h3>getBox</i></h3>
|
|
<code>public function getBox(<span class="optional" title="Optional">[<code>Boolean contentBox</code>]</span>, <span class="optional" title="Optional">[<code>Boolean local</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
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">
|
|
<strong>Parameters:</strong>
|
|
<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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Object</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getCenterXY"></a>
|
|
<div class="mdetail">
|
|
<h3>getCenterXY</i></h3>
|
|
<code>public function getCenterXY()</code>
|
|
<div class="mdetail-desc">
|
|
Calculates the x, y to center this element on the screen
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Array</code><div class="sub-desc">The x, y values [x, y]</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getColor"></a>
|
|
<div class="mdetail alt">
|
|
<h3>getColor</i></h3>
|
|
<code>public function getColor(<code>String attr</code>, <code>String defaultValue</code>, <span class="optional" title="Optional">[<code>String prefix</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
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">
|
|
<strong>Parameters:</strong>
|
|
<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 YUI color anims.</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getComputedHeight"></a>
|
|
<div class="mdetail">
|
|
<h3>getComputedHeight</i></h3>
|
|
<code>public function getComputedHeight()</code>
|
|
<div class="mdetail-desc">
|
|
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">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Number</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getComputedWidth"></a>
|
|
<div class="mdetail alt">
|
|
<h3>getComputedWidth</i></h3>
|
|
<code>public function getComputedWidth()</code>
|
|
<div class="mdetail-desc">
|
|
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">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Number</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getFrameWidth"></a>
|
|
<div class="mdetail">
|
|
<h3>getFrameWidth</i></h3>
|
|
<code>public function getFrameWidth(<code>String sides</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Returns the sum width of the padding and borders for the passed "sides". See getBorderWidth()
|
|
for more information about the sides.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>sides</code> : String<div class="sub-desc"></div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Number</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getHeight"></a>
|
|
<div class="mdetail alt">
|
|
<h3>getHeight</i></h3>
|
|
<code>public function getHeight(<span class="optional" title="Optional">[<code>Boolean contentHeight</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Returns the offset height of the element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>contentHeight</code> : Boolean<div class="sub-desc">(optional) true to get the height minus borders and padding</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Number</code><div class="sub-desc">The element's height</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getLeft"></a>
|
|
<div class="mdetail">
|
|
<h3>getLeft</i></h3>
|
|
<code>public function getLeft(<code>Boolean local</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Gets the left X coordinate
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>local</code> : Boolean<div class="sub-desc">True to get the local css position instead of page coordinate</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Number</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getMargins"></a>
|
|
<div class="mdetail alt">
|
|
<h3>getMargins</i></h3>
|
|
<code>public function getMargins(<span class="optional" title="Optional">[<code>String sides</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
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">
|
|
<strong>Parameters:</strong>
|
|
<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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Object/Number</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getNextSibling"></a>
|
|
<div class="mdetail">
|
|
<h3>getNextSibling</i></h3>
|
|
<code>public function getNextSibling()</code>
|
|
<div class="mdetail-desc">
|
|
Gets the next sibling, skipping text nodes
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>HTMLElement</code><div class="sub-desc">The next sibling or null</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getPadding"></a>
|
|
<div class="mdetail alt">
|
|
<h3>getPadding</i></h3>
|
|
<code>public function getPadding(<code>String side</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Gets the width of the padding(s) for the specified side(s)
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Number</code><div class="sub-desc">The padding of the sides passed added together</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getPositioning"></a>
|
|
<div class="mdetail">
|
|
<h3>getPositioning</i></h3>
|
|
<code>public function getPositioning()</code>
|
|
<div class="mdetail-desc">
|
|
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">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Object</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getPrevSibling"></a>
|
|
<div class="mdetail alt">
|
|
<h3>getPrevSibling</i></h3>
|
|
<code>public function getPrevSibling()</code>
|
|
<div class="mdetail-desc">
|
|
Gets the previous sibling, skipping text nodes
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>HTMLElement</code><div class="sub-desc">The previous sibling or null</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getRegion"></a>
|
|
<div class="mdetail">
|
|
<h3>getRegion</i></h3>
|
|
<code>public function getRegion()</code>
|
|
<div class="mdetail-desc">
|
|
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">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Region</code><div class="sub-desc">A Ext.lib.Region containing "top, left, bottom, right" member data.</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getRight"></a>
|
|
<div class="mdetail alt">
|
|
<h3>getRight</i></h3>
|
|
<code>public function getRight(<code>Boolean local</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Gets the right X coordinate of the element (element X position + element width)
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>local</code> : Boolean<div class="sub-desc">True to get the local css position instead of page coordinate</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Number</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getSize"></a>
|
|
<div class="mdetail">
|
|
<h3>getSize</i></h3>
|
|
<code>public function getSize(<span class="optional" title="Optional">[<code>Boolean contentSize</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Returns the size of the element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>contentSize</code> : Boolean<div class="sub-desc">(optional) true to get the width/size minus borders and padding</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Object</code><div class="sub-desc">An object containing the element's size {width: (element width), height: (element height)}</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getStyle"></a>
|
|
<div class="mdetail alt">
|
|
<h3>getStyle</i></h3>
|
|
<code>public function getStyle(<code>String property</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Normalizes currentStyle and computedStyle. This is not YUI getStyle, it is an optimised version.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>property</code> : String<div class="sub-desc">The style property whose value is returned.</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>String</code><div class="sub-desc">The current value of the style property for this element.</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getStyles"></a>
|
|
<div class="mdetail">
|
|
<h3>getStyles</i></h3>
|
|
<code>public function getStyles(<code>String style1</code>, <code>String style2</code>, <code>String etc</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Get an object with properties matching the styles requested.
|
|
e.g. el.getStyles('color', 'font-size', 'width') might return
|
|
{'color': '#FFFFFF', 'font-size': '13px', 'width': '100px'}.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>style1</code> : String<div class="sub-desc"></div></li><li><code>style2</code> : String<div class="sub-desc"></div></li><li><code>etc</code> : String<div class="sub-desc"></div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Object</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getTop"></a>
|
|
<div class="mdetail alt">
|
|
<h3>getTop</i></h3>
|
|
<code>public function getTop(<code>Boolean local</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Gets the top Y coordinate
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>local</code> : Boolean<div class="sub-desc">True to get the local css position instead of page coordinate</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Number</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getUpdateManager"></a>
|
|
<div class="mdetail">
|
|
<h3>getUpdateManager</i></h3>
|
|
<code>public function getUpdateManager()</code>
|
|
<div class="mdetail-desc">
|
|
Gets this elements UpdateManager
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.UpdateManager</code><div class="sub-desc">The UpdateManager</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getValue"></a>
|
|
<div class="mdetail alt">
|
|
<h3>getValue</i></h3>
|
|
<code>public function getValue(<code>Boolean asNumber</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Returns the value of the "value" attribute
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>asNumber</code> : Boolean<div class="sub-desc">true to parse the value as a number</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>String/Number</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getWidth"></a>
|
|
<div class="mdetail">
|
|
<h3>getWidth</i></h3>
|
|
<code>public function getWidth(<span class="optional" title="Optional">[<code>Boolean contentWidth</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Returns the offset width of the element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>contentWidth</code> : Boolean<div class="sub-desc">(optional) true to get the width minus borders and padding</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Number</code><div class="sub-desc">The element's width</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getX"></a>
|
|
<div class="mdetail alt">
|
|
<h3>getX</i></h3>
|
|
<code>public function getX()</code>
|
|
<div class="mdetail-desc">
|
|
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">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Number</code><div class="sub-desc">The X position of the element</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getXY"></a>
|
|
<div class="mdetail">
|
|
<h3>getXY</i></h3>
|
|
<code>public function getXY()</code>
|
|
<div class="mdetail-desc">
|
|
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">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Array</code><div class="sub-desc">The XY position of the element</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getY"></a>
|
|
<div class="mdetail alt">
|
|
<h3>getY</i></h3>
|
|
<code>public function getY()</code>
|
|
<div class="mdetail-desc">
|
|
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">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Number</code><div class="sub-desc">The Y position of the element</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="hasClass"></a>
|
|
<div class="mdetail">
|
|
<h3>hasClass</i></h3>
|
|
<code>public function hasClass(<code>String className</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Checks if a CSS class is in use by the element.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>className</code> : String<div class="sub-desc">The CSS class to check</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Boolean</code><div class="sub-desc">true or false</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="hide"></a>
|
|
<div class="mdetail alt">
|
|
<h3>hide</i></h3>
|
|
<code>public function hide(<span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Hide this element - Uses display mode to determine whether to use "display" or "visibility". See <a href="#setVisible">setVisible</a>.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="initDD"></a>
|
|
<div class="mdetail">
|
|
<h3>initDD</i></h3>
|
|
<code>public function initDD(<code>String group</code>, <code>Object config</code>, <code>Object overrides</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Initializes a Ext.dd.DD object for this element.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.dd.DD</code><div class="sub-desc">The DD object</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="initDDProxy"></a>
|
|
<div class="mdetail alt">
|
|
<h3>initDDProxy</i></h3>
|
|
<code>public function initDDProxy(<code>String group</code>, <code>Object config</code>, <code>Object overrides</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Initializes a Ext.dd.DDProxy object for this element.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.dd.DDProxy</code><div class="sub-desc">The DDProxy object</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="initDDTarget"></a>
|
|
<div class="mdetail">
|
|
<h3>initDDTarget</i></h3>
|
|
<code>public function initDDTarget(<code>String group</code>, <code>Object config</code>, <code>Object overrides</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Initializes a Ext.dd.DDTarget object for this element.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.dd.DDTarget</code><div class="sub-desc">The DDTarget object</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="insertAfter"></a>
|
|
<div class="mdetail alt">
|
|
<h3>insertAfter</i></h3>
|
|
<code>public function insertAfter(<code>String/HTMLElement/Element el</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Inserts this element after the passed element in the DOM
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>el</code> : String/HTMLElement/Element<div class="sub-desc">The element to insert after</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="insertBefore"></a>
|
|
<div class="mdetail">
|
|
<h3>insertBefore</i></h3>
|
|
<code>public function insertBefore(<code>String/HTMLElement/Element el</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Inserts this element before the passed element in the DOM
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>el</code> : String/HTMLElement/Element<div class="sub-desc">The element to insert before</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="insertFirst"></a>
|
|
<div class="mdetail alt">
|
|
<h3>insertFirst</i></h3>
|
|
<code>public function insertFirst(<code>String/HTMLElement/Element/Object el</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Inserts (or creates) an element (or DomHelper config) as the first child of the this element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>el</code> : String/HTMLElement/Element/Object<div class="sub-desc">The id or element to insert or a DomHelper config to create and insert</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">The new child</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="insertHtml"></a>
|
|
<div class="mdetail">
|
|
<h3>insertHtml</i></h3>
|
|
<code>public function insertHtml(<code>String where</code>, <code>String html</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Inserts an html fragment into this element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>where</code> : String<div class="sub-desc">Where to insert the html in relation to the this element - beforeBegin, afterBegin, beforeEnd, afterEnd.</div></li><li><code>html</code> : String<div class="sub-desc">The HTML fragment</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>HTMLElement</code><div class="sub-desc">The inserted node (or nearest related if more than 1 inserted)</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="insertSibling"></a>
|
|
<div class="mdetail alt">
|
|
<h3>insertSibling</i></h3>
|
|
<code>public function insertSibling(<code>String/HTMLElement/Element/Object el</code>, <span class="optional" title="Optional">[<code>String where</code>]</span>, <span class="optional" title="Optional">[<code>Boolean returnDom</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Inserts (or creates) the passed element (or DomHelper config) as a sibling of this element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>el</code> : String/HTMLElement/Element/Object<div class="sub-desc">The id or element to insert or a DomHelper config to create and insert</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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">the inserted Element</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="is"></a>
|
|
<div class="mdetail">
|
|
<h3>is</i></h3>
|
|
<code>public function is(<code>String ss</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Returns true if this element matches the passed simple selector (e.g. div.some-class or span:first-child)
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>ss</code> : String<div class="sub-desc">The simple selector to test</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Boolean</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="isBorderBox"></a>
|
|
<div class="mdetail alt">
|
|
<h3>isBorderBox</i></h3>
|
|
<code>public function isBorderBox()</code>
|
|
<div class="mdetail-desc">
|
|
Tests various css rules/browsers to determine if this element uses a border box
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Boolean</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="isDisplayed"></a>
|
|
<div class="mdetail">
|
|
<h3>isDisplayed</i></h3>
|
|
<code>public function isDisplayed()</code>
|
|
<div class="mdetail-desc">
|
|
Returns true if display is not "none"
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Boolean</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="isMasked"></a>
|
|
<div class="mdetail alt">
|
|
<h3>isMasked</i></h3>
|
|
<code>public function isMasked()</code>
|
|
<div class="mdetail-desc">
|
|
Returns true if this element is masked
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Boolean</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="isScrollable"></a>
|
|
<div class="mdetail">
|
|
<h3>isScrollable</i></h3>
|
|
<code>public function isScrollable()</code>
|
|
<div class="mdetail-desc">
|
|
Returns true if this element is scrollable.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Boolean</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="isVisible"></a>
|
|
<div class="mdetail alt">
|
|
<h3>isVisible</i></h3>
|
|
<code>public function isVisible(<code>Boolean deep</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Checks whether the element is currently visible using both visibility and display properties.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>deep</code> : Boolean<div class="sub-desc">True to walk the dom and see if parent elements are hidden.</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Boolean</code><div class="sub-desc">true if the element is currently visible</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="load"></a>
|
|
<div class="mdetail">
|
|
<h3>load</i></h3>
|
|
<code>public function load(<code>String/Function url</code>, <span class="optional" title="Optional">[<code>String/Object params</code>]</span>, <span class="optional" title="Optional">[<code>Function callback</code>]</span>, <span class="optional" title="Optional">[<code>Boolean discardUrl</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Direct access to the UpdateManager update() method (takes the same parameters).
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>url</code> : String/Function<div class="sub-desc">The url for this request or a function to call to get the url</div></li><li><code>params</code> : String/Object<div class="sub-desc">(optional) The parameters to pass as either a url encoded string "param1=1&param2=2" or an object {param1: 1, param2: 2}</div></li><li><code>callback</code> : Function<div class="sub-desc">(optional) Callback when transaction is complete - called with signature (oElement, bSuccess)</div></li><li><code>discardUrl</code> : Boolean<div class="sub-desc">(optional) By default when you execute an update the defaultUrl is changed to the last used url. If true, it will not store the url.</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="mask"></a>
|
|
<div class="mdetail alt">
|
|
<h3>mask</i></h3>
|
|
<code>public function mask(<span class="optional" title="Optional">[<code>String msg</code>]</span>, <span class="optional" title="Optional">[<code>String msgCls</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
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">
|
|
<strong>Parameters:</strong>
|
|
<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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Element</code><div class="sub-desc">The message element</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="move"></a>
|
|
<div class="mdetail">
|
|
<h3>move</i></h3>
|
|
<code>public function move(<code>String direction</code>, <code>Number distance</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Move this element relative to its current position.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>direction</code> : String<div class="sub-desc">Possible values are: "l","left" - "r","right" - "t","top","up" - "b","bottom","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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="moveTo"></a>
|
|
<div class="mdetail alt">
|
|
<h3>moveTo</i></h3>
|
|
<code>public function moveTo(<code>Number x</code>, <code>Number y</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Set 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">
|
|
<strong>Parameters:</strong>
|
|
<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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="position"></a>
|
|
<div class="mdetail">
|
|
<h3>position</i></h3>
|
|
<code>public function position(<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>)</code>
|
|
<div class="mdetail-desc">
|
|
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">
|
|
<strong>Parameters:</strong>
|
|
<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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="query"></a>
|
|
<div class="mdetail alt">
|
|
<h3>query</i></h3>
|
|
<code>public function query(<code>String selector</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Selects child nodes based on the passed CSS selector (the selector should not contain an id)
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>selector</code> : String<div class="sub-desc">The CSS selector</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Array</code><div class="sub-desc">An array of the matched nodes</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="radioClass"></a>
|
|
<div class="mdetail">
|
|
<h3>radioClass</i></h3>
|
|
<code>public function radioClass(<code>String className</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Adds the passed className to this element and removes the class from all siblings
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>className</code> : String<div class="sub-desc">The className to add</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="remove"></a>
|
|
<div class="mdetail alt">
|
|
<h3>remove</i></h3>
|
|
<code>public function remove()</code>
|
|
<div class="mdetail-desc">
|
|
Removes this element from the DOM and deletes it from the cache
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="removeAllListeners"></a>
|
|
<div class="mdetail">
|
|
<h3>removeAllListeners</i></h3>
|
|
<code>public function removeAllListeners()</code>
|
|
<div class="mdetail-desc">
|
|
Removes all previous added listeners from this element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="removeClass"></a>
|
|
<div class="mdetail alt">
|
|
<h3>removeClass</i></h3>
|
|
<code>public function removeClass(<code>String/Array className</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Removes a CSS class from the element.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>className</code> : String/Array<div class="sub-desc">The CSS class to remove or an array of classes</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="removeListener"></a>
|
|
<div class="mdetail">
|
|
<h3>removeListener</i></h3>
|
|
<code>public function removeListener(<code>String eventName</code>, <code>Function fn</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Removes an event handler from this element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<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> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="repaint"></a>
|
|
<div class="mdetail alt">
|
|
<h3>repaint</i></h3>
|
|
<code>public function repaint()</code>
|
|
<div class="mdetail-desc">
|
|
Forces the browser to repaint this element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="replace"></a>
|
|
<div class="mdetail">
|
|
<h3>replace</i></h3>
|
|
<code>public function replace(<code>String/HTMLElement/Element el</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Replaces the passed element with this element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>el</code> : String/HTMLElement/Element<div class="sub-desc">The element to replace</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="replaceClass"></a>
|
|
<div class="mdetail alt">
|
|
<h3>replaceClass</i></h3>
|
|
<code>public function replaceClass(<code>String oldClassName</code>, <code>String newClassName</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Replaces a CSS class on the element with another.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="scroll"></a>
|
|
<div class="mdetail">
|
|
<h3>scroll</i></h3>
|
|
<code>public function scroll(<code>String direction</code>, <code>Number distance</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Scrolls this element the specified direction. Does bounds checking to make sure the scroll is
|
|
within this elements scrollable range.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>direction</code> : String<div class="sub-desc">Possible values are: "l","left" - "r","right" - "t","top","up" - "b","bottom","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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<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>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="scrollIntoView"></a>
|
|
<div class="mdetail alt">
|
|
<h3>scrollIntoView</i></h3>
|
|
<code>public function scrollIntoView(<span class="optional" title="Optional">[<code>String/HTMLElement/Element container</code>]</span>, <span class="optional" title="Optional">[<code>Boolean hscroll</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Scrolls this element into view within the passed container.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>container</code> : String/HTMLElement/Element<div class="sub-desc">(optional) The container element to scroll (defaults to document.body)</div></li><li><code>hscroll</code> : Boolean<div class="sub-desc">(optional) false to disable horizontal scroll</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="scrollTo"></a>
|
|
<div class="mdetail">
|
|
<h3>scrollTo</i></h3>
|
|
<code>public function scrollTo(<code>String side</code>, <code>Number value</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
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">
|
|
<strong>Parameters:</strong>
|
|
<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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="select"></a>
|
|
<div class="mdetail alt">
|
|
<h3>select</i></h3>
|
|
<code>public function select(<code>String selector</code>, <code>Boolean unique</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Creates a CompositeElement for child nodes based on the passed CSS selector (the selector should not contain an id)
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>selector</code> : String<div class="sub-desc">The CSS selector</div></li><li><code>unique</code> : Boolean<div class="sub-desc">true to create a unique Ext.Element for each child (defaults to a shared flyweight object)</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>CompositeElement/CompositeElementLite</code><div class="sub-desc">The composite element</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="set"></a>
|
|
<div class="mdetail">
|
|
<h3>set</i></h3>
|
|
<code>public function set(<code>Object o</code>, <span class="optional" title="Optional">[<code>Boolean useSet</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Sets the passed attributes as attributes of this element (a style attribute can be a string, object or function)
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setBottom"></a>
|
|
<div class="mdetail alt">
|
|
<h3>setBottom</i></h3>
|
|
<code>public function setBottom(<code>String bottom</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Set the element's css bottom style
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>bottom</code> : String<div class="sub-desc">The bottom CSS property value</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setBounds"></a>
|
|
<div class="mdetail">
|
|
<h3>setBounds</i></h3>
|
|
<code>public function setBounds(<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>)</code>
|
|
<div class="mdetail-desc">
|
|
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">
|
|
<strong>Parameters:</strong>
|
|
<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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setBox"></a>
|
|
<div class="mdetail alt">
|
|
<h3>setBox</i></h3>
|
|
<code>public function setBox(<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>)</code>
|
|
<div class="mdetail-desc">
|
|
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">
|
|
<strong>Parameters:</strong>
|
|
<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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setDisplayed"></a>
|
|
<div class="mdetail">
|
|
<h3>setDisplayed</i></h3>
|
|
<code>public function setDisplayed(<code>Boolean value</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Sets the css display. Uses originalDisplay if value is a boolean true.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>value</code> : Boolean<div class="sub-desc">Boolean to display the element using its default display or a string to set the display directly</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setHeight"></a>
|
|
<div class="mdetail alt">
|
|
<h3>setHeight</i></h3>
|
|
<code>public function setHeight(<code>Number height</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Set the height of the element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setLeft"></a>
|
|
<div class="mdetail">
|
|
<h3>setLeft</i></h3>
|
|
<code>public function setLeft(<code>String left</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Set the element's left position directly using CSS style (instead of setX())
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>left</code> : String<div class="sub-desc">The left CSS property value</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setLeftTop"></a>
|
|
<div class="mdetail alt">
|
|
<h3>setLeftTop</i></h3>
|
|
<code>public function setLeftTop()</code>
|
|
<div class="mdetail-desc">
|
|
Quick set left and top adding default units
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setLocation"></a>
|
|
<div class="mdetail">
|
|
<h3>setLocation</i></h3>
|
|
<code>public function setLocation(<code>Number x</code>, <code>Number y</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Set 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">
|
|
<strong>Parameters:</strong>
|
|
<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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setOpacity"></a>
|
|
<div class="mdetail alt">
|
|
<h3>setOpacity</i></h3>
|
|
<code>public function setOpacity(<code>Float opacity</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Set the opacity of the element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setPositioning"></a>
|
|
<div class="mdetail">
|
|
<h3>setPositioning</i></h3>
|
|
<code>public function setPositioning(<code>Object posCfg</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Set positioning with an object returned by getPositioning().
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>posCfg</code> : Object<div class="sub-desc"></div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setRegion"></a>
|
|
<div class="mdetail alt">
|
|
<h3>setRegion</i></h3>
|
|
<code>public function setRegion(<code>Ext.lib.Region region</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Sets the element's position and size the the specified region. If animation is true then width, height, x and y will be animated concurrently.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setRight"></a>
|
|
<div class="mdetail">
|
|
<h3>setRight</i></h3>
|
|
<code>public function setRight(<code>String right</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Set the element's css right style
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>right</code> : String<div class="sub-desc">The right CSS property value</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setSize"></a>
|
|
<div class="mdetail alt">
|
|
<h3>setSize</i></h3>
|
|
<code>public function setSize(<code>Number width</code>, <code>Number height</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Set the size of the element. If animation is true, both width an height will be animated concurrently.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setStyle"></a>
|
|
<div class="mdetail">
|
|
<h3>setStyle</i></h3>
|
|
<code>public function setStyle(<code>String/Object property</code>, <span class="optional" title="Optional">[<code>String val</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Wrapper for setting style properties, also takes single object parameter of multiple styles
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<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>val</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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setTop"></a>
|
|
<div class="mdetail alt">
|
|
<h3>setTop</i></h3>
|
|
<code>public function setTop(<code>String top</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Set the element's top position directly using CSS style (instead of setY())
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>top</code> : String<div class="sub-desc">The top CSS property value</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setVisibilityMode"></a>
|
|
<div class="mdetail">
|
|
<h3>setVisibilityMode</i></h3>
|
|
<code>public function setVisibilityMode(<code>visMode Element.VISIBILITY</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Sets the elements 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">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>Element.VISIBILITY</code> : visMode<div class="sub-desc">or Element.DISPLAY</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setVisible"></a>
|
|
<div class="mdetail alt">
|
|
<h3>setVisible</i></h3>
|
|
<code>public function setVisible(<code>Boolean visible</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
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">
|
|
<strong>Parameters:</strong>
|
|
<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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setWidth"></a>
|
|
<div class="mdetail">
|
|
<h3>setWidth</i></h3>
|
|
<code>public function setWidth(<code>Number width</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Set the width of the element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setX"></a>
|
|
<div class="mdetail alt">
|
|
<h3>setX</i></h3>
|
|
<code>public function setX(<code>Number The</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
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">
|
|
<strong>Parameters:</strong>
|
|
<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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setXY"></a>
|
|
<div class="mdetail">
|
|
<h3>setXY</i></h3>
|
|
<code>public function setXY(<code>Array pos</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Set 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">
|
|
<strong>Parameters:</strong>
|
|
<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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setY"></a>
|
|
<div class="mdetail alt">
|
|
<h3>setY</i></h3>
|
|
<code>public function setY(<code>Number The</code>, <span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
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">
|
|
<strong>Parameters:</strong>
|
|
<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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="show"></a>
|
|
<div class="mdetail">
|
|
<h3>show</i></h3>
|
|
<code>public function show(<span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Show this element - Uses display mode to determine whether to use "display" or "visibility". See <a href="#setVisible">setVisible</a>.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="swallowEvent"></a>
|
|
<div class="mdetail alt">
|
|
<h3>swallowEvent</i></h3>
|
|
<code>public function swallowEvent(<code>String eventName</code>, <span class="optional" title="Optional">[<code>Boolean preventDefault</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Stops the specified event from bubbling and optionally prevents the default action
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>eventName</code> : String<div class="sub-desc"></div></li><li><code>preventDefault</code> : Boolean<div class="sub-desc">(optional) true to prevent the default action too</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="toggle"></a>
|
|
<div class="mdetail">
|
|
<h3>toggle</i></h3>
|
|
<code>public function toggle(<span class="optional" title="Optional">[<code>Boolean/Object animate</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Toggles the elements visibility or display, depending on visibility mode.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="toggleClass"></a>
|
|
<div class="mdetail alt">
|
|
<h3>toggleClass</i></h3>
|
|
<code>public function toggleClass(<code>String className</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Toggles (adds or removes) the passed class.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>className</code> : String<div class="sub-desc"></div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="translatePoints"></a>
|
|
<div class="mdetail">
|
|
<h3>translatePoints</i></h3>
|
|
<code>public function translatePoints(<code>Number/Array x</code>, <code>Number y</code>, <code>Object An</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Translates the passed page coordinates into left/top css values for this element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<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">The page y</div></li><li><code>An</code> : Object<div class="sub-desc">object with left and top properties. e.g. {left: (value), top: (value)}</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="unclip"></a>
|
|
<div class="mdetail alt">
|
|
<h3>unclip</i></h3>
|
|
<code>public function unclip()</code>
|
|
<div class="mdetail-desc">
|
|
Return clipping (overflow) to original clipping before clip() was called
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="unmask"></a>
|
|
<div class="mdetail">
|
|
<h3>unmask</i></h3>
|
|
<code>public function unmask()</code>
|
|
<div class="mdetail-desc">
|
|
Removes a previously applied mask. If removeEl is true the mask overlay is destroyed, otherwise
|
|
it is cached for reuse.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="unselectable"></a>
|
|
<div class="mdetail alt">
|
|
<h3>unselectable</i></h3>
|
|
<code>public function unselectable()</code>
|
|
<div class="mdetail-desc">
|
|
Disables text selection for this element (normalized across browsers)
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="up"></a>
|
|
<div class="mdetail">
|
|
<h3>up</i></h3>
|
|
<code>public function up(<code>String ss</code>, <span class="optional" title="Optional">[<code>Number/String/HTMLElement/Element maxDepth</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
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">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>ss</code> : String<div class="sub-desc">The simple selector to test</div></li><li><code>maxDepth</code> : Number/String/HTMLElement/Element<div class="sub-desc">(optional) The max depth to search as a number or element (defaults to 10 || document.body)</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="update"></a>
|
|
<div class="mdetail alt">
|
|
<h3>update</i></h3>
|
|
<code>public function update(<code>String html</code>, <span class="optional" title="Optional">[<code>Boolean loadScripts</code>]</span>, <code>Function callback</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Update the innerHTML of this element, optionally searching for and processing scripts
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<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</div></li><li><code>callback</code> : Function<div class="sub-desc">For async script loading you can be noticed when the update completes</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="wrap"></a>
|
|
<div class="mdetail">
|
|
<h3>wrap</i></h3>
|
|
<code>public function wrap(<span class="optional" title="Optional">[<code>Object config</code>]</span>, <span class="optional" title="Optional">[<code>Boolean returnDom</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Creates and wraps this element with another element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<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>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>/HTMLElementElement</code><div class="sub-desc">The newly created wrapper element</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
<hr>
|
|
<div style="font-size:10px;text-align:center;color:gray;">Ext - Copyright © 2006-2007 Ext JS, LLC<br />All rights reserved.</div>
|
|
|
|
</body>
|
|
</html> |