Class Ext.Element

Package:	Ext
Defined In:	Element.traversal.js
Class:	Element
Extends:	Object

Encapsulates a DOM element, adding simple DOM manipulation facilities, normalizing for browser differences.

All instances of this class inherit the methods of Ext.Fx making visual effects easily available to all DOM elements.

Note that the events documented in this class are not Ext events, they encapsulate browser events. To access the underlying browser event, see Ext.EventObject.browserEvent. Some older browsers may not support the full range of events. Which events are supported is beyond the control of ExtJs.

Usage:

// by id
var el = Ext.get("my-div");

// by DOM element reference
var el = Ext.get(myDivElement);

Animations

When an element is manipulated, by default there is no animation.

var el = Ext.get("my-div");

// no animation
el.setWidth(100);

Many of the functions for manipulating an element have an optional "animate" parameter. This parameter can be specified as boolean (true) for default animation effects.

// default animation
el.setWidth(100, true);

To configure the effects, an object literal with animation options to use as the Element animation configuration object can also be specified. Note that the supported Element animation configuration options are a subset of the Ext.Fx animation options specific to Fx effects. The supported Element animation configuration options are:

Option    Default   Description
--------- --------  ---------------------------------------------
duration  .35       The duration of the animation in seconds
easing    easeOut   The easing method
callback  none      A function to execute when the anim completes
scope     this      The scope (this) of the callback function

// Element animation options object
var opt = {
    duration: 1,
    easing: 'elasticIn',
    callback: this.foo,
    scope: this
};
// animation with some options set
el.setWidth(100, opt);

The Element animation object being used for the animation will be set on the options object as "anim", which allows you to stop or manipulate the animation. Here is an example:

// using the "anim" property to get the Anim object
if(opt.anim.isAnimated()){
    opt.anim.stop();
}

Also see the animate method for another animation technique.

Composite (Collections of) Elements

For working with collections of Elements, see Ext.CompositeElement

Public Properties

Property		Defined By
	DISPLAY : Number Visibility mode constant for use with setVisibilityMode. Use display to hide element	Element
	OFFSETS : Number Visibility mode constant for use with setVisibilityMode. Use offsets to hide element	Element
	VISIBILITY : Number Visibility mode constant for use with setVisibilityMode. Use visibility to hide element	Element
	defaultUnit : String The default unit to append to CSS values where a unit isn't provided (defaults to px).	Element
	dom : HTMLElement The DOM element	Element
	id : String The DOM element ID	Element

Public Methods

