element-api-ext

Properties Methods Events Direct Link

Class Ext.Element

Package:	Ext
Defined In:	Element.js
Class:	Element
Subclasses:	Layer
Extends:	Object

Represents an Element in the DOM.

Usage:

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

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

Animations
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. Note that the supported Element animation options are a subset of the Ext.Fx animation options specific to Fx effects. The Element animation 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

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:

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();
}

Composite (Collections of) Elements
For working with collections of Elements, see Ext.CompositeElement

Public Properties

Property		Defined By
	Element.DISPLAY : Number <static> Visibility mode constant - Use display to hide element	Element
	Element.VISIBILITY : Number <static> Visibility mode constant - 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
	originalDisplay : String The element's default display mode (defaults to "")	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:	Element
	Element.fly( String/HTMLElement el, [String named] ) : Element <static> Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a... <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. 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 "_internal") Returns: Element The shared Element object (or null if no matching element was found)	Element
	Element.get( Mixed el ) : Element <static> Static method to retrieve Ext.Element objects. This method does not retrieve Components. This method r... <static> Static method to retrieve 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 {@link Ext.Element Element} object (or null if no matching element was found)	Element
	addClass( 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
	addClassOnClick( String className ) : Ext.Element 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) 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) Parameters: className : String Returns: Ext.Element this	Element
	addClassOnFocus( String className ) : Ext.Element Sets up event handlers to add and remove a css class when this element has the focus Sets up event handlers to add and remove a css class when this element has the focus Parameters: className : String Returns: Ext.Element this	Element
	addClassOnOver( String className ) : Ext.Element Sets up event handlers to add and remove a css class when the mouse is over this element Sets up event handlers to add and remove a css class when the mouse is over this element Parameters: className : String Returns: Ext.Element this	Element
	addKeyListener( Number/Array/Object/String key, Function fn, [Object scope] ) : Ext.KeyMap Convenience method for constructing a KeyMap Convenience method for constructing a KeyMap Parameters: key : Number/Array/Object/String 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)} fn : Function The function to call scope : Object (optional) The scope of the function Returns: Ext.KeyMap The KeyMap created	Element
	addKeyMap( Object config ) : Ext.KeyMap Creates a KeyMap for this element Creates a KeyMap for this element Parameters: config : Object The KeyMap config. See Ext.KeyMap for more details Returns: Ext.KeyMap The KeyMap created	Element
	addListener( String eventName, Function fn, [Object scope], [Object options] ) : void 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 type 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. t : Element The 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 (The this reference) of the handler function. 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 in which to execute the handler function. The handler function's "this" context. delegate {String} : A simple selector to filter the target or look for a descendant of the target 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 delay {Number} : The number of milliseconds to delay the invocation of the handler after te 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 normalized, 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('click', this.onClick, this, { single: true, delay: 100, stopEvent : true, forumId: 4 }); 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({ 'click' : { fn: this.onClick, scope: this, delay: 100 }, 'mouseover' : { fn: this.onMouseOver, scope: this }, 'mouseout' : { fn: this.onMouseOut, scope: this } }); Or a shorthand syntax: Code: el.on({ 'click' : this.onClick, 'mouseover' : this.onMouseOver, 'mouseout' : this.onMouseOut, scope: this }); Returns: void	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 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
	animate( Object args, [Float duration], [Function onComplete], [String easing], [String animType] ) : Ext.Element Perform animation on this element. Perform animation on this element. Parameters: args : Object The animation control args duration : Float (optional) How long the animation lasts in seconds (defaults to .35) onComplete : Function (optional) Function to call when animation completes easing : String (optional) Easing method to use (defaults to 'easeOut') animType : String (optional) 'run' is the default. Can also be 'color', 'motion', or 'scroll' 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/Object/Function styles ) : Ext.Element More flexible version of setStyle for setting style properties. More flexible version of setStyle for setting style properties. Parameters: 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: Ext.Element this	Element
	autoHeight( [Boolean animate], [Float duration], [Function onComplete], [String easing] ) : Ext.Element Measures the element's content height and updates height to match. Note: this function uses setTimeout so the new hei... Measures the element's content height and updates height to match. Note: this function uses setTimeout so the new height may not be available immediately. Parameters: animate : Boolean (optional) Animate the transition (defaults to false) duration : Float (optional) Length of the animation in seconds (defaults to .35) onComplete : Function (optional) Function to call when animation completes easing : String (optional) Easing method to use (defaults to easeOut) Returns: Ext.Element this	Element
	blur() : Ext.Element Tries to blur the element. Any exceptions are caught and ignored. Tries to blur the element. Any exceptions are caught and ignored. Parameters: None. Returns: Ext.Element this	Element
	boxWrap( [String class] ) : Ext.Element Wraps the specified element with a special markup/CSS block that renders by default as a gray container with a gradie... Wraps the specified element with a special markup/CSS block that renders by default as a gray container with a gradient background, rounded corners and a 4-way shadow. Example usage: // Basic box wrap Ext.get("foo").boxWrap(); // You can also add a custom class and use CSS inheritance rules to customize the box look. // 'x-box-blue' is a built-in alternative -- look at the related CSS definitions as an example // for how to create a custom box wrap style. Ext.get("foo").boxWrap().addClass("x-box-blue"); Parameters: class : String (optional) A base CSS class to apply to the containing wrapper element (defaults to 'x-box'). Note that there are a number of CSS rules that are dependent on this name to make the overall effect work, so if you supply an alternate base class, make sure you also supply all of the necessary rules. Returns: Ext.Element this	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 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
	clean( [Boolean forceReclean] ) : void Removes worthless text nodes Removes worthless text nodes Parameters: forceReclean : Boolean (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. Returns: void	Element
	clearOpacity() : Ext.Element Clears any opacity settings from this element. Required in some cases for IE. Clears any opacity settings from this element. Required in some cases for IE. Parameters: None. Returns: Ext.Element this	Element
	clearPositioning( [String value] ) : Ext.Element Clear positioning back to the default when the document was loaded Clear positioning back to the default when the document was loaded Parameters: value : String (optional) The value to use for the left,right,top,bottom, defaults to '' (empty string). You could use 'auto'. Returns: Ext.Element this	Element
	clip() : Ext.Element Store the current overflow setting and clip overflow on the element - use unclip to remove Store the current overflow setting and clip overflow on the element - use unclip to remove Parameters: None. Returns: Ext.Element this	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
	createProxy( String/Object config, [String/HTMLElement renderTo], [Boolean matchBox] ) : Ext.Element Creates a proxy element of this element Creates a proxy element of this element Parameters: config : String/Object The class name of the proxy element or a DomHelper config object renderTo : String/HTMLElement (optional) The element or element id to render the proxy to (defaults to document.body) matchBox : Boolean (optional) True to align and size the proxy to this element now (defaults to false) Returns: Ext.Element The new proxy element	Element
	createShim() : Ext.Element Creates an iframe shim for this element to keep selects and other windowed objects from showing through. Creates an iframe shim for this element to keep selects and other windowed objects from showing through. Parameters: None. Returns: Ext.Element The new shim element	Element
	down( 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
	enableDisplayMode( [String display] ) : Ext.Element Convenience method for setVisibilityMode(Element.DISPLAY) Convenience method for setVisibilityMode(Element.DISPLAY) Parameters: display : String (optional) What to set display to when visible Returns: Ext.Element this	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 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
	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
	focus() : Ext.Element Tries to focus the element. Any exceptions are caught and ignored. Tries to focus the element. Any exceptions are caught and ignored. Parameters: None. Returns: Ext.Element this	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 The position to align to. offsets : Array (optional) Offset the positioning by [x, y] Returns: Array [x, y]	Element
	getAnchorXY( [String anchor], [Boolean local], [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. local : Boolean (optional) True to get the local (element top/left-relative) anchor position instead of page coordinates 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
	getAttributeNS( String namespace, String name ) : String Returns the value of a namespaced attribute from the element's underlying DOM node. Returns the value of a namespaced attribute from the element's underlying DOM node. Parameters: namespace : String The namespace in which to look for the attribute name : String The attribute name 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 (l)eft width + the border (r)ight 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 a box {x, y, width, height} that can be used to set another elements size/location to match this element. Return a box {x, y, width, height} that can be used to set another elements 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 {x, y, width, height}	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
	getColor( String attr, String defaultValue, [String prefix] ) : void Return the CSS color for the specified CSS attribute. rgb, 3 digit (like #fff) and valid values are convert to standa... 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. Parameters: attr : String The css attribute defaultValue : String The default value to use when a valid color isn't found prefix : String (optional) defaults to #. Use an empty string when working with color anims. Returns: void	Element
	getComputedHeight() : Number Returns either the offsetHeight or the height of this element based on CSS height adjusted by padding or borders when... 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. Parameters: None. Returns: Number	Element
	getComputedWidth() : Number Returns either the offsetWidth or the width of this element based on CSS width adjusted by padding or borders when ne... 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. Parameters: None. Returns: Number	Element
	getFrameWidth( String sides ) : Number Returns the sum width of the padding and borders for the passed "sides". See getBorderWidth() for more informati... Returns the sum width of the padding and borders for the passed "sides". See getBorderWidth() for more information about the sides. Parameters: sides : String Returns: Number	Element
	getHeight( [Boolean contentHeight] ) : Number Returns the offset height of the ele