Method		Defined By
	Element( `String/HTMLElement element`, [`Boolean forceNew`] ) Create a new Element directly. Create a new Element directly. Parameters: `element` : String/HTMLElement `forceNew` : Boolean (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). Returns: void	Element
	addCls( `String/Array className` ) : Ext.Element Adds one or more CSS classes to the element. Duplicate classes are automatically filtered out. Adds one or more CSS classes to the element. Duplicate classes are automatically filtered out. Parameters: `className` : String/Array The CSS class to add, or an array of classes Returns: `Ext.Element` this	Element
	addListener( `String eventName`, `Function fn`, [`Object scope`], [`Object options`] ) : Ext.Element Appends an event handler to this element. The shorthand version on is equivalent. Appends an event handler to this element. The shorthand version on is equivalent. Parameters: `eventName` : String The name of event to handle. `fn` : Function The handler function the event invokes. This function is passed the following parameters: evt : EventObject The EventObject describing the event. el : HtmlElement The DOM element which was the target of the event. Note that this may be filtered by using the `delegate` option. o : Object The options object from the addListener call. `scope` : Object (optional) The scope (`this` reference) in which the handler function is executed. If omitted, defaults to this Element.. `options` : Object (optional) An object containing handler configuration properties. This may contain any of the following properties: scope Object : The scope (`this` reference) in which the handler function is executed. If omitted, defaults to this Element. delegate String: A simple selector to filter the target or look for a descendant of the target. See below for additional details. stopEvent Boolean: True to stop the event. That is stop propagation, and prevent the default action. preventDefault Boolean: True to prevent the default action stopPropagation Boolean: True to prevent event propagation normalized Boolean: False to pass a browser event to the handler function instead of an Ext.EventObject target Ext.Element: Only call the handler if the event was fired on the target Element, not if the event was bubbled up from a child node. delay Number: The number of milliseconds to delay the invocation of the handler after the event fires. single Boolean: True to add a handler to handle just the next firing of the event, and then remove itself. buffer Number: Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place. Combining Options In the following examples, the shorthand form on is used rather than the more verbose addListener. The two are equivalent. Using the options argument, it is possible to combine different types of listeners: A delayed, one-time listener that auto stops the event and adds a custom argument (forumId) to the options object. The options object is available as the third parameter in the handler function. Code: `el.on('tap', this.onTap, this, { single: true, delay: 100, stopEvent : true });` Attaching multiple handlers in 1 call The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers. Code: `el.on({ 'tap' : { fn: this.onTap, scope: this }, 'doubletap' : { fn: this.onDoubleTap, scope: this }, 'swipe' : { fn: this.onSwipe, scope: this } });` Or a shorthand syntax: Code: `el.on({ 'tap' : this.onTap, 'doubletap' : this.onDoubleTap, 'swipe' : this.onSwipe, scope: this });` delegate This is a configuration option that you can pass along when registering a handler for an event to assist with event delegation. Event delegation is a technique that is used to reduce memory consumption and prevent exposure to memory-leaks. By registering an event for a container element as opposed to each element within a container. By setting this configuration option to a simple selector, the target element will be filtered to look for a descendant of the target. For example: `// using this markup: <div id='elId'> <p id='p1'>paragraph one</p> <p id='p2' class='clickable'>paragraph two</p> <p id='p3'>paragraph three</p> </div> // utilize event delegation to registering just one handler on the container element: el = Ext.get('elId'); el.on( 'tap', function(e,t) { // handle click console.info(t.id); // 'p2' }, this, { // filter the target element to be a descendant with the class 'tappable' delegate: '.tappable' } );` Returns: `Ext.Element` this	Element
	alignTo( `Mixed element`, `String position`, [`Array offsets`], [`Boolean/Object animate`] ) : Ext.Element Aligns this element with another element relative to the specified anchor points. If the other element is the documen... 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: Blank: Defaults to aligning the element's top-left corner to the target's bottom-left corner ("tl-bl"). One anchor (deprecated): 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. This method has been deprecated in favor of the newer two anchor syntax below. Two anchors: 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. 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: 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 Example Usage: // 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]); Parameters: `element` : Mixed The element to align to. `position` : String (optional, defaults to "tl-bl?") The position to align to. `offsets` : Array (optional) Offset the positioning by [x, y] `animate` : Boolean/Object (optional) true for the default animation or a standard Element animation config object Returns: `Ext.Element` this	Element
	anchorTo( `Mixed element`, `String position`, [`Array offsets`], [`Boolean/Object animate`], [`Boolean/Number monitorScroll`], `Function callback` ) : Ext.Element Anchors an element to another element and realigns it when the window is resized. Anchors an element to another element and realigns it when the window is resized. Parameters: `element` : Mixed The element to align to. `position` : String The position to align to. `offsets` : Array (optional) Offset the positioning by [x, y] `animate` : Boolean/Object (optional) True for the default animation or a standard Element animation config object `monitorScroll` : Boolean/Number (optional) True to monitor body scroll and reposition. If this parameter is a number, it is used as the buffer delay (defaults to 50ms). `callback` : Function The function to call after the animation finishes Returns: `Ext.Element` this	Element
	appendChild( `String/HTMLElement/Array/Element/CompositeElement el` ) : Ext.Element Appends the passed element(s) to this element Appends the passed element(s) to this element Parameters: `el` : String/HTMLElement/Array/Element/CompositeElement Returns: `Ext.Element` this	Element
	appendTo( `Mixed el` ) : Ext.Element Appends this element to the passed element Appends this element to the passed element Parameters: `el` : Mixed The new parent element Returns: `Ext.Element` this	Element
	applyStyles( `String/HTMLElement el`, `String/Object/Function styles` ) : void Applies a style specification to an element. Applies a style specification to an element. Parameters: `el` : String/HTMLElement The element to apply styles to `styles` : String/Object/Function A style specification string e.g. 'width:100px', or object in the form {width:'100px'}, or a function which returns such a specification. Returns: void	Element
	center( [`Mixed centerIn`] ) : void // * Centers the Element in either the viewport, or another Element. // * // * Centers the Element in either the viewport, or another Element. // * Parameters: `centerIn` : Mixed (optional) The element in which to center the element. // Returns: void	Element
	child( `String selector`, [`Boolean returnDom`] ) : HTMLElement/Ext.Element Selects a single direct child based on the passed CSS selector (the selector should not contain an id). Selects a single direct child based on the passed CSS selector (the selector should not contain an id). Parameters: `selector` : String The CSS selector `returnDom` : Boolean (optional) True to return the DOM node instead of Ext.Element (defaults to false) Returns: `HTMLElement/Ext.Element` The child Ext.Element (or DOM node if returnDom = true)	Element
	contains( `HTMLElement/String el` ) : Boolean Returns true if this element is an ancestor of the passed element Returns true if this element is an ancestor of the passed element Parameters: `el` : HTMLElement/String The element to check Returns: `Boolean` True if this element is an ancestor of el, else false	Element
	createChild( `Object config`, [`HTMLElement insertBefore`], [`Boolean returnDom`] ) : Ext.Element Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child e... Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child element. Parameters: `config` : Object DomHelper element config object. If no tag is specified (e.g., {tag:'input'}) then a div will be automatically generated with the specified attributes. `insertBefore` : HTMLElement (optional) a child element of this element `returnDom` : Boolean (optional) true to return the dom node instead of creating an Element Returns: `Ext.Element` The new child element	Element
	cssTransform( `Ext.Element/Element el`, `Object transforms` ) : void Transform an element using CSS 3 Transform an element using CSS 3 Parameters: `el` : Ext.Element/Element the element `transforms` : Object an object with all transformation to be applied. The keys are transformation method names, the values are arrays of params or a single number if there's only one param e.g: { translate: [0, 1, 2], scale: 0.5, skew: -25, rotate: 7 } Returns: void	Element
	cssTranslate( `Ext.Element/Element el`, `Ext.util.Offset/Object offset` ) : void Translate an element using CSS 3 in 2D. This is supposed to be faster than cssTransform when we only need to translat... Translate an element using CSS 3 in 2D. This is supposed to be faster than cssTransform when we only need to translate an element without reserving its original matrix Parameters: `el` : Ext.Element/Element the element `offset` : Ext.util.Offset/Object The new offset with format { x: offsetX, y: offsetY } Returns: void	Element
	down( `String selector`, [`Boolean returnDom`] ) : HTMLElement/Ext.Element Selects a single child at any depth below this element based on the passed CSS selector (the selector should not cont... Selects a single child at any depth below this element based on the passed CSS selector (the selector should not contain an id). Parameters: `selector` : String The CSS selector `returnDom` : Boolean (optional) True to return the DOM node instead of Ext.Element (defaults to false) Returns: `HTMLElement/Ext.Element` The child Ext.Element (or DOM node if returnDom = true)	Element
	findParent( `String selector`, [`Number/Mixed maxDepth`], [`Boolean returnEl`] ) : HTMLElement 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... 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) Parameters: `selector` : String The simple selector to test `maxDepth` : Number/Mixed (optional) The max depth to search as a number or element (defaults to 50 \|\| document.body) `returnEl` : Boolean (optional) True to return a Ext.Element object instead of DOM node Returns: `HTMLElement` The matching DOM node (or null if no match was found)	Element
	findParentNode( `String selector`, [`Number/Mixed maxDepth`], [`Boolean returnEl`] ) : HTMLElement Looks at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child) Looks at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child) Parameters: `selector` : String The simple selector to test `maxDepth` : Number/Mixed (optional) The max depth to search as a number or element (defaults to 10 \|\| document.body) `returnEl` : Boolean (optional) True to return a Ext.Element object instead of DOM node Returns: `HTMLElement` The matching DOM node (or null if no match was found)	Element
	first( [`String selector`], [`Boolean returnDom`] ) : Ext.Element/HTMLElement Gets the first child, skipping text nodes Gets the first child, skipping text nodes Parameters: `selector` : String (optional) Find the next sibling that matches the passed simple selector `returnDom` : Boolean (optional) True to return a raw dom node instead of an Ext.Element Returns: `Ext.Element/HTMLElement` The first child or null	Element
	fly( `String/HTMLElement el`, [`String named`] ) : Element Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to t... 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. Shorthand of Ext.Element.fly Use this to make one-time references to DOM elements which are not going to be accessed again either by application code, or by Ext's classes. If accessing an element which will be processed regularly, then Ext.get will be more appropriate to take advantage of the caching provided by the Ext.Element class. Parameters: `el` : String/HTMLElement The dom node or id `named` : String (optional) Allows for creation of named reusable flyweights to prevent conflicts (e.g. internally Ext uses "_global") Returns: `Element` The shared Element object (or null if no matching element was found)	Element
	fromPoint( `Number x`, `Number x` ) : String Returns the top Element that is located at the passed coordinates Function description Returns the top Element that is located at the passed coordinates Function description Parameters: `x` : Number The x coordinate `x` : Number The y coordinate Returns: `String` The found Element	Element
	get( `Mixed el` ) : Element <static> Retrieves Ext.Element objects. This method does not retrieve Components. This method retrieves Ext.Element objects wh... <static> Retrieves Ext.Element objects. This method does not retrieve Components. This method retrieves Ext.Element objects which encapsulate DOM elements. To retrieve a Component by its ID, use Ext.ComponentMgr.get. Uses simple caching to consistently return the same object. Automatically fixes if an object was recreated with the same id via AJAX or DOM. Parameters: `el` : Mixed The id of the node, a DOM Node or an existing Element. Returns: `Element` The Element object (or null if no matching element was found)	Element
	getAlignToXY( `Mixed element`, `String position`, [`Array offsets`] ) : Array Gets the x,y coordinates to align this element with another element. See alignTo for more info on the supported posit... Gets the x,y coordinates to align this element with another element. See alignTo for more info on the supported position values. Parameters: `element` : Mixed The element to align to. `position` : String (optional, defaults to "tl-bl?") The position to align to. `offsets` : Array (optional) Offset the positioning by [x, y] Returns: `Array` [x, y]	Element
	getAnchorXY( [`String anchor`], [`Object size`] ) : Array Gets the x,y coordinates specified by the anchor position on the element. Gets the x,y coordinates specified by the anchor position on the element. Parameters: `anchor` : String (optional) The specified anchor position (defaults to "c"). See alignTo for details on supported anchor positions. `size` : Object (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) Returns: `Array` [x, y] An array containing the element's x and y coordinates	Element
	getAttribute( `String name`, [`String namespace`] ) : String Returns the value of an attribute from the element's underlying DOM node. Returns the value of an attribute from the element's underlying DOM node. Parameters: `name` : String The attribute name `namespace` : String (optional) The namespace in which to look for the attribute Returns: `String` The attribute value	Element
	getBorderWidth( `String side` ) : Number Gets the width of the border(s) for the specified side(s) Gets the width of the border(s) for the specified side(s) Parameters: `side` : String Can be t, l, r, b or any combination of those to add multiple values. For example, passing `'lr'` would get the border left width + the border right width. Returns: `Number` The width of the sides passed added together	Element
	getBottom( `Boolean local` ) : Number Gets the bottom Y coordinate of the element (element Y position + element height) Gets the bottom Y coordinate of the element (element Y position + element height) Parameters: `local` : Boolean True to get the local css position instead of page coordinate Returns: `Number`	Element
	getBox( [`Boolean contentBox`], [`Boolean local`] ) : Object Return an object defining the area of this Element which can be passed to setBox to set another Element's size/locati... Return an object defining the area of this Element which can be passed to setBox to set another Element's size/location to match this element. Parameters: `contentBox` : Boolean (optional) If true a box for the content of the element is returned. `local` : Boolean (optional) If true the element's left and top are returned instead of page x/y. Returns: `Object` box An object in the format<pre><code> { x: <Element's X position>, y: <Element's Y position>, width: <Element's width>, height: <Element's height>, bottom: <Element's lower bound>, right: <Element's rightmost bound> } </code></pre> The returned object may also be addressed as an Array where index 0 contains the X position and index 1 contains the Y position. So the result may also be used for {@link #setXY}	Element
	getCenterXY() : Array // * Calculates the x, y to center this element on the screen // * // * Calculates the x, y to center this element on the screen // * Parameters: None. Returns: `Array` The x, y values [x, y] //	Element
	getComputedTransformOffset( `Ext.Element/Element el` ) : Ext.util.Offset Returns the calculated CSS 2D transform offset values (translate x and y) Returns the calculated CSS 2D transform offset values (translate x and y) Parameters: `el` : Ext.Element/Element the element Returns: `Ext.util.Offset` instance of Ext.util.Offset, with x and y properties	Element
	getDocumentHeight() : void Retrieves the document height Retrieves the document height Parameters: None. Returns: void	Element
	getDocumentWidth() : void Retrieves the document width Retrieves the document width Parameters: None. Returns: void	Element
	getHTML() : void Returns the innerHTML of an Element or an empty string if the element's dom no longer exists. Returns the innerHTML of an Element or an empty string if the element's dom no longer exists. Parameters: None. Returns: void	Element
	getHeight( [`Boolean contentHeight`] ) : Number Returns the offset height of the element Returns the offset height of the element Parameters: `contentHeight` : Boolean (optional) true to get the height minus borders and padding Returns: `Number` The element's height	Element
	getLeft( `Boolean local` ) : Number Gets the left X coordinate Gets the left X coordinate Parameters: `local` : Boolean True to get the local css position instead of page coordinate Returns: `Number`	Element
	getMargin( `String side` ) : Number Gets the size of the margins(s) for the specified side(s) Gets the size of the margins(s) for the specified side(s) Parameters: `side` : String Can be t, l, r, b or any combination of those to add multiple values. For example, passing `'lr'` would get the margin left + the margin right. Returns: `Number` The margin of the sides passed added together	Element
	getOffsetsTo( `Mixed element` ) : Array Returns the offsets of this element from the passed element. Both element must be part of the DOM tree and not have d... Returns the offsets of this element from the passed element. Both element must be part of the DOM tree and not have display:none to have page coordinates. Parameters: `element` : Mixed The element to get the offsets from. Returns: `Array` The XY page offsets (e.g. [100, -200])	Element
	getOrientation() : void Retrieves the current orientation of the window. This is calculated by determing if the height is greater than the wi... Retrieves the current orientation of the window. This is calculated by determing if the height is greater than the width. Parameters: None. Returns: void	Element
	getOuterHeight() : void Retrieves the height of the element account for the top and bottom margins. Retrieves the height of the element account for the top and bottom margins. Parameters: None. Returns: void	Element
	getOuterWidth() : void Retrieves the width of the element accounting for the left and right margins. Retrieves the width of the element accounting for the left and right margins. Parameters: None. Returns: void	Element
	getPadding( `String side` ) : Number Gets the size of the padding(s) for the specified side(s) Gets the size of the padding(s) for the specified side(s) Parameters: `side` : String Can be t, l, r, b or any combination of those to add multiple values. For example, passing `'lr'` would get the padding left + the padding right. Returns: `Number` The padding of the sides passed added together	Element
	getPageBox( `Boolean asRegion(optional)` ) : Object Return an object defining the area of this Element which can be passed to setBox to set another Element's size/locati... Return an object defining the area of this Element which can be passed to setBox to set another Element's size/location to match this element. Parameters: `asRegion(optional)` : Boolean If true an Ext.util.Region will be returned Returns: `Object` box An object in the format<pre><code> { x: <Element's X position>, y: <Element's Y position>, width: <Element's width>, height: <Element's height>, bottom: <Element's lower bound>, right: <Element's rightmost bound> } </code></pre> The returned object may also be addressed as an Array where index 0 contains the X position and index 1 contains the Y position. So the result may also be used for {@link #setXY}	Element
	getRight( `Boolean local` ) : Number Gets the right X coordinate of the element (element X position + element width) Gets the right X coordinate of the element (element X position + element width) Parameters: `local` : Boolean True to get the local css position instead of page coordinate Returns: `Number`	Element
	getScrollParent() : Ext.util.Scroller/null Gets the Scroller instance of the first parent that has one. Gets the Scroller instance of the first parent that has one. Parameters: None. Returns: `Ext.util.Scroller/null` The first parent scroller	Element
	getSize( [`Boolean contentSize`] ) : Object Returns the size of the element. Returns the size of the element. Parameters: `contentSize` : Boolean (optional) true to get the width/size minus borders and padding Returns: `Object` An object containing the element's size {width: (element width), height: (element height)}	Element
	getStyle( `String property` ) : String Normalizes currentStyle and computedStyle. Normalizes currentStyle and computedStyle. Parameters: `property` : String The style property whose value is returned. Returns: `String` The current value of the style property for this element.	Element
	getTop( `Boolean local` ) : Number Gets the top Y coordinate Gets the top Y coordinate Parameters: `local` : Boolean True to get the local css position instead of page coordinate Returns: `Number`	Element
	getValue( `Boolean asNumber` ) : String/Number Returns the value of the "value" attribute Returns the value of the "value" attribute Parameters: `asNumber` : Boolean true to parse the value as a number Returns: `String/Number`	Element
	getViewSize() : void Returns the dimensions of the element available to lay content out in. If the element (or any ancestor element) has C... Returns the dimensions of the element available to lay content out in. If the element (or any ancestor element) has CSS style `display : none`, the dimensions will be zero. Parameters: None. Returns: void	Element
	getViewportHeight() : void Retrieves the viewport height of the window. Retrieves the viewport height of the window. Parameters: None. Returns: void	Element
	getViewportWidth() : void Retrieves the viewport width of the window. Retrieves the viewport width of the window. Parameters: None. Returns: void	Element
	getWidth( [`Boolean contentWidth`] ) : Number Returns the offset width of the element Returns the offset width of the element Parameters: `contentWidth` : Boolean (optional) true to get the width minus borders and padding Returns: `Number` The element's width	Element
	getX() : Number Gets the current X position of the element based on page coordinates. Element must be part of the DOM tree to have p... 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). Parameters: None. Returns: `Number` The X position of the element	Element
	getXY() : Array Gets the current position of the element based on page coordinates. Element must be part of the DOM tree to have pag... 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). Parameters: None. Returns: `Array` The XY position of the element	Element
	getY() : Number Gets the current Y position of the element based on page coordinates. Element must be part of the DOM tree to have p... 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). Parameters: None. Returns: `Number` The Y position of the element	Element
	hasCls( `String className` ) : Boolean Checks if the specified CSS class exists on this element's DOM node. Checks if the specified CSS class exists on this element's DOM node. Parameters: `className` : String The CSS class to check for Returns: `Boolean` True if the class exists, else false	Element
	hide( [`Boolean/Object animate`] ) : Ext.Element Hide this element - Uses display mode to determine whether to use "display" or "visibility". See setVisible. Hide this element - Uses display mode to determine whether to use "display" or "visibility". See setVisible. Parameters: `animate` : Boolean/Object (optional) true for the default animation or a standard Element animation config object Returns: `Ext.Element` this	Element
	insertAfter( `Mixed el` ) : Ext.Element Inserts this element after the passed element in the DOM Inserts this element after the passed element in the DOM Parameters: `el` : Mixed The element to insert after Returns: `Ext.Element` this	Element
	insertBefore( `Mixed el` ) : Ext.Element Inserts this element before the passed element in the DOM Inserts this element before the passed element in the DOM Parameters: `el` : Mixed The element before which this element will be inserted Returns: `Ext.Element` this	Element
	insertFirst( `Mixed/Object el` ) : Ext.Element Inserts (or creates) an element (or DomHelper config) as the first child of this element Inserts (or creates) an element (or DomHelper config) as the first child of this element Parameters: `el` : Mixed/Object The id or element to insert or a DomHelper config to create and insert Returns: `Ext.Element` The new child	Element
	insertHtml( `String where`, `String html`, [`Boolean returnEl`] ) : HTMLElement/Ext.Element Inserts an html fragment into this element Inserts an html fragment into this element Parameters: `where` : String Where to insert the html in relation to this element - beforeBegin, afterBegin, beforeEnd, afterEnd. `html` : String The HTML fragment `returnEl` : Boolean (optional) True to return an Ext.Element (defaults to false) Returns: `HTMLElement/Ext.Element` The inserted node (or nearest related if more than 1 inserted)	Element
	insertSibling( `Mixed/Object/Array el`, [`String where`], [`Boolean returnDom`] ) : Ext.Element Inserts (or creates) the passed element (or DomHelper config) as a sibling of this element Inserts (or creates) the passed element (or DomHelper config) as a sibling of this element Parameters: `el` : Mixed/Object/Array The id, element to insert or a DomHelper config to create and insert or an array of any of those. `where` : String (optional) 'before' or 'after' defaults to before `returnDom` : Boolean (optional) True to return the .;ll;l,raw DOM element instead of Ext.Element Returns: `Ext.Element` The inserted Element. If an array is passed, the last inserted element is returned.	Element
	is( `String selector` ) : Boolean Returns true if this element matches the passed simple selector (e.g. div.some-class or span:first-child) Returns true if this element matches the passed simple selector (e.g. div.some-class or span:first-child) Parameters: `selector` : String The simple selector to test Returns: `Boolean` True if this element matches the selector, else false	Element
	isDescendent( `Mixed element` ) : void Determines if this element is a descendent of the passed in Element. Determines if this element is a descendent of the passed in Element. Parameters: `element` : Mixed An Ext.Element, HTMLElement or string linking to an id of an Element. Returns: void	Element
	isHorizontal() : Boolean Method to determine whether this Sortable is currently sorting. Method to determine whether this Sortable is currently sorting. Parameters: None. Returns: `Boolean` the sorting state of this Sortable.	Element
	isVertical() : Boolean Method to determine whether this Sortable is currently disabled. Method to determine whether this Sortable is currently disabled. Parameters: None. Returns: `Boolean` the disabled state of this Sortable.	Element
	last( [`String selector`], [`Boolean returnDom`] ) : Ext.Element/HTMLElement Gets the last child, skipping text nodes Gets the last child, skipping text nodes Parameters: `selector` : String (optional) Find the previous sibling that matches the passed simple selector `returnDom` : Boolean (optional) True to return a raw dom node instead of an Ext.Element Returns: `Ext.Element/HTMLElement` The last child or null	Element
	mask( [`String msg`], [`String msgCls`], [`Boolean transparent`] ) : Element Puts a mask over this element to disable user interaction. This method can only be applied to elements which accept c... Puts a mask over this element to disable user interaction. This method can only be applied to elements which accept child nodes. Parameters: `msg` : String (optional) A message to display in the mask. This can be html. `msgCls` : String (optional) A css class to apply to the msg element `transparent` : Boolean (optional) False to show make the mask gray with opacity. (defaults to true) Returns: `Element` The mask element	Element
	next( [`String selector`], [`Boolean returnDom`] ) : Ext.Element/HTMLElement Gets the next sibling, skipping text nodes Gets the next sibling, skipping text nodes Parameters: `selector` : String (optional) Find the next sibling that matches the passed simple selector `returnDom` : Boolean (optional) True to return a raw dom node instead of an Ext.Element Returns: `Ext.Element/HTMLElement` The next sibling or null	Element
	normalize() : void Normalizes CSS property keys from dash delimited to camel case JavaScript Syntax. For example: border-width -> borde... Normalizes CSS property keys from dash delimited to camel case JavaScript Syntax. For example: border-width -> borderWidth padding-top -> paddingTop Parameters: None. Returns: void	Element
	parent( [`String selector`], [`Boolean returnDom`] ) : Ext.Element/HTMLElement Gets the parent node for this element, optionally chaining up trying to match a selector Gets the parent node for this element, optionally chaining up trying to match a selector Parameters: `selector` : String (optional) Find a parent node that matches the passed simple selector `returnDom` : Boolean (optional) True to return a raw dom node instead of an Ext.Element Returns: `Ext.Element/HTMLElement` The parent node or null	Element
	parseBox( `Number\|String box` ) : Object Parses a number or string representing margin sizes into an object. Supports CSS-style margin declarations (e.g. 10, ... Parses a number or string representing margin sizes into an object. Supports CSS-style margin declarations (e.g. 10, "10", "10 10", "10 10 10" and "10 10 10 10" are all valid options and would return the same result) Parameters: `box` : Number\|String The encoded margins Returns: `Object` An object with margin sizes for top, right, bottom and left	Element
	prev( [`String selector`], [`Boolean returnDom`] ) : Ext.Element/HTMLElement Gets the previous sibling, skipping text nodes Gets the previous sibling, skipping text nodes Parameters: `selector` : String (optional) Find the previous sibling that matches the passed simple selector `returnDom` : Boolean (optional) True to return a raw dom node instead of an Ext.Element Returns: `Ext.Element/HTMLElement` The previous sibling or null	Element
	purgeAllListeners() : Ext.Element Recursively removes all previous added listeners from this element and its children Recursively removes all previous added listeners from this element and its children Parameters: None. Returns: `Ext.Element` this	Element
	query( `String selector` ) : Array Selects child nodes based on the passed CSS selector (the selector should not contain an id). Selects child nodes based on the passed CSS selector (the selector should not contain an id). Parameters: `selector` : String The CSS selector Returns: `Array` An array of the matched nodes	Element
	radioCls( `String/Array className` ) : Ext.Element Adds one or more CSS classes to this element and removes the same class(es) from all siblings. Adds one or more CSS classes to this element and removes the same class(es) from all siblings. Parameters: `className` : String/Array The CSS class to add, or an array of classes Returns: `Ext.Element` this	Element
	remove() : void Removes this element's dom reference. Note that event and cache removal is handled at Ext.removeNode Removes this element's dom reference. Note that event and cache removal is handled at Ext.removeNode Parameters: None. Returns: void	Element
	removeAllListeners() : Ext.Element Removes all previous added listeners from this element Removes all previous added listeners from this element Parameters: None. Returns: `Ext.Element` this	Element
	removeAnchor() : Ext.Element Remove any anchor to this element. See anchorTo. Remove any anchor to this element. See anchorTo. Parameters: None. Returns: `Ext.Element` this	Element
	removeCls( `String/Array className` ) : Ext.Element Removes one or more CSS classes from the element. Removes one or more CSS classes from the element. Parameters: `className` : String/Array The CSS class to remove, or an array of classes Returns: `Ext.Element` this	Element
	removeListener( `String eventName`, `Function fn`, `Object scope` ) : Ext.Element Removes an event handler from this element. The shorthand version un is equivalent. Note: if a scope was explicitly ... Removes an event handler from this element. The shorthand version un is equivalent. Note: if a scope was explicitly specified when adding the listener, the same scope must be specified here. Example: `el.removeListener('tap', this.handlerFn); // or el.un('tap', this.handlerFn);` Parameters: `eventName` : String The name of the event from which to remove the handler. `fn` : Function The handler function to remove. This must be a reference to the function passed into the addListener call. `scope` : Object If a scope (`this` reference) was specified when the listener was added, then this must refer to the same object. Returns: `Ext.Element` this	Element
	repaint() : Ext.Element Forces the browser to repaint this element Forces the browser to repaint this element Parameters: None. Returns: `Ext.Element` this	Element
	replace( `Mixed el` ) : Ext.Element Replaces the passed element with this element Replaces the passed element with this element Parameters: `el` : Mixed The element to replace Returns: `Ext.Element` this	Element
	replaceCls( `String oldClassName`, `String newClassName` ) : Ext.Element Replaces a CSS class on the element with another. If the old name does not exist, the new name will simply be added. Replaces a CSS class on the element with another. If the old name does not exist, the new name will simply be added. Parameters: `oldClassName` : String The CSS class to replace `newClassName` : String The replacement CSS class Returns: `Ext.Element` this	Element
	replaceWith( `Mixed/Object el` ) : Ext.Element Replaces this element with the passed element Replaces this element with the passed element Parameters: `el` : Mixed/Object The new element or a DomHelper config of an element to create Returns: `Ext.Element` this	Element
	select( `String/Array selector`, [`HTMLElement/String root`] ) : CompositeElement Selects elements based on the passed CSS selector to enable Element methods to be applied to many related elements in... Selects elements based on the passed CSS selector to enable Element methods to be applied to many related elements in one statement through the returned CompositeElement or CompositeElement object. Parameters: `selector` : String/Array The CSS selector or an array of elements `root` : HTMLElement/String (optional) The root element of the query or id of the root Returns: `CompositeElement`	Element
	set( `Object o`, [`Boolean useSet`] ) : Ext.Element Sets the passed attributes as attributes of this element (a style attribute can be a string, object or function) Sets the passed attributes as attributes of this element (a style attribute can be a string, object or function) Parameters: `o` : Object The object with the attributes `useSet` : Boolean (optional) false to override the default setAttribute to use expandos. Returns: `Ext.Element` this	Element
	setBottom( `String bottom` ) : Ext.Element Sets the element's CSS bottom style. Sets the element's CSS bottom style. Parameters: `bottom` : String The bottom CSS property value Returns: `Ext.Element` this	Element
	setBox( `Object box` ) : Ext.Element Sets the element's box. Use getBox() on another element to get a box obj. If animate is true then width, height, x an... 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. Parameters: `box` : Object The box to fill {x, y, width, height} Returns: `Ext.Element` this	Element
	setHTML( `String html` ) : Ext.Element Set the innerHTML of this element Set the innerHTML of this element Parameters: `html` : String The new HTML Returns: `Ext.Element` this	Element
	setHeight( `Mixed height` ) : Ext.Element Set the height of this Element. // change the height to 200px and animate with default configuration Ext.fly(... Set the height of this Element. `// change the height to 200px and animate with default configuration Ext.fly('elementId').setHeight(200, true); // change the height to 150px and animate with a custom configuration Ext.fly('elId').setHeight(150, { duration : .5, // animation will have a duration of .5 seconds // will change the content to "finished" callback: function(){ this.update("finished"); } });` Parameters: `height` : Mixed The new height. This may be one of: A Number specifying the new height in this Element's defaultUnits (by default, pixels.) A String used to set the CSS height style. Animation may not be used. Returns: `Ext.Element` this	Element
	setLeft( `String left` ) : Ext.Element Sets the element's left position directly using CSS style (instead of setX). Sets the element's left position directly using CSS style (instead of setX). Parameters: `left` : String The left CSS property value Returns: `Ext.Element` this	Element
	setRight( `String right` ) : Ext.Element Sets the element's CSS right style. Sets the element's CSS right style. Parameters: `right` : String The right CSS property value Returns: `Ext.Element` this	Element
	setSize( `Mixed width`, `Mixed height`, [`Boolean/Object animate`] ) : Ext.Element Set the size of this Element. If animation is true, both width and height will be animated concurrently. Set the size of this Element. If animation is true, both width and height will be animated concurrently. Parameters: `width` : Mixed The new width. This may be one of: A Number specifying the new width in this Element's defaultUnits (by default, pixels). A String used to set the CSS width style. Animation may not be used. A size object in the format `{width: widthValue, height: heightValue}`. `height` : Mixed The new height. This may be one of: A Number specifying the new height in this Element's defaultUnits (by default, pixels). A String used to set the CSS height style. Animation may not be used. `animate` : Boolean/Object (optional) true for the default animation or a standard Element animation config object Returns: `Ext.Element` this	Element
	setStyle( `String/Object property`, [`String value`] ) : Ext.Element Wrapper for setting style properties, also takes single object parameter of multiple styles. Wrapper for setting style properties, also takes single object parameter of multiple styles. Parameters: `property` : String/Object The style property to be set, or an object of multiple styles. `value` : String (optional) The value to apply to the given property, or null if an object was passed. Returns: `Ext.Element` this	Element
	setTop( `String top` ) : Ext.Element Sets the element's top position directly using CSS style (instead of setY). Sets the element's top position directly using CSS style (instead of setY). Parameters: `top` : String The top CSS property value Returns: `Ext.Element` this	Element
	setTopLeft( `String top`, `String left` ) : void Sets the element's top and left positions directly using CSS style (instead of setXY) Sets the element's top and left positions directly using CSS style (instead of setXY) Parameters: `top` : String The top CSS property value `left` : String The left CSS property value Returns: void	Element
	setVisible( `Boolean visible`, [`Boolean/Object animate`] ) : Ext.Element Sets the visibility of the element (see details). If the visibilityMode is set to Element.DISPLAY, it will use the di... 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. Parameters: `visible` : Boolean Whether the element is visible `animate` : Boolean/Object (optional) True for the default animation, or a standard Element animation config object Returns: `Ext.Element` this	Element
	setWidth( `Mixed width` ) : Ext.Element Set the width of this Element. Set the width of this Element. Parameters: `width` : Mixed The new width. This may be one of: A Number specifying the new width in this Element's defaultUnits (by default, pixels). A String used to set the CSS width style. Animation may not be used. Returns: `Ext.Element` this	Element
	setX( `Number The` ) : Ext.Element Sets the X position of the element based on page coordinates. Element must be part of the DOM tree to have page coor... 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). Parameters: `The` : Number X position of the element Returns: `Ext.Element` this	Element
	setXY( `Array pos` ) : Ext.Element Sets the position of the element in page coordinates, regardless of how the element is positioned. The element must b... Sets the position of the element in page coordinates, regardless of how the element is positioned. The element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false). Parameters: `pos` : Array Contains X & Y [x, y] values for new position (coordinates are page-based) Returns: `Ext.Element` this	Element
	setY( `Number The`, [`Boolean/Object animate`] ) : Ext.Element Sets the Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coor... 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). Parameters: `The` : Number Y position of the element `animate` : Boolean/Object (optional) True for the default animation, or a standard Element animation config object Returns: `Ext.Element` this	Element
	show( [`Boolean/Object animate`] ) : Ext.Element Show this element - Uses display mode to determine whether to use "display" or "visibility". See setVisible. Show this element - Uses display mode to determine whether to use "display" or "visibility". See setVisible. Parameters: `animate` : Boolean/Object (optional) true for the default animation or a standard Element animation config object Returns: `Ext.Element` this	Element
	toggleCls( `String className` ) : Ext.Element Toggles the specified CSS class on this element (removes it if it already exists, otherwise adds it). Toggles the specified CSS class on this element (removes it if it already exists, otherwise adds it). Parameters: `className` : String The CSS class to toggle Returns: `Ext.Element` this	Element
	translatePoints( `Number/Array x`, [`Number y`] ) : Object Translates the passed page coordinates into left/top css values for this element Translates the passed page coordinates into left/top css values for this element Parameters: `x` : Number/Array The page x or an array containing [x, y] `y` : Number (optional) The page y, required if x is not an array Returns: `Object` An object with left and top properties. e.g. {left: (value), top: (value)}	Element
	unitizeBox( `Number\|String box` ) : String Parses a number or string representing margin sizes into an object. Supports CSS-style margin declarations (e.g. 10, ... Parses a number or string representing margin sizes into an object. Supports CSS-style margin declarations (e.g. 10, "10", "10 10", "10 10 10" and "10 10 10 10" are all valid options and would return the same result) Parameters: `box` : Number\|String The encoded margins Returns: `String` An string with unitized (px) metrics for top, right, bottom and left	Element
	unmask() : void Removes a previously applied mask. Removes a previously applied mask. Parameters: None. Returns: void	Element
	up( `String selector`, [`Number/Mixed maxDepth`] ) : Ext.Element Walks up the dom looking for a parent node that matches the passed simple selector (e.g. div.some-class or span:first... 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. Parameters: `selector` : String The simple selector to test `maxDepth` : Number/Mixed (optional) The max depth to search as a number or element (defaults to 10 \|\| document.body) Returns: `Ext.Element` The matching DOM node (or null if no match was found)	Element
	wrap( [`Object config`], [`Boolean returnDom`] ) : HTMLElement/Element Creates and wraps this element with another element Creates and wraps this element with another element Parameters: `config` : Object (optional) DomHelper element config object for the wrapper element or null for an empty div `returnDom` : Boolean (optional) True to return the raw DOM element instead of Ext.Element Returns: `HTMLElement/Element` The newly created wrapper element	Element

Public Events

This class has no public events.