Alternate names
Ext.Element
Ext.core.Element
Hierarchy
Ext.BaseExt.dom.AbstractElementExt.dom.Element
Subclasses
Ext.Layer
Files
Element.js
Element.alignment.js
Element.anim.js
Element.dd.js
Element.fx.js
Element.position.js
Element.scroll.js
Element.style.js
Element.traversal.js

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

\n\n

All instances of this class inherit the methods of Ext.fx.Anim making visual effects easily available to all\nDOM elements.

\n\n

Note that the events documented in this class are not Ext events, they encapsulate browser events. Some older browsers\nmay not support the full range of events. Which events are supported is beyond the control of Ext JS.

\n\n

Usage:

\n\n

// by id\nvar el = Ext.get(\"my-div\");\n\n// by DOM element reference\nvar el = Ext.get(myDivElement);\n

\n\n

Animations

\n\n

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

\n\n

var el = Ext.get(\"my-div\");\n\n// no animation\nel.setWidth(100);\n

\n\n

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

\n\n

// default animation\nel.setWidth(100, true);\n

\n\n

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

\n\n

Option    Default   Description\n--------- --------  ---------------------------------------------\nduration  350       The duration of the animation in milliseconds\neasing    easeOut   The easing method\ncallback  none      A function to execute when the anim completes\nscope     this      The scope (this) of the callback function\n

\n\n

Usage:

\n\n

// Element animation options object\nvar opt = {\n    duration: 1000,\n    easing: 'elasticIn',\n    callback: this.foo,\n    scope: this\n};\n// animation with some options set\nel.setWidth(100, opt);\n

\n\n

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

\n\n

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

\n\n

Composite (Collections of) Elements

\n\n

For working with collections of Elements, see Ext.CompositeElement

Properties

Defined By

Instance Properties

Ext.Base
view source

$className : Stringprivate

...

Defaults to: "Ext.Base"

Ext.dom.Element
view source

autoBoxAdjust : Boolean

True to automatically adjust width and height settings for box-model issues. ...

True to automatically adjust width and height settings for box-model issues.

Defaults to: true

Ext.Base
view source

configMap : Objectprivate

...

Defaults to: {}

Ext.dom.AbstractElement
view source

defaultUnit : String

The default unit to append to CSS values where a unit isn't provided. ...

The default unit to append to CSS values where a unit isn't provided.

Defaults to: "px"

Ext.dom.AbstractElement
view source

dom : HTMLElement

The DOM element

Ext.dom.AbstractElement
view source

id : String

The DOM element ID

Ext.Base
view source

initConfigList : Arrayprivate

...

Defaults to: []

Ext.Base
view source

initConfigMap : Objectprivate

...

Defaults to: {}

Ext.Base
view source

isInstance : Booleanprivate

...

Defaults to: true

Ext.dom.Element
view source

originalDisplay : String

The element's default display mode. ...

The element's default display mode.

Defaults to: ""

Ext.Base
view source

self : Ext.Classprotected

Get the reference to the current class from which this object was instantiated. ...

Get the reference to the current class from which this object was instantiated. Unlike statics,\nthis.self is scope-dependent and it's meant to be used for dynamic inheritance. See statics\nfor a detailed comparison

\n\n

Ext.define('My.Cat', {\n    statics: {\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        alert(this.self.speciesName); // dependent on 'this'\n    },\n\n    clone: function() {\n        return new this.self();\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n    statics: {\n        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'\n    }\n});\n\nvar cat = new My.Cat();                     // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'\n

Ext.dom.AbstractElement
view source

styleHooks : Objectprivate

This shared object is keyed by style name (e.g., 'margin-left' or 'marginLeft'). ...

This shared object is keyed by style name (e.g., 'margin-left' or 'marginLeft'). The\nvalues are objects with the following properties:

\n\n

name (String) : The actual name to be presented to the DOM. This is typically the value\n returned by normalize.
get (Function) : A hook function that will perform the get on this style. These\n functions receive \"(dom, el)\" arguments. The dom parameter is the DOM Element\n from which to get ths tyle. The el argument (may be null) is the Ext.Element.
set (Function) : A hook function that will perform the set on this style. These\n functions receive \"(dom, value, el)\" arguments. The dom parameter is the DOM Element\n from which to get ths tyle. The value parameter is the new value for the style. The\n el argument (may be null) is the Ext.Element.

\n\n\n

The this pointer is the object that contains get or set, which means that\nthis.name can be accessed if needed. The hook functions are both optional.

Defaults to: {}

Defined By

Static Properties

Ext.Base
view source

$onExtended : Arrayprivatestatic

...

Defaults to: []

Ext.dom.AbstractElement
view source

ASCLASS : Numberstatic

Visibility mode constant for use with Ext.dom.Element.setVisibilityMode. ...

Visibility mode constant for use with Ext.dom.Element.setVisibilityMode.\nAdd or remove the Ext.Layer.visibilityCls class to hide the element.

Defaults to: 4

Ext.dom.AbstractElement
view source

DISPLAY : Numberstatic

Visibility mode constant for use with Ext.dom.Element.setVisibilityMode. ...

Visibility mode constant for use with Ext.dom.Element.setVisibilityMode.\nUse the CSS 'display' property to hide the element.

Defaults to: 2

Ext.dom.AbstractElement
view source

OFFSETS : Numberstatic

Visibility mode constant for use with Ext.dom.Element.setVisibilityMode. ...

Visibility mode constant for use with Ext.dom.Element.setVisibilityMode.\nUse CSS absolute positioning and top/left offsets to hide the element.

Defaults to: 3

Ext.dom.AbstractElement
view source

VISIBILITY : Numberstatic

Visibility mode constant for use with Ext.dom.Element.setVisibilityMode. ...

Visibility mode constant for use with Ext.dom.Element.setVisibilityMode.\nUse the CSS 'visibility' property to hide the element.

\n\n

Note that in this mode, isVisible may return true\nfor an element even though it actually has a parent element that is hidden. For this\nreason, and in most cases, using the OFFSETS mode is a better choice.

Defaults to: 1

Methods

Defined By

Instance Methods

Ext.dom.Element
view source

newExt.dom.Element( String/HTMLElement element, [Boolean forceNew] ) : Object

Creates new Element directly. ...

Creates new Element directly.

Parameters

element : String/HTMLElement
\n
forceNew : Boolean (optional)
By default the constructor checks to see if there is already an instance of this\nelement in the cache and if there is it returns the same instance. This will skip that check (useful for extending\nthis class).
\n

Returns

Object
\n

Ext.dom.AbstractElement
view source

addCls( String/String[] className ) : Ext.dom.Element

Adds one or more CSS classes to the element. ...

Adds one or more CSS classes to the element. Duplicate classes are automatically filtered out.

Parameters

className : String/String[]
The CSS classes to add separated by space, or an array of classes
\n

Returns

Ext.dom.Element
this
\n

Ext.dom.Element
view source

addClsOnClick( String className, [Function testFn], [Object scope] ) : Ext.dom.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
The class to add
\n
testFn : Function (optional)
A test function to execute before adding the class. The passed parameter\nwill be the Element instance. If this functions returns false, the class will not be added.
\n
scope : Object (optional)
The scope to execute the testFn in.
\n

Returns

Ext.dom.Element
this
\n

Ext.dom.Element
view source

addClsOnFocus( String className, [Function testFn], [Object scope] ) : Ext.dom.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
The class to add
\n
testFn : Function (optional)
A test function to execute before adding the class. The passed parameter\nwill be the Element instance. If this functions returns false, the class will not be added.
\n
scope : Object (optional)
The scope to execute the testFn in.
\n

Returns

Ext.dom.Element
this
\n

Ext.dom.Element
view source

addClsOnOver( String className, [Function testFn], [Object scope] ) : Ext.dom.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
The class to add
\n
testFn : Function (optional)
A test function to execute before adding the class. The passed parameter\nwill be the Element instance. If this functions returns false, the class will not be added.
\n
scope : Object (optional)
The scope to execute the testFn in.
\n

Returns

Ext.dom.Element
this
\n

Ext.dom.Element
view source

addKeyListener( String/Number/Number[]/Object key, Function fn, [Object scope] ) : Ext.util.KeyMap

Convenience method for constructing a KeyMap ...

Convenience method for constructing a KeyMap

Parameters

key : String/Number/Number[]/Object
Either a string with the keys to listen for, the numeric key code,\narray of key codes or an object with the following options:
\n
- key : Number/Array
- shift : Boolean
- ctrl : Boolean
- alt : Boolean
fn : Function
The function to call
\n
scope : Object (optional)
The scope (this reference) in which the specified function is executed. Defaults to this Element.
\n

Returns

Ext.util.KeyMap
The KeyMap created
\n

Ext.dom.Element
view source

addKeyMap( Object config ) : Ext.util.KeyMap

Creates a KeyMap for this element ...

Creates a KeyMap for this element

Parameters

config : Object
The KeyMap config. See Ext.util.KeyMap for more details
\n

Returns

Ext.util.KeyMap
The KeyMap created
\n

Ext.dom.Element
view source

addListener( String eventName, Function fn, [Object scope], [Object options] ) : Ext.dom.Element

Shorthand for on. ...

Shorthand for on.

\n\n

Appends an event handler to this element.

Parameters

eventName : String
The name of event to handle.
\n\n
fn : Function
The handler function the event invokes. This function is passed the following parameters:
\n\n\n\n\n
- evt : EventObject
  \n\n
  The EventObject describing the event.
- el : HtmlElement
  \n\n
  The DOM element which was the target of the event. Note that this may be filtered by using the delegate option.
- o : Object
  \n\n
  The options object from the call that setup the listener.
\n\n\n\n
scope : Object (optional)
The scope (this reference) in which the handler function is executed. If\nomitted, defaults to this Element.
\n\n
options : Object (optional)
An object containing handler configuration properties. This may contain any of\nthe following properties:
\n\n\n\n\n
- scope Object :
  \n\n
  The scope (this reference) in which the handler function is executed. If omitted, defaults to this\nElement.
- delegate String:
  \n\n
  A simple selector to filter the target or look for a descendant of the target. See below for additional details.
- stopEvent Boolean:
  \n\n
  True to stop the event. That is stop propagation, and prevent the default action.
- preventDefault Boolean:
  \n\n
  True to prevent the default action
- stopPropagation Boolean:
  \n\n
  True to prevent event propagation
- normalized Boolean:
  \n\n
  False to pass a browser event to the handler function instead of an Ext.EventObject
- target Ext.dom.Element:
  \n\n
  Only call the handler if the event was fired on the target Element, not if the event was bubbled up from a\nchild node.
- delay Number:
  \n\n
  The number of milliseconds to delay the invocation of the handler after the event fires.
- single Boolean:
  \n\n
  True to add a handler to handle just the next firing of the event, and then remove itself.
- buffer Number:
  \n\n
  Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is not invoked, but the new\nhandler is scheduled in its place.
\n\n\n\n\n
Combining Options
\n\n\n\n\n
Using the options argument, it is possible to combine different types of listeners:
\n\n\n\n\n
A delayed, one-time listener that auto stops the event and adds a custom argument (forumId) to the options\nobject. The options object is available as the third parameter in the handler function.
\n\n\n\n\n
Code:
\n\n\n\n\n
```
el.on('click', this.onClick, this, {\n    single: true,\n    delay: 100,\n    stopEvent : true,\n    forumId: 4\n});\n
```
\n\n\n\n\n
Attaching multiple handlers in 1 call
\n\n\n\n\n
The method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple handlers.
\n\n\n\n\n
Code:
\n\n\n\n\n
```
el.on({\n    'click' : {\n        fn: this.onClick,\n        scope: this,\n        delay: 100\n    },\n    'mouseover' : {\n        fn: this.onMouseOver,\n        scope: this\n    },\n    'mouseout' : {\n        fn: this.onMouseOut,\n        scope: this\n    }\n});\n
```
\n\n\n\n\n
Or a shorthand syntax:
\n\n\n\n\n
Code:
\n\n\n\n\n
```
el.on({\n    'click' : this.onClick,\n    'mouseover' : this.onMouseOver,\n    'mouseout' : this.onMouseOut,\n    scope: this\n});\n
```
\n\n\n\n\n
delegate
\n\n\n\n\n
This is a configuration option that you can pass along when registering a handler for an event to assist with\nevent delegation. Event delegation is a technique that is used to reduce memory consumption and prevent exposure\nto memory-leaks. By registering an event for a container element as opposed to each element within a container.\nBy setting this configuration option to a simple selector, the target element will be filtered to look for a\ndescendant of the target. For example:
\n\n\n\n\n
```
// using this markup:\n<div id='elId'>\n    <p id='p1'>paragraph one</p>\n    <p id='p2' class='clickable'>paragraph two</p>\n    <p id='p3'>paragraph three</p>\n</div>\n\n// utilize event delegation to registering just one handler on the container element:\nel = Ext.get('elId');\nel.on(\n    'click',\n    function(e,t) {\n        // handle click\n        console.info(t.id); // 'p2'\n    },\n    this,\n    {\n        // filter the target element to be a descendant with the class 'clickable'\n        delegate: '.clickable'\n    }\n);\n
```
\n\n

Returns

Ext.dom.Element
this
\n\n

Ext.dom.Element
view source

adjustDirect2DDimension( Object dimension ) : Numberprivate

Returns 1 if the browser returns the subpixel dimension rounded to the lowest pixel. ...

Returns 1 if the browser returns the subpixel dimension rounded to the lowest pixel.

Parameters

dimension : Object
\n

Returns

Number
0 or 1
\n

Ext.dom.Element
view source

alignTo( String/HTMLElement/Ext.Element element, [String position], [Number[] offsets], [Boolean/Object animate] ) : Ext.Element

Aligns this element with another element relative to the specified anchor points. ...

Aligns this element with another element relative to the specified anchor points. If the other element is the\ndocument it aligns it to the viewport. The position parameter is optional, and can be specified in any one of\nthe following formats:

\n\n

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.\nThe element being aligned will position its top-left corner (tl) to that point. This method has been\ndeprecated 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\nelement's anchor point, and the second value is used as the target's anchor point.

\n\n\n

In addition to the anchor points, the position parameter also supports the \"?\" character. If \"?\" is passed at the end of\nthe position string, the element will attempt to align as specified, but the position will be adjusted to constrain to\nthe viewport if necessary. Note that the element being aligned might be swapped to align to a different position than\nthat specified in order to enforce the viewport constraints.\nFollowing are all of the supported anchor positions:

\n\n

Value  Description\n-----  -----------------------------\ntl     The top left corner (default)\nt      The center of the top edge\ntr     The top right corner\nl      The center of the left edge\nc      In the center of the element\nr      The center of the right edge\nbl     The bottom left corner\nb      The center of the bottom edge\nbr     The bottom right corner\n

\n\n\n

Example Usage:

\n\n

// align el to other-el using the default positioning (\"tl-bl\", non-constrained)\nel.alignTo(\"other-el\");\n\n// align the top left corner of el with the top right corner of other-el (constrained to viewport)\nel.alignTo(\"other-el\", \"tr?\");\n\n// align the bottom right corner of el with the center left edge of other-el\nel.alignTo(\"other-el\", \"br-l?\");\n\n// align the center of el with the bottom left corner of other-el and\n// adjust the x position by -6 pixels (and the y position by 0)\nel.alignTo(\"other-el\", \"c-bl\", [-6, 0]);\n

Parameters

element : String/HTMLElement/Ext.Element
The element to align to.
\n
position : String (optional)
The position to align to
\n
Defaults to: "tl-bl?"
offsets : Number[] (optional)
Offset the positioning by [x, y]
\n
animate : Boolean/Object (optional)
true for the default animation or a standard Element animation config object
\n

Returns

Ext.Element
this
\n

Ext.dom.Element
view source

anchorTo( String/HTMLElement/Ext.Element element, String position, [Number[] 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 : String/HTMLElement/Ext.Element
The element to align to.
\n
position : String
The position to align to.
\n
offsets : Number[] (optional)
Offset the positioning by [x, y]
\n
animate : Boolean/Object (optional)
True for the default animation or a standard Element animation config object
\n
monitorScroll : Boolean/Number (optional)
True to monitor body scroll and reposition. If this parameter\nis a number, it is used as the buffer delay (defaults to 50ms).
\n
callback : Function (optional)
The function to call after the animation finishes
\n

Returns

Ext.Element
this
\n

Ext.dom.Element
view source

animate( Object config ) : Ext.dom.Element

Performs custom animation on this Element. ...

Performs custom animation on this Element.

\n\n

The following properties may be specified in from, to, and keyframe objects:

\n\n

x - The page X position in pixels.
y - The page Y position in pixels
left - The element's CSS left value. Units must be supplied.
top - The element's CSS top value. Units must be supplied.
width - The element's CSS width value. Units must be supplied.
height - The element's CSS height value. Units must be supplied.
scrollLeft - The element's scrollLeft value.
scrollTop - The element's scrollTop value.
opacity - The element's opacity value. This must be a value between 0 and 1.

\n\n\n

Be aware that animating an Element which is being used by an Ext Component without in some way informing the\nComponent about the changed element state will result in incorrect Component behaviour. This is because the\nComponent will be using the old state of the element. To avoid this problem, it is now possible to directly\nanimate certain properties of Components.

Parameters

config : Object
Configuration for Ext.fx.Anim.\nNote that the to config is required.
\n

Returns

Ext.dom.Element
this
\n

Ext.dom.AbstractElement
view source

appendChild( String/HTMLElement/Ext.dom.AbstractElement el ) : Ext.dom.AbstractElement

Appends the passed element(s) to this element ...

Appends the passed element(s) to this element

Parameters

el : String/HTMLElement/Ext.dom.AbstractElement
The id of the node, a DOM Node or an existing Element.
\n

Returns

Ext.dom.AbstractElement
This element
\n

Ext.dom.AbstractElement
view source

appendTo( String/HTMLElement/Ext.dom.AbstractElement el ) : Ext.dom.AbstractElement

Appends this element to the passed element ...

Appends this element to the passed element

Parameters

el : String/HTMLElement/Ext.dom.AbstractElement
The new parent element.\nThe id of the node, a DOM Node or an existing Element.
\n

Returns

Ext.dom.AbstractElement
This element
\n

Ext.dom.AbstractElement
view source

applyStyles( String/Object/Function styles ) : Ext.dom.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\na function which returns such a specification.
\n

Returns

Ext.dom.Element
this
\n

Ext.dom.Element
view source

blur( ) : Ext.dom.Element

Tries to blur the element. ...

Tries to blur the element. Any exceptions are caught and ignored.

Returns

Ext.dom.Element
this
\n

Ext.dom.Element
view source

boxWrap( [String class] ) : Ext.dom.Element

Wraps the specified element with a special 9 element markup/CSS block that renders by default as\na gray container wit...

Wraps the specified element with a special 9 element markup/CSS block that renders by default as\na gray container with a gradient background, rounded corners and a 4-way shadow.

\n\n

This special markup is used throughout Ext when box wrapping elements (Ext.button.Button,\nExt.panel.Panel when frame=true, Ext.window.Window).\nThe markup is of this form:

\n\n

Ext.dom.Element.boxMarkup =\n'<div class=\"{0}-tl\"><div class=\"{0}-tr\"><div class=\"{0}-tc\"></div></div></div>\n<div class=\"{0}-ml\"><div class=\"{0}-mr\"><div class=\"{0}-mc\"></div></div></div>\n<div class=\"{0}-bl\"><div class=\"{0}-br\"><div class=\"{0}-bc\"></div></div></div>';\n

\n\n

Example usage:

\n\n

// Basic box wrap\nExt.get(\"foo\").boxWrap();\n\n// You can also add a custom class and use CSS inheritance rules to customize the box look.\n// 'x-box-blue' is a built-in alternative -- look at the related CSS definitions as an example\n// for how to create a custom box wrap style.\nExt.get(\"foo\").boxWrap().addCls(\"x-box-blue\");\n

Parameters

class : String (optional)
A base CSS class to apply to the containing wrapper element.\nNote that there are a number of CSS rules that are dependent on this name to make the overall effect work,\nso if you supply an alternate base class, make sure you also supply all of the necessary rules.
\n
Defaults to: "x-box"

Returns

Ext.dom.Element
The outermost wrapping element of the created box structure.
\n

Ext.dom.Element
view source

cacheScrollValues( ) : Function

When an element is moved around in the DOM, or is hidden using display:none, it loses layout, and therefore\nall scrol...

When an element is moved around in the DOM, or is hidden using display:none, it loses layout, and therefore\nall scroll positions of all descendant elements are lost.

\n\n

This function caches them, and returns a function, which when run will restore the cached positions.\nIn the following example, the Panel is moved from one Container to another which will cause it to lose all scroll positions:

\n\n

var restoreScroll = myPanel.el.cacheScrollValues();\nmyOtherContainer.add(myPanel);\nrestoreScroll();\n

Returns

Function
A function which will restore all descentant elements of this Element to their scroll\npositions recorded when this function was executed. Be aware that the returned function is a closure which has\ncaptured the scope of cacheScrollValues, so take care to derefence it as soon as not needed - if is it is a var\nit will drop out of scope, and the reference will be freed.
\n

Ext.Base
view source

callOverridden( Array/Arguments args ) : Objectdeprecatedprotected

Call the original method that was previously overridden with override\n\nExt.define('My.Cat', {\n constructor: functi...

Call the original method that was previously overridden with override

\n\n

Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        this.callOverridden();\n\n        alert(\"Meeeeoooowwww\");\n    }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n                          // alerts \"I'm a cat!\"\n                          // alerts \"Meeeeoooowwww\"\n

This method has been deprecated

as of 4.1. Use callParent instead.

\n\n

Parameters

args : Array/Arguments
The arguments, either an array or the arguments object\nfrom the current method, for example: this.callOverridden(arguments)
\n

Returns

Object
Returns the result of calling the overridden method
\n

Ext.Base
view source

callParent( Array/Arguments args ) : Objectprotected

Call the \"parent\" method of the current method. ...

Call the \"parent\" method of the current method. That is the method previously\noverridden by derivation or by an override (see Ext.define).

\n\n

 Ext.define('My.Base', {\n     constructor: function (x) {\n         this.x = x;\n     },\n\n     statics: {\n         method: function (x) {\n             return x;\n         }\n     }\n });\n\n Ext.define('My.Derived', {\n     extend: 'My.Base',\n\n     constructor: function () {\n         this.callParent([21]);\n     }\n });\n\n var obj = new My.Derived();\n\n alert(obj.x);  // alerts 21\n

\n\n

This can be used with an override as follows:

\n\n

 Ext.define('My.DerivedOverride', {\n     override: 'My.Derived',\n\n     constructor: function (x) {\n         this.callParent([x*2]); // calls original My.Derived constructor\n     }\n });\n\n var obj = new My.Derived();\n\n alert(obj.x);  // now alerts 42\n

\n\n

This also works with static methods.

\n\n

 Ext.define('My.Derived2', {\n     extend: 'My.Base',\n\n     statics: {\n         method: function (x) {\n             return this.callParent([x*2]); // calls My.Base.method\n         }\n     }\n });\n\n alert(My.Base.method(10);     // alerts 10\n alert(My.Derived2.method(10); // alerts 20\n

\n\n

Lastly, it also works with overridden static methods.

\n\n

 Ext.define('My.Derived2Override', {\n     override: 'My.Derived2',\n\n     statics: {\n         method: function (x) {\n             return this.callParent([x*2]); // calls My.Derived2.method\n         }\n     }\n });\n\n alert(My.Derived2.method(10); // now alerts 40\n

Parameters

args : Array/Arguments
The arguments, either an array or the arguments object\nfrom the current method, for example: this.callParent(arguments)
\n

Returns

Object
Returns the result of calling the parent method
\n

Ext.dom.Element
view source

center( [String/HTMLElement/Ext.Element centerIn] )

Centers the Element in either the viewport, or another Element. ...

Centers the Element in either the viewport, or another Element.

Parameters

centerIn : String/HTMLElement/Ext.Element (optional)
The element in which to center the element.
\n

Ext.dom.AbstractElement
view source

child( String selector, [Boolean returnDom] ) : HTMLElement/Ext.dom.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
\n
returnDom : Boolean (optional)
True to return the DOM node instead of Ext.dom.Element.
\n
Defaults to: false

Returns

HTMLElement/Ext.dom.Element
The child Ext.dom.Element (or DOM node if returnDom = true)
\n

Ext.dom.Element
view source

clean( [Boolean forceReclean] )

Removes Empty, or whitespace filled text nodes. ...

Removes Empty, or whitespace filled text nodes. Combines adjacent text nodes.

Parameters

forceReclean : Boolean (optional)
By default the element keeps track if it has been cleaned already\nso you can call this over and over. However, if you update the element and need to force a reclean, you\ncan pass true.
\n
Defaults to: false

Ext.dom.Element
view source

clearListeners( ) : Ext.dom.Element

Alias for removeAllListeners. ...

Alias for removeAllListeners.

\n\n

Removes all previous added listeners from this element

Returns

Ext.dom.Element
this
\n\n

Ext.dom.Element
view source

clearOpacity( ) : Ext.dom.Element

Clears any opacity settings from this element. ...

Clears any opacity settings from this element. Required in some cases for IE.

Returns

Ext.dom.Element
this
\n

Ext.dom.Element
view source

clearPositioning( [String value] ) : Ext.dom.AbstractElement

Clears positioning back to the default when the document was loaded. ...

Clears positioning back to the default when the document was loaded.

Parameters

value : String (optional)
The value to use for the left, right, top, bottom. You could use 'auto'.
\n
Defaults to: ""

Returns

Ext.dom.AbstractElement
this
\n

Ext.dom.Element
view source

clip( ) : Ext.dom.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

Returns

Ext.dom.Element
this
\n

Ext.Base
view source

configClass( )private

...

Ext.dom.AbstractElement
view source

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
\n

Returns

Boolean
True if this element is an ancestor of el, else false
\n

Ext.dom.AbstractElement
view source

createChild( Object config, [HTMLElement insertBefore], [Boolean returnDom] ) : Ext.dom.AbstractElement

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\nautomatically generated with the specified attributes.
\n
insertBefore : HTMLElement (optional)
a child element of this element
\n
returnDom : Boolean (optional)
true to return the dom node instead of creating an Element
\n
Defaults to: false

Returns

Ext.dom.AbstractElement
The new child element
\n

Ext.dom.Element
view source

createProxy( String/Object config, [String/HTMLElement renderTo], [Boolean matchBox] ) : Ext.dom.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
\n
renderTo : String/HTMLElement (optional)
The element or element id to render the proxy to. Defaults to: document.body.
\n
matchBox : Boolean (optional)
True to align and size the proxy to this element now.
\n
Defaults to: false

Returns

Ext.dom.Element
The new proxy element
\n

Ext.dom.Element
view source

createShim( ) : Ext.dom.Element

Creates an iframe shim for this element to keep selects and other windowed objects from\nshowing through. ...

Creates an iframe shim for this element to keep selects and other windowed objects from\nshowing through.

Returns

Ext.dom.Element
The new shim element
\n

Ext.dom.AbstractElement
view source

destroy( )

Alias to remove. ...

Alias to remove.

\n\n

Removes this element's dom reference. Note that event and cache removal is handled at Ext.removeNode

Overrides: Ext.Base.destroy

Ext.dom.AbstractElement
view source

down( String selector, [Boolean returnDom] ) : HTMLElement/Ext.dom.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
\n
returnDom : Boolean (optional)
True to return the DOM node instead of Ext.dom.Element
\n
Defaults to: false

Returns

HTMLElement/Ext.dom.Element
The child Ext.dom.Element (or DOM node if returnDom = true)
\n

Ext.dom.Element
view source

enableDisplayMode( [String display] ) : Ext.dom.Element

Convenience method for setVisibilityMode(Element.DISPLAY) ...

Convenience method for setVisibilityMode(Element.DISPLAY)

Parameters

display : String (optional)
What to set display to when visible
\n

Returns

Ext.dom.Element
this
\n

Ext.dom.Element
view source

fadeIn( [Object options] ) : Ext.Element

Fade an element in (from transparent to opaque). ...

Fade an element in (from transparent to opaque). The ending opacity can be specified using the opacity\nconfig option. Usage:

\n\n

// default: fade in from opacity 0 to 100%\nel.fadeIn();\n\n// custom: fade in from opacity 0 to 75% over 2 seconds\nel.fadeIn({ opacity: .75, duration: 2000});\n\n// common config options shown with default values\nel.fadeIn({\n    opacity: 1, //can be any value between 0 and 1 (e.g. .5)\n    easing: 'easeOut',\n    duration: 500\n});\n

Parameters

options : Object (optional)
Object literal with any of the Fx config options
\n

Returns

Ext.Element
The Element
\n

Ext.dom.Element
view source

fadeOut( [Object options] ) : Ext.Element

Fade an element out (from opaque to transparent). ...

Fade an element out (from opaque to transparent). The ending opacity can be specified using the opacity\nconfig option. Note that IE may require useDisplay:true in order to redisplay correctly.\nUsage:

\n\n

// default: fade out from the element's current opacity to 0\nel.fadeOut();\n\n// custom: fade out from the element's current opacity to 25% over 2 seconds\nel.fadeOut({ opacity: .25, duration: 2000});\n\n// common config options shown with default values\nel.fadeOut({\n    opacity: 0, //can be any value between 0 and 1 (e.g. .5)\n    easing: 'easeOut',\n    duration: 500,\n    remove: false,\n    useDisplay: false\n});\n

Parameters

options : Object (optional)
Object literal with any of the Fx config options
\n

Returns

Ext.Element
The Element
\n

Ext.dom.AbstractElement
view source

findParent( String selector, [Number/String/HTMLElement/Ext.Element limit], [Boolean returnEl] ) : HTMLElement

Looks at this node and then at parent nodes for a match of the passed simple selector (e.g. ...

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
\n
limit : Number/String/HTMLElement/Ext.Element (optional)
The max depth to search as a number or an element which causes the upward traversal to stop\nand is not considered for inclusion as the result. (defaults to 50 || document.documentElement)
\n
returnEl : Boolean (optional)
True to return a Ext.Element object instead of DOM node
\n
Defaults to: false

Returns

HTMLElement
The matching DOM node (or null if no match was found)
\n

Ext.dom.AbstractElement
view source

findParentNode( String selector, [Number/String/HTMLElement/Ext.Element limit], [Boolean returnEl] ) : HTMLElement

Looks at parent nodes for a match of the passed simple selector (e.g. ...

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
\n
limit : Number/String/HTMLElement/Ext.Element (optional)
The max depth to search as a number or an element which causes the upward traversal to stop\nand is not considered for inclusion as the result. (defaults to 50 || document.documentElement)
\n
returnEl : Boolean (optional)
True to return a Ext.Element object instead of DOM node
\n
Defaults to: false

Returns

HTMLElement
The matching DOM node (or null if no match was found)
\n

Ext.dom.AbstractElement
view source

first( [String selector], [Boolean returnDom] ) : Ext.dom.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
\n
returnDom : Boolean (optional)
True to return a raw dom node instead of an Ext.dom.Element
\n
Defaults to: false

Returns

Ext.dom.Element/HTMLElement
The first child or null
\n

Ext.dom.Element
view source

focus( [Number defer] ) : Ext.dom.Element

Tries to focus the element. ...

Tries to focus the element. Any exceptions are caught and ignored.

Parameters

defer : Number (optional)
Milliseconds to defer the focus
\n

Returns

Ext.dom.Element
this
\n

Ext.dom.Element
view source

focusable( ) : Boolean

Checks whether this element can be focused. ...

Checks whether this element can be focused.

Returns

Boolean
True if the element is focusable
\n

Ext.dom.Element
view source

frame( [String color], [Number count], [Object options] ) : Ext.dom.Element

Shows a ripple of exploding, attenuating borders to draw attention to an Element. ...

Shows a ripple of exploding, attenuating borders to draw attention to an Element. Usage:

\n\n

// default: a single light blue ripple\nel.frame();\n\n// custom: 3 red ripples lasting 3 seconds total\nel.frame(\"#ff0000\", 3, { duration: 3000 });\n\n// common config options shown with default values\nel.frame(\"#C3DAF9\", 1, {\n    duration: 1000 // duration of each individual ripple.\n    // Note: Easing is not configurable and will be ignored if included\n});\n

Parameters

color : String (optional)
The hex color value for the border.
\n
Defaults to: "#C3DAF9"
count : Number (optional)
The number of ripples to display.
\n
Defaults to: 1
options : Object (optional)
Object literal with any of the Fx config options
\n

Returns

Ext.dom.Element
The Element
\n

Ext.dom.AbstractElement
view source

getActiveElement( ) : HTMLElement

Returns the active element in the DOM. ...

Returns the active element in the DOM. If the browser supports activeElement\non the document, this is returned. If not, the focus is tracked and the active\nelement is maintained internally.

Returns

HTMLElement
The active (focused) element in the document.
\n

Ext.dom.Element
view source

getAlignToXY( String/HTMLElement/Ext.Element element, [String position], [Number[] offsets] ) : Number[]

Gets the x,y coordinates to align this element with another element. ...

Gets the x,y coordinates to align this element with another element. See alignTo for more info on the\nsupported position values.

Parameters

element : String/HTMLElement/Ext.Element
The element to align to.
\n
position : String (optional)
The position to align to (defaults to )
\n
Defaults to: "tl-bl?"
offsets : Number[] (optional)
Offset the positioning by [x, y]
\n

Returns

Number[]
[x, y]
\n

Overrides: Ext.dom.AbstractElement.getAlignToXY

Ext.dom.Element
view source

getAnchorXY( [String anchor], [Boolean local], [Object size] ) : Number[]

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. See alignTo\nfor details on supported anchor positions.
\n
Defaults to: "c"
local : Boolean (optional)
True to get the local (element top/left-relative) anchor position instead\nof page coordinates
\n
size : Object (optional)
An object containing the size to use for calculating anchor position\n{width: (target width), height: (target height)} (defaults to the element's current size)
\n

Returns

Number[]
[x, y] An array containing the element's x and y coordinates
\n

Overrides: Ext.dom.AbstractElement.getAnchorXY

Ext.dom.AbstractElement
view source

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
\n
namespace : String (optional)
The namespace in which to look for the attribute
\n

Returns

String
The attribute value
\n

Ext.dom.Element
view source

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
\n
name : String
The attribute name
\n

Returns

String
The attribute value
\n

Ext.dom.AbstractElement
view source

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,\npassing 'lr' would get the border left width + the border right width.
\n

Returns

Number
The width of the sides passed added together
\n

Ext.dom.AbstractElement
view source

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
\n

Returns

Number
\n

Ext.dom.AbstractElement
view source

getBox( [Boolean contentBox], [Boolean local] ) : Object

Return an object defining the area of this Element which can be passed to setBox to\nset another Element's size/locati...

Return an object defining the area of this Element which can be passed to setBox to\nset 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.
\n
local : Boolean (optional)
If true the element's left and top are returned instead of page x/y.
\n

Returns

Object
box An object in the format:
\n\n
```
{\n    x: <Element's X position>,\n    y: <Element's Y position>,\n    width: <Element's width>,\n    height: <Element's height>,\n    bottom: <Element's lower bound>,\n    right: <Element's rightmost bound>\n}\n
```
\n\n
The returned object may also be addressed as an Array where index 0 contains the X position\nand index 1 contains the Y position. So the result may also be used for setXY
\n

Ext.dom.AbstractElement
view source

getById( String id, [Boolean asDom] )

Returns a child element of this element given its id. ...

Returns a child element of this element given its id.

Parameters

id : String
The id of the desired child element.
\n
asDom : Boolean (optional)
True to return the DOM element, false to return a\nwrapped Element object.
\n
Defaults to: false

Ext.dom.Element
view source

getCenterXY( ) : Number[]

Calculates the x, y to center this element on the screen ...

Calculates the x, y to center this element on the screen

Returns

Number[]
The x, y values [x, y]
\n

Ext.dom.Element
view source

getColor( String attr, String defaultValue, [String prefix] )

Return the CSS color for the specified CSS attribute. ...

Return the CSS color for the specified CSS attribute. rgb, 3 digit (like #fff) and valid values\nare convert to standard 6 digit hex color.

Parameters

attr : String
The css attribute
\n
defaultValue : String
The default value to use when a valid color isn't found
\n
prefix : String (optional)
defaults to #. Use an empty string when working with\ncolor anims.
\n

Ext.dom.Element
view source

getComputedHeight( ) : Number

Returns either the offsetHeight or the height of this element based on CSS height adjusted by padding or borders\nwhen...

Returns either the offsetHeight or the height of this element based on CSS height adjusted by padding or borders\nwhen needed to simulate offsetHeight when offsets aren't available. This may not work on display:none elements\nif a height has not been set using CSS.

Returns

Number
\n

Ext.dom.Element
view source

getComputedWidth( ) : Number

Returns either the offsetWidth or the width of this element based on CSS width adjusted by padding or borders\nwhen ne...

Returns either the offsetWidth or the width of this element based on CSS width adjusted by padding or borders\nwhen needed to simulate offsetWidth when offsets aren't available. This may not work on display:none elements\nif a width has not been set using CSS.

Returns

Number
\n

Ext.Base
view source

getConfig( Object name )private

...

Parameters

name : Object
\n

Ext.dom.Element
view source

getConstrainVector( Ext.Element/Ext.util.Region constrainTo, Number[] proposedPosition ) : Number[]/Boolean

Returns the [X, Y] vector by which this element must be translated to make a best attempt\nto constrain within the pas...

Returns the [X, Y] vector by which this element must be translated to make a best attempt\nto constrain within the passed constraint. Returns false is this element does not need to be moved.

\n\n

Priority is given to constraining the top and left within the constraint.

\n\n

The constraint may either be an existing element into which this element is to be constrained, or\nan Region into which this element is to be constrained.

Parameters

constrainTo : Ext.Element/Ext.util.Region
The Element or Region into which this element is to be constrained.
\n
proposedPosition : Number[]
A proposed [X, Y] position to test for validity and to produce a vector for instead\nof using this Element's current position;
\n

Returns

Number[]/Boolean
If this element needs to be translated, an [X, Y]\nvector by which this element must be translated. Otherwise, false.
\n

Ext.dom.Element
view source

getFrameWidth( String sides ) : Number

Returns the sum width of the padding and borders for the passed \"sides\". ...

Returns the sum width of the padding and borders for the passed \"sides\". See getBorderWidth()\nfor more information about the sides.

Parameters

sides : String
\n

Returns

Number
\n

Ext.dom.AbstractElement
view source

getHTML( )

Returns the innerHTML of an Element or an empty string if the element's\ndom no longer exists. ...

Returns the innerHTML of an Element or an empty string if the element's\ndom no longer exists.

Ext.dom.AbstractElement
view source

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
\n

Returns

Number
The element's height
\n

Ext.Base
view source

getInitialConfig( [String name] ) : Object/Mixed

Returns the initial configuration passed to constructor when instantiating\nthis class. ...

Returns the initial configuration passed to constructor when instantiating\nthis class.

Parameters

name : String (optional)
Name of the config option to return.
\n

Returns

Object/Mixed
The full config object or a single config value\nwhen name parameter specified.
\n

Ext.dom.AbstractElement
view source

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
\n

Returns

Number
\n

Ext.dom.Element
view source

getLoader( ) : Ext.ElementLoader

Gets this element's ElementLoader ...

Gets this element's ElementLoader

Returns

Ext.ElementLoader
The loader
\n

Ext.dom.Element
view source

getLocalX( ) : Number

Returns the x-coordinate of this element reletive to its offsetParent. ...

Returns the x-coordinate of this element reletive to its offsetParent.

Returns

Number
The local x-coordinate (relative to the offsetParent).
\n

Ext.dom.Element
view source

getLocalY( ) : Number

Returns the y-coordinate of this element reletive to its offsetParent. ...

Returns the y-coordinate of this element reletive to its offsetParent.

Returns

Number
The local y-coordinate (relative to the offsetParent).
\n

Ext.dom.AbstractElement
view source

getMargin( [String sides] ) : Object/Number

Returns an object with properties top, left, right and bottom representing the margins of this element unless sides i...

Returns an object with properties top, left, right and bottom representing the margins of this element unless sides is passed,\nthen it returns the calculated width of the sides (see getPadding)

Parameters

sides : String (optional)
Any combination of l, r, t, b to get the sum of those sides
\n

Returns

Object/Number
\n

Ext.dom.Element
view source

getOffsetsTo( String/HTMLElement/Ext.Element element ) : Number[]

Returns the offsets of this element from the passed element. ...

Returns the offsets of this element from the passed element. Both element must be part\nof the DOM tree and not have display:none to have page coordinates.

Parameters

element : String/HTMLElement/Ext.Element
The element to get the offsets from.
\n

Returns

Number[]
The XY page offsets (e.g. [100, -200])
\n

Overrides: Ext.dom.AbstractElement.getOffsetsTo

Ext.dom.AbstractElement
view source

getPadding( String side ) : Number

Gets the width of the padding(s) for the specified side(s) ...

Gets the width 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,\npassing 'lr' would get the padding left + the padding right.
\n

Returns

Number
The padding of the sides passed added together
\n

Ext.dom.AbstractElement
view source

getPageBox( [Boolean asRegion] ) : Object

Return an object defining the area of this Element which can be passed to setBox to\nset another Element's size/locati...

Return an object defining the area of this Element which can be passed to setBox to\nset another Element's size/location to match this element.

Parameters

asRegion : Boolean (optional)
If true an Ext.util.Region will be returned
\n

Returns

Object

box An object in the format

\n\n

{\n    left: <Element's X position>,\n    top: <Element's Y position>,\n    width: <Element's width>,\n    height: <Element's height>,\n    bottom: <Element's lower bound>,\n    right: <Element's rightmost bound>\n}\n

\n\n

The returned object may also be addressed as an Array where index 0 contains the X position\nand index 1 contains the Y position. So the result may also be used for setXY

Ext.dom.Element
view source

getPositioning( ) : Object

Gets an object with all CSS positioning properties. ...

Gets an object with all CSS positioning properties. Useful along with #setPostioning to get\nsnapshot before performing an update and then restoring the element.

Returns

Object
\n

Ext.dom.Element
view source

getRegion( ) : Ext.util.Region

Returns the region of this element. ...

Returns the region of this element.\nThe element must be part of the DOM tree to have a region\n(display:none or elements not appended return false).

Returns

Ext.util.Region
A Region containing \"top, left, bottom, right\" member data.
\n

Ext.dom.AbstractElement
view source

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
\n

Returns

Number
\n

Ext.dom.AbstractElement
view source

getRightMarginFixCleaner( Ext.dom.Element target )private

Creates a function to call to clean up problems with the work-around for the\nWebKit RightMargin bug. ...

Creates a function to call to clean up problems with the work-around for the\nWebKit RightMargin bug. The work-around is to add \"display: 'inline-block'\" to\nthe element before calling getComputedStyle and then to restore its original\ndisplay value. The problem with this is that it corrupts the selection of an\nINPUT or TEXTAREA element (as in the \"I-beam\" goes away but ths focus remains).\nTo cleanup after this, we need to capture the selection of any such element and\nthen restore it after we have restored the display style.

Parameters

target : Ext.dom.Element
The top-most element being adjusted.
\n

Ext.dom.Element
view source

getScopeParent( ) : HTMLElementprotected

Gets the parent node of the current element taking into account Ext.scopeResetCSS ...

Gets the parent node of the current element taking into account Ext.scopeResetCSS

Returns

HTMLElement
The parent element
\n

Ext.dom.Element
view source

getScroll( ) : Object

Returns the current scroll position of the element. ...

Returns the current scroll position of the element.

Returns

Object
An object containing the scroll position in the format\n{left: (scrollLeft), top: (scrollTop)}
\n

Ext.dom.AbstractElement
view source

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
\n

Returns

Object
An object containing the element's size:
\n
- width : Number
- height : Number

Ext.dom.AbstractElement
view source

getStyle( String/String[] property, [Boolean inline] ) : String/Object

Returns a named style property based on computed/currentStyle (primary) and\ninline-style if primary is not available. ...

Returns a named style property based on computed/currentStyle (primary) and\ninline-style if primary is not available.

Parameters

property : String/String[]
The style property (or multiple property names\nin an array) whose value is returned.
\n
inline : Boolean (optional)
if true only inline styles will be returned.
\n
Defaults to: false

Returns

String/Object
The current value of the style property for this element\n(or a hash of named style values if multiple property arguments are requested).
\n

Ext.dom.Element
view source

getStyleSize( ) : Object

Returns the dimensions of the element available to lay content out in. ...

Returns the dimensions of the element available to lay content out in.

\n\n

getStyleSize utilizes prefers style sizing if present, otherwise it chooses the larger of offsetHeight/clientHeight and\noffsetWidth/clientWidth. To obtain the size excluding scrollbars, use getViewSize.

\n\n

Sizing of the document body is handled at the adapter level which handles special cases for IE and strict modes, etc.

Returns

Object
Object describing width and height.
\n
- width : Number
- height : Number

Ext.dom.Element
view source

getTextWidth( String text, [Number min], [Number max] ) : Number

Returns the width in pixels of the passed text, or the width of the text in this Element. ...

Returns the width in pixels of the passed text, or the width of the text in this Element.

Parameters

text : String
The text to measure. Defaults to the innerHTML of the element.
\n
min : Number (optional)
The minumum value to return.
\n
max : Number (optional)
The maximum value to return.
\n

Returns

Number
The text width in pixels.
\n

Ext.dom.AbstractElement
view source

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
\n

Returns

Number
\n

Ext.dom.AbstractElement
view source

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
\n

Returns

String/Number
\n

Ext.dom.Element
view source

getViewRegion( ) : Ext.util.Region

Returns the content region of this element. ...

Returns the content region of this element. That is the region within the borders and padding.

Returns

Ext.util.Region
A Region containing \"top, left, bottom, right\" member data.
\n

Ext.dom.AbstractElement
view source

getViewSize( ) : Object

Returns the dimensions of the element available to lay content out in. ...

Returns the dimensions of the element available to lay content out in.

\n\n

If the element (or any ancestor element) has CSS style display: none, the dimensions will be zero.

\n\n

Example:

\n\n

var vpSize = Ext.getBody().getViewSize();\n\n// all Windows created afterwards will have a default value of 90% height and 95% width\nExt.Window.override({\n    width: vpSize.width * 0.9,\n    height: vpSize.height * 0.95\n});\n// To handle window resizing you would have to hook onto onWindowResize.\n

\n\n

getViewSize utilizes clientHeight/clientWidth which excludes sizing of scrollbars.\nTo obtain the size including scrollbars, use getStyleSize

\n\n

Sizing of the document body is handled at the adapter level which handles special cases for IE and strict modes, etc.

Returns

Object
Object describing width and height.
\n
- width : Number
- height : Number

Ext.dom.AbstractElement
view source

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
\n

Returns

Number
The element's width
\n

Ext.dom.AbstractElement
view source

getX( Object el ) : Number

Gets the current X position of the element based on page coordinates. ...

Gets the current X position of the element based on page coordinates. Element must be part of the DOM\ntree to have page coordinates (display:none or elements not appended return false).

Parameters

el : Object
\n

Returns

Number
The X position of the element
\n

Ext.dom.Element
view source

getXY( ) : Number[]

Gets the current position of the element based on page coordinates. ...

Gets the current position of the element based on page coordinates.\nElement must be part of the DOM tree to have page coordinates\n(display:none or elements not appended return false).

Returns

Number[]
The XY position of the element
\n

Overrides: Ext.dom.AbstractElement.getXY

Ext.dom.AbstractElement
view source

getY( Object el ) : Number

Gets the current Y position of the element based on page coordinates. ...

Gets the current Y position of the element based on page coordinates. Element must be part of the DOM\ntree to have page coordinates (display:none or elements not appended return false).

Parameters

el : Object
\n

Returns

Number
The Y position of the element
\n

Ext.dom.Element
view source

ghost( [String anchor], [Object options] ) : Ext.dom.Element

Slides the element while fading it out of view. ...

Slides the element while fading it out of view. An anchor point can be optionally passed to set the ending point\nof the effect. Usage:

\n\n

// default: slide the element downward while fading out\nel.ghost();\n\n// custom: slide the element out to the right with a 2-second duration\nel.ghost('r', { duration: 2000 });\n\n// common config options shown with default values\nel.ghost('b', {\n    easing: 'easeOut',\n    duration: 500\n});\n

Parameters

anchor : String (optional)
One of the valid Fx anchor positions (defaults to bottom: 'b')
\n
options : Object (optional)
Object literal with any of the Fx config options
\n

Returns

Ext.dom.Element
The Element
\n

Ext.dom.AbstractElement
view source

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
\n

Returns

Boolean
True if the class exists, else false
\n

Ext.Base
view source

hasConfig( Object config )private

...

Parameters

config : Object
\n

Ext.dom.Element
view source

hasMetrics( )private

Determine if the Element has a relevant height and width available based\nupon current logical visibility state ...

Determine if the Element has a relevant height and width available based\nupon current logical visibility state

Ext.dom.Element
view source

hide( [Boolean/Object animate] ) : Ext.dom.Element

Hide this element - Uses display mode to determine whether to use \"display\" or \"visibility\". ...

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
\n

Returns

Ext.dom.Element
this
\n

Overrides: Ext.dom.AbstractElement.hide

Ext.dom.Element
view source

highlight( [String color], [Object options] ) : Ext.dom.Element

Highlights the Element by setting a color (applies to the background-color by default, but can be changed using\nthe \"...

Highlights the Element by setting a color (applies to the background-color by default, but can be changed using\nthe \"attr\" config option) and then fading back to the original color. If no original color is available, you\nshould provide the \"endColor\" config option which will be cleared after the animation. Usage:

\n\n

// default: highlight background to yellow\nel.highlight();\n\n// custom: highlight foreground text to blue for 2 seconds\nel.highlight(\"0000ff\", { attr: 'color', duration: 2000 });\n\n// common config options shown with default values\nel.highlight(\"ffff9c\", {\n    attr: \"backgroundColor\", //can be any valid CSS property (attribute) that supports a color value\n    endColor: (current color) or \"ffffff\",\n    easing: 'easeIn',\n    duration: 1000\n});\n

Parameters

color : String (optional)
The highlight color. Should be a 6 char hex color without the leading #\n(defaults to yellow: 'ffff9c')
\n
options : Object (optional)
Object literal with any of the Fx config options
\n

Returns

Ext.dom.Element
The Element
\n

Ext.dom.Element
view source

hover( Function overFn, Function outFn, [Object scope], [Object options] ) : Ext.dom.Element

Sets up event handlers to call the passed functions when the mouse is moved into and out of the Element. ...

Sets up event handlers to call the passed functions when the mouse is moved into and out of the Element.

Parameters

overFn : Function
The function to call when the mouse enters the Element.
\n
outFn : Function
The function to call when the mouse leaves the Element.
\n
scope : Object (optional)
The scope (this reference) in which the functions are executed. Defaults\nto the Element's DOM element.
\n
options : Object (optional)
Options for the listener. See the\noptions parameter.
\n

Returns

Ext.dom.Element
this
\n

Ext.Base
view source

initConfig( Object config ) : Ext.Baseprotected

Initialize configuration for this class. ...

Initialize configuration for this class. a typical example:

\n\n

Ext.define('My.awesome.Class', {\n    // The default config\n    config: {\n        name: 'Awesome',\n        isAwesome: true\n    },\n\n    constructor: function(config) {\n        this.initConfig(config);\n    }\n});\n\nvar awesome = new My.awesome.Class({\n    name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n

Parameters

config : Object
\n

Returns

Ext.Base
this
\n

Ext.dom.Element
view source

initDD( String group, Object config, Object overrides ) : Ext.dd.DD

Initializes a Ext.dd.DD drag drop object for this element. ...

Initializes a Ext.dd.DD drag drop object for this element.

Parameters

group : String
The group the DD object is member of
\n
config : Object
The DD config object
\n
overrides : Object
An object containing methods to override/implement on the DD object
\n

Returns

Ext.dd.DD
The DD object
\n

Ext.dom.Element
view source

initDDProxy( String group, Object config, Object overrides ) : Ext.dd.DDProxy

Initializes a Ext.dd.DDProxy object for this element. ...

Initializes a Ext.dd.DDProxy object for this element.

Parameters

group : String
The group the DDProxy object is member of
\n
config : Object
The DDProxy config object
\n
overrides : Object
An object containing methods to override/implement on the DDProxy object
\n

Returns

Ext.dd.DDProxy
The DDProxy object
\n

Ext.dom.Element
view source

initDDTarget( String group, Object config, Object overrides ) : Ext.dd.DDTarget

Initializes a Ext.dd.DDTarget object for this element. ...

Initializes a Ext.dd.DDTarget object for this element.

Parameters

group : String
The group the DDTarget object is member of
\n
config : Object
The DDTarget config object
\n
overrides : Object
An object containing methods to override/implement on the DDTarget object
\n

Returns

Ext.dd.DDTarget
The DDTarget object
\n

Ext.dom.AbstractElement
view source

insertAfter( String/HTMLElement/Ext.dom.AbstractElement el ) : Ext.dom.AbstractElement

Inserts this element after the passed element in the DOM ...

Inserts this element after the passed element in the DOM

Parameters

el : String/HTMLElement/Ext.dom.AbstractElement
The element to insert after.\nThe id of the node, a DOM Node or an existing Element.
\n

Returns

Ext.dom.AbstractElement
This element
\n

Ext.dom.AbstractElement
view source

insertBefore( String/HTMLElement/Ext.dom.AbstractElement el ) : Ext.dom.AbstractElement

Inserts this element before the passed element in the DOM ...

Inserts this element before the passed element in the DOM

Parameters

el : String/HTMLElement/Ext.dom.AbstractElement
The element before which this element will be inserted.\nThe id of the node, a DOM Node or an existing Element.
\n

Returns

Ext.dom.AbstractElement
This element
\n

Ext.dom.AbstractElement
view source

insertFirst( String/HTMLElement/Ext.dom.AbstractElement/Object el ) : Ext.dom.AbstractElement

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 : String/HTMLElement/Ext.dom.AbstractElement/Object
The id or element to insert or a DomHelper config\nto create and insert
\n

Returns

Ext.dom.AbstractElement
The new child
\n

Ext.dom.AbstractElement
view source

insertHtml( String where, String html, [Boolean returnEl] ) : HTMLElement/Ext.dom.AbstractElement

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.\nSee Ext.dom.Helper.insertHtml for details.
\n
html : String
The HTML fragment
\n
returnEl : Boolean (optional)
True to return an Ext.dom.AbstractElement
\n
Defaults to: false

Returns

HTMLElement/Ext.dom.AbstractElement
The inserted node (or nearest related if more than 1 inserted)
\n

Ext.dom.AbstractElement
view source

insertSibling( String/HTMLElement/Ext.dom.AbstractElement/Object/Array el, [String where], [Boolean returnDom] ) : Ext.dom.AbstractElement

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 : String/HTMLElement/Ext.dom.AbstractElement/Object/Array
The id, element to insert or a DomHelper config\nto create and insert or an array of any of those.
\n
where : String (optional)
'before' or 'after'
\n
Defaults to: "before"
returnDom : Boolean (optional)
True to return the .;ll;l,raw DOM element instead of Ext.dom.AbstractElement
\n
Defaults to: false

Returns

Ext.dom.AbstractElement
The inserted Element. If an array is passed, the last inserted element is returned.
\n

Ext.dom.AbstractElement
view source

is( String selector ) : Boolean

Returns true if this element matches the passed simple selector (e.g. ...

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
\n

Returns

Boolean
True if this element matches the selector, else false
\n

Ext.dom.Element
view source

isBorderBox( ) : Boolean

Tests various css rules/browsers to determine if this element uses a border box ...

Tests various css rules/browsers to determine if this element uses a border box

Returns

Boolean
\n

Ext.dom.Element
view source

isDisplayed( ) : Boolean

Returns true if display is not \"none\" ...

Returns true if display is not \"none\"

Returns

Boolean
\n

Ext.dom.Element
view source

isMasked( ) : Boolean

Returns true if this element is masked. ...

Returns true if this element is masked. Also re-centers any displayed message within the mask.

Returns

Boolean
\n

Ext.dom.Element
view source

isScrollable( ) : Boolean

Returns true if this element is scrollable. ...

Returns true if this element is scrollable.

Returns

Boolean
\n

Ext.dom.AbstractElement
view source

isStyle( String style, String value ) : Boolean

Checks if the current value of a style is equal to a given value. ...

Checks if the current value of a style is equal to a given value.

Parameters

style : String
property whose value is returned.
\n
value : String
to check against.
\n

Returns

Boolean
true for when the current value equals the given value.
\n

Ext.dom.AbstractElement
view source

isTransparent( String prop ) : Boolean

Returns true if the value of the given property is visually transparent. ...

Returns true if the value of the given property is visually transparent. This\nmay be due to a 'transparent' style value or an rgba value with 0 in the alpha\ncomponent.

Parameters

prop : String
The style property whose value is to be tested.
\n

Returns

Boolean
True if the style property is visually transparent.
\n

Ext.dom.Element
view source

isVisible( [Boolean deep] ) : Boolean

Checks whether the element is currently visible using both visibility and display properties. ...

Checks whether the element is currently visible using both visibility and display properties.

Parameters

deep : Boolean (optional)
True to walk the dom and see if parent elements are hidden.\nIf false, the function only checks the visibility of the element itself and it may return\ntrue even though a parent is not visible.
\n
Defaults to: false

Returns

Boolean
true if the element is currently visible, else false
\n

Ext.dom.AbstractElement
view source

last( [String selector], [Boolean returnDom] ) : Ext.dom.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
\n
returnDom : Boolean (optional)
True to return a raw dom node instead of an Ext.dom.Element
\n
Defaults to: false

Returns

Ext.dom.Element/HTMLElement
The last child or null
\n

Ext.dom.Element
view source

load( Object options ) : Ext.dom.Element

Direct access to the Ext.ElementLoader Ext.ElementLoader.load method. ...

Direct access to the Ext.ElementLoader Ext.ElementLoader.load method. The method takes the same object\nparameter as Ext.ElementLoader.load

Parameters

options : Object
\n

Returns

Ext.dom.Element
this
\n

Ext.dom.Element
view source

mask( [String msg], [String msgCls] ) : Ext.dom.Element

Puts a mask over this element to disable user interaction. ...

Puts a mask over this element to disable user interaction. Requires core.css.\nThis method can only be applied to elements which accept child nodes.

Parameters

msg : String (optional)
A message to display in the mask
\n
msgCls : String (optional)
A css class to apply to the msg element
\n

Returns

Ext.dom.Element
The mask element
\n

Overrides: Ext.dom.AbstractElement.mask

Ext.dom.Element
view source

monitorMouseLeave( Number delay, Function handler, [Object scope] ) : Object

Monitors this Element for the mouse leaving. ...

Monitors this Element for the mouse leaving. Calls the function after the specified delay only if\nthe mouse was not moved back into the Element within the delay. If the mouse was moved\nback in, the function is not called.

Parameters

delay : Number
The delay in milliseconds to wait for possible mouse re-entry before calling the handler function.
\n
handler : Function
The function to call if the mouse remains outside of this Element for the specified time.
\n
scope : Object (optional)
The scope (this reference) in which the handler function executes. Defaults to this Element.
\n

Returns

Object

The listeners object which was added to this element so that monitoring can be stopped. Example usage:

\n\n

// Hide the menu if the mouse moves out for 250ms or more\nthis.mouseLeaveMonitor = this.menuEl.monitorMouseLeave(250, this.hideMenu, this);\n\n...\n// Remove mouseleave monitor on menu destroy\nthis.menuEl.un(this.mouseLeaveMonitor);\n

Ext.dom.Element
view source

move( String direction, Number distance, [Boolean/Object animate] )

Move this element relative to its current position. ...

Move this element relative to its current position.

Parameters

direction : String
Possible values are:
\n\n
- \"l\" (or \"left\")
- \"r\" (or \"right\")
- \"t\" (or \"top\", or \"up\")
- \"b\" (or \"bottom\", or \"down\")
\n\n
distance : Number
How far to move the element in pixels
\n
animate : Boolean/Object (optional)
true for the default animation or a standard Element\nanimation config object
\n

Ext.dom.Element
view source

moveTo( Number x, Number y, [Boolean/Object animate] ) : Ext.dom.AbstractElement

Sets the position of the element in page coordinates, regardless of how the element\nis positioned. ...

Sets the position of the element in page coordinates, regardless of how the element\nis positioned. The element must be part of the DOM tree to have page coordinates\n(display:none or elements not appended return false).

Parameters

x : Number
X value for new position (coordinates are page-based)
\n
y : Number
Y value for new position (coordinates are page-based)
\n
animate : Boolean/Object (optional)
True for the default animation, or a standard Element\nanimation config object
\n

Returns

Ext.dom.AbstractElement
this
\n

Ext.dom.Element
view source

needsTabIndex( )

Returns true if this element needs an explicit tabIndex to make it focusable. ...

Returns true if this element needs an explicit tabIndex to make it focusable. Input fields, text areas, buttons\nanchors elements with an href etc do not need a tabIndex, but structural elements do.

Ext.dom.AbstractElement
view source

next( [String selector], [Boolean returnDom] ) : Ext.dom.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
\n
returnDom : Boolean (optional)
True to return a raw dom node instead of an Ext.dom.Element
\n
Defaults to: false

Returns

Ext.dom.Element/HTMLElement
The next sibling or null
\n

Ext.dom.Element
view source

on( String eventName, Function fn, [Object scope], [Object options] ) : Ext.dom.Element

Appends an event handler to this element. ...

Appends an event handler to this element.

Parameters

eventName : String
The name of event to handle.
\n\n
fn : Function
The handler function the event invokes. This function is passed the following parameters:
\n\n\n\n\n
- evt : EventObject
  \n\n
  The EventObject describing the event.
- el : HtmlElement
  \n\n
  The DOM element which was the target of the event. Note that this may be filtered by using the delegate option.
- o : Object
  \n\n
  The options object from the call that setup the listener.
\n\n\n\n
scope : Object (optional)
The scope (this reference) in which the handler function is executed. If\nomitted, defaults to this Element.
\n\n
options : Object (optional)
An object containing handler configuration properties. This may contain any of\nthe following properties:
\n\n\n\n\n
- scope Object :
  \n\n
  The scope (this reference) in which the handler function is executed. If omitted, defaults to this\nElement.
- delegate String:
  \n\n
  A simple selector to filter the target or look for a descendant of the target. See below for additional details.
- stopEvent Boolean:
  \n\n
  True to stop the event. That is stop propagation, and prevent the default action.
- preventDefault Boolean:
  \n\n
  True to prevent the default action
- stopPropagation Boolean:
  \n\n
  True to prevent event propagation
- normalized Boolean:
  \n\n
  False to pass a browser event to the handler function instead of an Ext.EventObject
- target Ext.dom.Element:
  \n\n
  Only call the handler if the event was fired on the target Element, not if the event was bubbled up from a\nchild node.
- delay Number:
  \n\n
  The number of milliseconds to delay the invocation of the handler after the event fires.
- single Boolean:
  \n\n
  True to add a handler to handle just the next firing of the event, and then remove itself.
- buffer Number:
  \n\n
  Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is not invoked, but the new\nhandler is scheduled in its place.
\n\n\n\n\n
Combining Options
\n\n\n\n\n
Using the options argument, it is possible to combine different types of listeners:
\n\n\n\n\n
A delayed, one-time listener that auto stops the event and adds a custom argument (forumId) to the options\nobject. The options object is available as the third parameter in the handler function.
\n\n\n\n\n
Code:
\n\n\n\n\n
```
el.on('click', this.onClick, this, {\n    single: true,\n    delay: 100,\n    stopEvent : true,\n    forumId: 4\n});\n
```
\n\n\n\n\n
Attaching multiple handlers in 1 call
\n\n\n\n\n
The method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple handlers.
\n\n\n\n\n
Code:
\n\n\n\n\n
```
el.on({\n    'click' : {\n        fn: this.onClick,\n        scope: this,\n        delay: 100\n    },\n    'mouseover' : {\n        fn: this.onMouseOver,\n        scope: this\n    },\n    'mouseout' : {\n        fn: this.onMouseOut,\n        scope: this\n    }\n});\n
```
\n\n\n\n\n
Or a shorthand syntax:
\n\n\n\n\n
Code:
\n\n\n\n\n
```
el.on({\n    'click' : this.onClick,\n    'mouseover' : this.onMouseOver,\n    'mouseout' : this.onMouseOut,\n    scope: this\n});\n
```
\n\n\n\n\n
delegate
\n\n\n\n\n
This is a configuration option that you can pass along when registering a handler for an event to assist with\nevent delegation. Event delegation is a technique that is used to reduce memory consumption and prevent exposure\nto memory-leaks. By registering an event for a container element as opposed to each element within a container.\nBy setting this configuration option to a simple selector, the target element will be filtered to look for a\ndescendant of the target. For example:
\n\n\n\n\n
```
// using this markup:\n<div id='elId'>\n    <p id='p1'>paragraph one</p>\n    <p id='p2' class='clickable'>paragraph two</p>\n    <p id='p3'>paragraph three</p>\n</div>\n\n// utilize event delegation to registering just one handler on the container element:\nel = Ext.get('elId');\nel.on(\n    'click',\n    function(e,t) {\n        // handle click\n        console.info(t.id); // 'p2'\n    },\n    this,\n    {\n        // filter the target element to be a descendant with the class 'clickable'\n        delegate: '.clickable'\n    }\n);\n
```
\n\n

Returns

Ext.dom.Element
this
\n\n

Ext.Base
view source

onConfigUpdate( Object names, Object callback, Object scope )private

...

Parameters

names : Object
\n
callback : Object
\n
scope : Object
\n

Ext.dom.AbstractElement
view source

parent( [String selector], [Boolean returnDom] ) : Ext.dom.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
\n
returnDom : Boolean (optional)
True to return a raw dom node instead of an Ext.dom.Element
\n
Defaults to: false

Returns

Ext.dom.Element/HTMLElement
The parent node or null
\n

Ext.dom.Element
view source

pause( Number seconds ) : Ext.Elementdeprecated

Creates a pause before any subsequent queued effects begin. ...

Creates a pause before any subsequent queued effects begin. If there are no effects queued after the pause it will\nhave no effect. Usage:

\n\n

el.pause(1);\n

This method has been deprecated since 4.0

Use the delay config to animate instead.

\n\n

Parameters

seconds : Number
The length of time to pause (in seconds)
\n

Returns

Ext.Element
The Element
\n

Ext.dom.AbstractElement
view source

populateStyleMap( Object map, Object order )

Creates mappings for 'margin-before' to 'marginLeft' (etc.) given the output\nmap and an ordering pair (e.g., ['left',...

Creates mappings for 'margin-before' to 'marginLeft' (etc.) given the output\nmap and an ordering pair (e.g., ['left', 'right']). The ordering pair is in\nbefore/after order.

Parameters

map : Object
\n
order : Object
\n

Ext.dom.Element
view source

position( [String pos], [Number zIndex], [Number x], [Number y] )

Initializes positioning on this element. ...

Initializes positioning on this element. If a desired position is not passed, it will make the\nthe element positioned relative IF it is not already positioned.

Parameters

pos : String (optional)
Positioning to use \"relative\", \"absolute\" or \"fixed\"
\n
zIndex : Number (optional)
The zIndex to apply
\n
x : Number (optional)
Set the page X position
\n
y : Number (optional)
Set the page Y position
\n

Ext.dom.AbstractElement
view source

prev( [String selector], [Boolean returnDom] ) : Ext.dom.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
\n
returnDom : Boolean (optional)
True to return a raw dom node instead of an Ext.dom.Element
\n
Defaults to: false

Returns

Ext.dom.Element/HTMLElement
The previous sibling or null
\n

Ext.dom.Element
view source

puff( [Object options] ) : Ext.dom.Element

Fades the element out while slowly expanding it in all directions. ...

Fades the element out while slowly expanding it in all directions. When the effect is completed, the element will\nbe hidden (visibility = 'hidden') but block elements will still take up space in the document. Usage:

\n\n

// default\nel.puff();\n\n// common config options shown with default values\nel.puff({\n    easing: 'easeOut',\n    duration: 500,\n    useDisplay: false\n});\n

Parameters

options : Object (optional)
Object literal with any of the Fx config options
\n

Returns

Ext.dom.Element
The Element
\n

Ext.dom.Element
view source

purgeAllListeners( ) : Ext.dom.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

Returns

Ext.dom.Element
this
\n

Ext.dom.AbstractElement
view source

query( String selector ) : HTMLElement[]

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
\n

Returns

HTMLElement[]
An array of the matched nodes
\n

Ext.dom.AbstractElement
view source

radioCls( String/String[] className ) : Ext.dom.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/String[]
The CSS class to add, or an array of classes
\n

Returns

Ext.dom.Element
this
\n

Ext.dom.Element
view source

relayEvent( String eventName, Object observable )

Create an event handler on this element such that when the event fires and is handled by this element,\nit will be rel...

Create an event handler on this element such that when the event fires and is handled by this element,\nit will be relayed to another object (i.e., fired again as if it originated from that object instead).

Parameters

eventName : String
The type of event to relay
\n
observable : Object
Any object that extends Ext.util.Observable that will provide the context\nfor firing the relayed event
\n

Ext.dom.AbstractElement
view source

remove( )

Removes this element's dom reference. ...

Removes this element's dom reference. Note that event and cache removal is handled at Ext.removeNode

Ext.dom.Element
view source

removeAllListeners( ) : Ext.dom.Element

Removes all previous added listeners from this element ...

Removes all previous added listeners from this element

Returns

Ext.dom.Element
this
\n\n

Ext.dom.Element
view source

removeAnchor( ) : Ext.dom.Element

Remove any anchor to this element. ...

Remove any anchor to this element. See anchorTo.

Returns

Ext.dom.Element
this
\n

Ext.dom.AbstractElement
view source

removeCls( String/String[] className ) : Ext.dom.Element

Removes one or more CSS classes from the element. ...

Removes one or more CSS classes from the element.

Parameters

className : String/String[]
The CSS classes to remove separated by space, or an array of classes
\n

Returns

Ext.dom.Element
this
\n

Ext.dom.Element
view source

removeListener( String eventName, Function fn, Object scope ) : Ext.dom.Element

Shorthand for un. ...

Shorthand for un.

\n\n

Removes an event handler from this element.

\n\n

Note: if a scope was explicitly specified when adding the listener,\nthe same scope must be specified here.

\n\n

Example:

\n\n

el.un('click', this.handlerFn);\n// or\nel.removeListener('click', this.handlerFn);\n

Parameters

eventName : String
The name of the event from which to remove the handler.
\n\n
fn : Function
The handler function to remove. This must be a reference to the function passed into the\non call.
\n\n
scope : Object
If a scope (this reference) was specified when the listener was added, then this must\nrefer to the same object.
\n\n

Returns

Ext.dom.Element
this
\n\n

Ext.dom.AbstractElement
view source

repaint( ) : Ext.dom.Element

Forces the browser to repaint this element ...

Forces the browser to repaint this element

Returns

Ext.dom.Element
this
\n

Ext.dom.AbstractElement
view source

replace( String/HTMLElement/Ext.dom.AbstractElement el ) : Ext.dom.AbstractElement

Replaces the passed element with this element ...

Replaces the passed element with this element

Parameters

el : String/HTMLElement/Ext.dom.AbstractElement
The element to replace.\nThe id of the node, a DOM Node or an existing Element.
\n

Returns

Ext.dom.AbstractElement
This element
\n

Ext.dom.AbstractElement
view source

replaceCls( String oldClassName, String newClassName ) : Ext.dom.Element

Replaces a CSS class on the element with another. ...

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
\n
newClassName : String
The replacement CSS class
\n

Returns

Ext.dom.Element
this
\n

Ext.dom.AbstractElement
view source

replaceWith( String/HTMLElement/Ext.dom.AbstractElement/Object el ) : Ext.dom.AbstractElement

Replaces this element with the passed element ...

Replaces this element with the passed element

Parameters

el : String/HTMLElement/Ext.dom.AbstractElement/Object
The new element (id of the node, a DOM Node\nor an existing Element) or a DomHelper config of an element to create
\n

Returns

Ext.dom.AbstractElement
This element
\n

Ext.dom.Element
view source

scale( Number width, Number height, [Object options] ) : Ext.Elementdeprecated

Animates the transition of an element's dimensions from a starting height/width to an ending height/width. ...

Animates the transition of an element's dimensions from a starting height/width to an ending height/width. This\nmethod is a convenience implementation of shift. Usage:

\n\n

// change height and width to 100x100 pixels\nel.scale(100, 100);\n\n// common config options shown with default values.  The height and width will default to\n// the element's existing values if passed as null.\nel.scale(\n    [element's width],\n    [element's height], {\n        easing: 'easeOut',\n        duration: 350\n    }\n);\n

This method has been deprecated since 4.0

Just use animate instead.

\n\n

Parameters

width : Number
The new width (pass undefined to keep the original width)
\n
height : Number
The new height (pass undefined to keep the original height)
\n
options : Object (optional)
Object literal with any of the Fx config options
\n

Returns

Ext.Element
The Element
\n

Ext.dom.Element
view source

scroll( String direction, Number distance, [Boolean/Object animate] ) : Boolean

Scrolls this element the specified direction. ...

Scrolls this element the specified direction. Does bounds checking to make sure the scroll is\nwithin this element's scrollable range.

Parameters

direction : String
Possible values are:
\n\n
- \"l\" (or \"left\")
- \"r\" (or \"right\")
- \"t\" (or \"top\", or \"up\")
- \"b\" (or \"bottom\", or \"down\")
\n\n
distance : Number
How far to scroll the element in pixels
\n
animate : Boolean/Object (optional)
true for the default animation or a standard Element\nanimation config object
\n

Returns

Boolean
Returns true if a scroll was triggered or false if the element\nwas scrolled as far as it could go.
\n

Ext.dom.Element
view source

scrollBy( Number/Number[]/Object deltaX, Number/Boolean/Object deltaY, Boolean/Object animate ) : Ext.Element

Scrolls this element by the passed delta values, optionally animating. ...

Scrolls this element by the passed delta values, optionally animating.

\n\n

All of the following are equivalent:

\n\n

 el.scrollBy(10, 10, true);\n el.scrollBy([10, 10], true);\n el.scrollBy({ x: 10, y: 10 }, true);\n

Parameters

deltaX : Number/Number[]/Object
Either the x delta, an Array specifying x and y deltas or\nan object with \"x\" and \"y\" properties.
\n
deltaY : Number/Boolean/Object
Either the y delta, or an animate flag or config object.
\n
animate : Boolean/Object
Animate flag/config object if the delta values were passed separately.
\n

Returns

Ext.Element
this
\n

Ext.dom.Element
view source

scrollIntoView( [String/HTMLElement/Ext.Element container], [Boolean hscroll], [Boolean/Object animate] ) : Ext.dom.Element

Scrolls this element into view within the passed container. ...

Scrolls this element into view within the passed container.

Parameters

container : String/HTMLElement/Ext.Element (optional)
The container element\nto scroll. Should be a string (id), dom node, or Ext.Element.
\n
Defaults to: document.body
hscroll : Boolean (optional)
False to disable horizontal scroll.
\n
Defaults to: true
animate : Boolean/Object (optional)
true for the default animation or a standard Element\nanimation config object
\n

Returns

Ext.dom.Element
this
\n

Ext.dom.Element
view source

scrollTo( String side, Number value, [Boolean/Object animate] ) : Ext.Element

Scrolls this element the specified scroll point. ...

Scrolls this element the specified scroll point. It does NOT do bounds checking so\nif you scroll to a weird value it will try to do it. For auto bounds checking, use scroll.

Parameters

side : String
Either \"left\" for scrollLeft values or \"top\" for scrollTop values.
\n
value : Number
The new scroll value
\n
animate : Boolean/Object (optional)
true for the default animation or a standard Element\nanimation config object
\n

Returns

Ext.Element
this
\n

Ext.dom.AbstractElement
view source

select( String selector, [Boolean unique] ) : Ext.CompositeElement

Creates a Ext.CompositeElement for child nodes based on the passed CSS selector (the selector should not contain an id). ...

Creates a Ext.CompositeElement for child nodes based on the passed CSS selector (the selector should not contain an id).

Parameters

selector : String
The CSS selector
\n
unique : Boolean (optional)
True to create a unique Ext.Element for each element. Defaults to a shared flyweight object.
\n

Returns

Ext.CompositeElement
The composite element
\n

Ext.dom.Element
view source

selectable( ) : Ext.Element

Enable text selection for this element (normalized across browsers) ...

Enable text selection for this element (normalized across browsers)

Returns

Ext.Element
this
\n

Ext.dom.AbstractElement
view source

serializeForm( Object form ) : String

Serializes a DOM form into a url encoded string ...

Serializes a DOM form into a url encoded string

Parameters

form : Object
The form
\n

Returns

String
The url encoded form
\n

Ext.dom.AbstractElement
view source

set( Object o, [Boolean useSet] ) : Ext.dom.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
\n
useSet : Boolean (optional)
false to override the default setAttribute to use expandos.
\n
Defaults to: true

Returns

Ext.dom.Element
this
\n

Ext.dom.AbstractElement
view source

setBottom( String bottom ) : Ext.dom.AbstractElement

Sets the element's CSS bottom style. ...

Sets the element's CSS bottom style.

Parameters

bottom : String
The bottom CSS property value
\n

Returns

Ext.dom.AbstractElement
this
\n

Ext.dom.Element
view source

setBounds( Number x, Number y, Number/String width, Number/String height, [Boolean/Object animate] ) : Ext.dom.AbstractElement

Sets the element's position and size in one shot. ...

Sets the element's position and size in one shot. If animation is true then width, height,\nx and y will be animated concurrently.

Parameters

x : Number
X value for new position (coordinates are page-based)
\n
y : Number
Y value for new position (coordinates are page-based)
\n
width : Number/String
The new width. This may be one of:
\n\n
- 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.
\n\n
height : Number/String
The new height. This may be one of:
\n\n
- 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.
\n\n
animate : Boolean/Object (optional)
true for the default animation or a standard Element\nanimation config object
\n

Returns

Ext.dom.AbstractElement
this
\n

Ext.dom.AbstractElement
view source

setBox( Object box, [Boolean adjust], [Boolean/Object animate] ) : Ext.dom.AbstractElement

Sets the element's box. ...

Sets the element's box. Use getBox() on another element to get a box obj.\nIf animate is true then width, height, x and y will be animated concurrently.

Parameters

box : Object
The box to fill {x, y, width, height}
\n
adjust : Boolean (optional)
Whether to adjust for box-model issues automatically
\n
animate : Boolean/Object (optional)
true for the default animation or a standard\nElement animation config object
\n

Returns

Ext.dom.AbstractElement
this
\n

Ext.Base
view source

setConfig( Object config, Object applyIfNotSet )private

...

Parameters

config : Object
\n
applyIfNotSet : Object
\n

Ext.dom.Element
view source

setDisplayed( Boolean/String value ) : Ext.dom.Element

Sets the CSS display property. ...

Sets the CSS display property. Uses originalDisplay if the specified value is a boolean true.

Parameters

value : Boolean/String
Boolean value to display the element using its default display, or a string to set the display directly.
\n

Returns

Ext.dom.Element
this
\n

Ext.dom.AbstractElement
view source

setHTML( String html ) : Ext.Element

Set the innerHTML of this element ...

Set the innerHTML of this element

Parameters

html : String
The new HTML
\n

Returns

Ext.Element
this
\n

Ext.dom.AbstractElement
view source

setHeight( Number/String height, [Boolean/Object animate] ) : Ext.dom.Element

Set the height of this Element. ...

Set the height of this Element.

\n\n

// change the height to 200px and animate with default configuration\nExt.fly('elementId').setHeight(200, true);\n\n// change the height to 150px and animate with a custom configuration\nExt.fly('elId').setHeight(150, {\n    duration : 500, // animation will have a duration of .5 seconds\n    // will change the content to \"finished\"\n    callback: function(){ this.update(\"finished\"); }\n});\n

Parameters

height : Number/String
The new height. This may be one of:
\n\n
- 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.
\n\n
animate : Boolean/Object (optional)
true for the default animation or a standard Element animation config object
\n

Returns

Ext.dom.Element
this
\n

Ext.dom.AbstractElement
view source

setLeft( String left ) : Ext.dom.AbstractElement

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
\n

Returns

Ext.dom.AbstractElement
this
\n

Ext.dom.Element
view source

setLeftTop( String left, String top ) : Ext.dom.Element

Conveniently sets left and top adding default units. ...

Conveniently sets left and top adding default units.

Parameters

left : String
The left CSS property value
\n
top : String
The top CSS property value
\n

Returns

Ext.dom.Element
this
\n

Ext.dom.Element
view source

setLocation( Number x, Number y, [Boolean/Object animate] ) : Ext.dom.AbstractElement

Sets the position of the element in page coordinates, regardless of how the element\nis positioned. ...

Parameters

x : Number
X value for new position (coordinates are page-based)
\n
y : Number
Y value for new position (coordinates are page-based)
\n
animate : Boolean/Object (optional)
True for the default animation, or a standard Element\nanimation config object
\n

Returns

Ext.dom.AbstractElement
this
\n

Ext.dom.Element
view source

setOpacity( Number opacity, [Boolean/Object animate] ) : Ext.dom.Element

Set the opacity of the element ...

Set the opacity of the element

Parameters

opacity : Number
The new opacity. 0 = transparent, .5 = 50% visibile, 1 = fully visible, etc
\n
animate : Boolean/Object (optional)
a standard Element animation config object or true for\nthe default animation ({duration: 350, easing: 'easeIn'})
\n

Returns

Ext.dom.Element
this
\n

Ext.dom.Element
view source

setPositioning( Object posCfg ) : Ext.dom.AbstractElement

Set positioning with an object returned by getPositioning. ...

Set positioning with an object returned by getPositioning.

Parameters

posCfg : Object
\n

Returns

Ext.dom.AbstractElement
this
\n

Ext.dom.Element
view source

setRegion( Ext.util.Region region, [Boolean/Object animate] ) : Ext.dom.AbstractElement

Sets the element's position and size the specified region. ...

Sets the element's position and size the specified region. If animation is true then width, height,\nx and y will be animated concurrently.

Parameters

region : Ext.util.Region
The region to fill
\n
animate : Boolean/Object (optional)
true for the default animation or a standard Element\nanimation config object
\n

Returns

Ext.dom.AbstractElement
this
\n

Ext.dom.AbstractElement
view source

setRight( String right ) : Ext.dom.AbstractElement

Sets the element's CSS right style. ...

Sets the element's CSS right style.

Parameters

right : String
The right CSS property value
\n

Returns

Ext.dom.AbstractElement
this
\n

Ext.dom.AbstractElement
view source

setSize( Number/String width, Number/String height, [Boolean/Object animate] ) : Ext.dom.Element

Set the size of this Element. ...

Set the size of this Element. If animation is true, both width and height will be animated concurrently.

Parameters

width : Number/String
The new width. This may be one of:
\n\n
- 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}.
\n\n
height : Number/String
The new height. This may be one of:
\n\n
- 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.
\n\n
animate : Boolean/Object (optional)
true for the default animation or a standard Element animation config object
\n

Returns

Ext.dom.Element
this
\n

Ext.dom.AbstractElement
view source

setStyle( String/Object property, [String value] ) : Ext.dom.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.
\n
value : String (optional)
The value to apply to the given property, or null if an object was passed.
\n

Returns

Ext.dom.Element
this
\n

Ext.dom.AbstractElement
view source

setTop( String top ) : Ext.dom.AbstractElement

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
\n

Returns

Ext.dom.AbstractElement
this
\n

Ext.dom.AbstractElement
view source

setVisibilityMode( Object mode )

Use this to change the visibility mode between VISIBILITY, DISPLAY, OFFSETS or ASCLASS. ...

Use this to change the visibility mode between VISIBILITY, DISPLAY, OFFSETS or ASCLASS.

Parameters

mode : Object
\n

Ext.dom.Element
view source

setVisible( Boolean visible, [Boolean/Object animate] ) : Ext.dom.Element

Sets the visibility of the element (see details). ...

Sets the visibility of the element (see details). If the visibilityMode is set to Element.DISPLAY, it will use\nthe 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
\n
animate : Boolean/Object (optional)
True for the default animation, or a standard Element animation config object
\n

Returns

Ext.dom.Element
this
\n

Overrides: Ext.dom.AbstractElement.setVisible

Ext.dom.AbstractElement
view source

setWidth( Number/String width, [Boolean/Object animate] ) : Ext.dom.Element

Set the width of this Element. ...

Set the width of this Element.

Parameters

width : Number/String
The new width. This may be one of:
\n\n
- 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.
\n\n
animate : Boolean/Object (optional)
true for the default animation or a standard Element animation config object
\n

Returns

Ext.dom.Element
this
\n

Ext.dom.AbstractElement
view source

setX( Number The, [Boolean/Object animate] ) : Ext.dom.AbstractElement

Sets the X position of the element based on page coordinates. ...

Sets the X position of the element based on page coordinates. Element must be part of the DOM tree\nto have page coordinates (display:none or elements not appended return false).

Parameters

The : Number
X position of the element
\n
animate : Boolean/Object (optional)
True for the default animation, or a standard Element\nanimation config object
\n

Returns

Ext.dom.AbstractElement
this
\n

Ext.dom.Element
view source

setXY( Number[] pos, [Boolean/Object animate] ) : Ext.Element

Sets the position of the element in page coordinates, regardless of how the element\nis positioned. ...

Parameters

pos : Number[]
Contains X & Y [x, y] values for new position (coordinates are page-based)
\n
animate : Boolean/Object (optional)
True for the default animation, or a standard Element\nanimation config object
\n

Returns

Ext.Element
this
\n

Overrides: Ext.dom.AbstractElement.setXY

Ext.dom.AbstractElement
view source

setY( Number The, [Boolean/Object animate] ) : Ext.dom.AbstractElement

Sets the Y position of the element based on page coordinates. ...

Sets the Y position of the element based on page coordinates. Element must be part of the DOM tree\nto have page coordinates (display:none or elements not appended return false).

Parameters

The : Number
Y position of the element
\n
animate : Boolean/Object (optional)
True for the default animation, or a standard Element\nanimation config object
\n

Returns

Ext.dom.AbstractElement
this
\n

Ext.dom.Element
view source

shift( Object options ) : Ext.Elementdeprecated

Animates the transition of any combination of an element's dimensions, xy position and/or opacity. ...

Animates the transition of any combination of an element's dimensions, xy position and/or opacity. Any of these\nproperties not specified in the config object will not be changed. This effect requires that at least one new\ndimension, position or opacity setting must be passed in on the config object in order for the function to have\nany effect. Usage:

\n\n

// slide the element horizontally to x position 200 while changing the height and opacity\nel.shift({ x: 200, height: 50, opacity: .8 });\n\n// common config options shown with default values.\nel.shift({\n    width: [element's width],\n    height: [element's height],\n    x: [element's x position],\n    y: [element's y position],\n    opacity: [element's opacity],\n    easing: 'easeOut',\n    duration: 350\n});\n

This method has been deprecated since 4.0

Just use animate instead.

\n\n

Parameters

options : Object
Object literal with any of the Fx config options
\n

Returns

Ext.Element
The Element
\n

Ext.dom.Element
view source

show( [Boolean/Object animate] ) : Ext.dom.Element

Show this element - Uses display mode to determine whether to use \"display\" or \"visibility\". ...

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
\n

Returns

Ext.dom.Element
this
\n

Overrides: Ext.dom.AbstractElement.show

Ext.dom.Element
view source

slideIn( [String anchor], [Object options] ) : Ext.dom.Element

Slides the element into view. ...

Slides the element into view. An anchor point can be optionally passed to set the point of origin for the slide\neffect. This function automatically handles wrapping the element with a fixed-size container if needed. See the\nFx class overview for valid anchor point options. Usage:

\n\n

// default: slide the element in from the top\nel.slideIn();\n\n// custom: slide the element in from the right with a 2-second duration\nel.slideIn('r', { duration: 2000 });\n\n// common config options shown with default values\nel.slideIn('t', {\n    easing: 'easeOut',\n    duration: 500\n});\n

Parameters

anchor : String (optional)
One of the valid Fx anchor positions (defaults to top: 't')
\n
options : Object (optional)
Object literal with any of the Fx config options
\n
- preserveScroll : Boolean
  Set to true if preservation of any descendant elements'\nscrollTop values is required. By default the DOM wrapping operation performed by slideIn and\nslideOut causes the browser to lose all scroll positions.
  \n

Returns

Ext.dom.Element
The Element
\n

Ext.dom.Element
view source

slideOut( [String anchor], [Object options] ) : Ext.dom.Element

Slides the element out of view. ...

Slides the element out of view. An anchor point can be optionally passed to set the end point for the slide\neffect. When the effect is completed, the element will be hidden (visibility = 'hidden') but block elements will\nstill take up space in the document. The element must be removed from the DOM using the 'remove' config option if\ndesired. This function automatically handles wrapping the element with a fixed-size container if needed. See the\nFx class overview for valid anchor point options. Usage:

\n\n

// default: slide the element out to the top\nel.slideOut();\n\n// custom: slide the element out to the right with a 2-second duration\nel.slideOut('r', { duration: 2000 });\n\n// common config options shown with default values\nel.slideOut('t', {\n    easing: 'easeOut',\n    duration: 500,\n    remove: false,\n    useDisplay: false\n});\n

Parameters

anchor : String (optional)
One of the valid Fx anchor positions (defaults to top: 't')
\n
options : Object (optional)
Object literal with any of the Fx config options
\n

Returns

Ext.dom.Element
The Element
\n

Ext.Base
view source

statics( ) : Ext.Classprotected

Get the reference to the class from which this object was instantiated. ...

Get the reference to the class from which this object was instantiated. Note that unlike self,\nthis.statics() is scope-independent and it always returns the class from which it was called, regardless of what\nthis points to during run-time

\n\n

Ext.define('My.Cat', {\n    statics: {\n        totalCreated: 0,\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        var statics = this.statics();\n\n        alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to\n                                        // equivalent to: My.Cat.speciesName\n\n        alert(this.self.speciesName);   // dependent on 'this'\n\n        statics.totalCreated++;\n    },\n\n    clone: function() {\n        var cloned = new this.self;                      // dependent on 'this'\n\n        cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName\n\n        return cloned;\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n\n    statics: {\n        speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'\n    },\n\n    constructor: function() {\n        this.callParent();\n    }\n});\n\nvar cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'\n\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'\nalert(clone.groupName);                 // alerts 'Cat'\n\nalert(My.Cat.totalCreated);             // alerts 3\n

Returns

Ext.Class
\n

Ext.dom.Element
view source

swallowEvent( String/String[] eventName, [Boolean preventDefault] ) : Ext.dom.Element

Stops the specified event(s) from bubbling and optionally prevents the default action ...

Stops the specified event(s) from bubbling and optionally prevents the default action

Parameters

eventName : String/String[]
an event / array of events to stop from bubbling
\n
preventDefault : Boolean (optional)
true to prevent the default action too
\n

Returns

Ext.dom.Element
this
\n

Ext.dom.Element
view source

switchOff( [Object options] ) : Ext.dom.Element

Blinks the element as if it was clicked and then collapses on its center (similar to switching off a television). ...

Blinks the element as if it was clicked and then collapses on its center (similar to switching off a television).\nWhen the effect is completed, the element will be hidden (visibility = 'hidden') but block elements will still\ntake up space in the document. The element must be removed from the DOM using the 'remove' config option if\ndesired. Usage:

\n\n

// default\nel.switchOff();\n\n// all config options shown with default values\nel.switchOff({\n    easing: 'easeIn',\n    duration: .3,\n    remove: false,\n    useDisplay: false\n});\n

Parameters

options : Object (optional)
Object literal with any of the Fx config options
\n

Returns

Ext.dom.Element
The Element
\n

Ext.dom.Element
view source

syncContent( Object source )private

.\nCurrently used for updating grid cells without modifying DOM structure\n\nSynchronizes content of this Element with t...

.\nCurrently used for updating grid cells without modifying DOM structure

\n\n

Synchronizes content of this Element with the content of the passed element.

\n\n

Style and CSS class are copied from source into this Element, and contents are synched\nrecursively. If a child node is a text node, the textual data is copied.

Parameters

source : Object
\n

Ext.dom.Element
view source

toggle( [Boolean/Object animate] ) : Ext.dom.Element

Toggles the element's visibility or display, depending on visibility mode. ...

Toggles the element's visibility or display, depending on visibility mode.

Parameters

animate : Boolean/Object (optional)
True for the default animation, or a standard Element animation config object
\n

Returns

Ext.dom.Element
this
\n

Ext.dom.AbstractElement
view source

toggleCls( String className ) : Ext.dom.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
\n

Returns

Ext.dom.Element
this
\n

Ext.dom.AbstractElement
view source

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]
\n
y : Number (optional)
The page y, required if x is not an array
\n

Returns

Object
An object with left and top properties. e.g. {left: (value), top: (value)}
\n

Ext.dom.Element
view source

un( String eventName, Function fn, Object scope ) : Ext.dom.Element

Removes an event handler from this element. ...

Removes an event handler from this element.

\n\n

Note: if a scope was explicitly specified when adding the listener,\nthe same scope must be specified here.

\n\n

Example:

\n\n

el.un('click', this.handlerFn);\n// or\nel.removeListener('click', this.handlerFn);\n

Parameters

eventName : String
The name of the event from which to remove the handler.
\n\n
fn : Function
The handler function to remove. This must be a reference to the function passed into the\non call.
\n\n
scope : Object
If a scope (this reference) was specified when the listener was added, then this must\nrefer to the same object.
\n\n

Returns

Ext.dom.Element
this
\n\n

Ext.dom.Element
view source

unclip( ) : Ext.dom.Element

Return clipping (overflow) to original clipping before clip was called ...

Return clipping (overflow) to original clipping before clip was called

Returns

Ext.dom.Element
this
\n

Ext.dom.Element
view source

unmask( )

Hides a previously applied mask. ...

Hides a previously applied mask.

Overrides: Ext.dom.AbstractElement.unmask

Ext.dom.Element
view source

unselectable( ) : Ext.dom.Element

Disables text selection for this element (normalized across browsers) ...

Disables text selection for this element (normalized across browsers)

Returns

Ext.dom.Element
this
\n

Ext.dom.AbstractElement
view source

up( String selector, [Number/String/HTMLElement/Ext.Element limit] ) : Ext.Element

Walks up the dom looking for a parent node that matches the passed simple selector (e.g. ...

Walks up the dom looking for a parent node that matches the passed simple selector (e.g. div.some-class or span:first-child).\nThis is a shortcut for findParentNode() that always returns an Ext.dom.Element.

Parameters

selector : String
The simple selector to test
\n
limit : Number/String/HTMLElement/Ext.Element (optional)
The max depth to search as a number or an element which causes the upward traversal to stop\nand is not considered for inclusion as the result. (defaults to 50 || document.documentElement)
\n

Returns

Ext.Element
The matching DOM node (or null if no match was found)
\n

Ext.dom.Element
view source

update( String html, [Boolean loadScripts], [Function callback] ) : Ext.dom.Element

Updates the innerHTML of this element, optionally searching for and processing scripts. ...

Updates the innerHTML of this element, optionally searching for and processing scripts.

Parameters

html : String
The new HTML
\n
loadScripts : Boolean (optional)
True to look for and process scripts (defaults to false)
\n
callback : Function (optional)
For async script loading you can be notified when the update completes
\n

Returns

Ext.dom.Element
this
\n

Overrides: Ext.dom.AbstractElement.update

Ext.dom.AbstractElement
view source

wrap( [Object config], [Boolean returnDom], [String selector] ) : HTMLElement/Ext.dom.AbstractElement

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
\n
returnDom : Boolean (optional)
True to return the raw DOM element instead of Ext.dom.AbstractElement
\n
Defaults to: false
selector : String (optional)
A DomQuery selector to select a descendant node within the created element to use as the wrapping element.
\n

Returns

HTMLElement/Ext.dom.AbstractElement
The newly created wrapper element
\n

Defined By

name : Object
\n
member : Object
\n

Ext.Base
view source

addMembers( Object members )static

Add methods / properties to the prototype of this class. ...

Add methods / properties to the prototype of this class.

\n\n

Ext.define('My.awesome.Cat', {\n    constructor: function() {\n        ...\n    }\n});\n\n My.awesome.Cat.addMembers({\n     meow: function() {\n        alert('Meowww...');\n     }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n

Parameters

members : Object
\n

Ext.Base
view source

addStatics( Object members ) : Ext.Basestatic

Add / override static properties of this class. ...

Add / override static properties of this class.

\n\n

Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.addStatics({\n    someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'\n    method1: function() { ... },    // My.cool.Class.method1 = function() { ... };\n    method2: function() { ... }     // My.cool.Class.method2 = function() { ... };\n});\n

Parameters

members : Object
\n

Returns

Ext.Base
this
\n

Ext.Base
view source

addXtype( Object xtype )privatestatic

...

Parameters

xtype : Object
\n

Ext.Base
view source

borrow( Ext.Base fromClass, Array/String members ) : Ext.Baseprivatestatic

Borrow another class' members to the prototype of this class. ...

Borrow another class' members to the prototype of this class.

\n\n

Ext.define('Bank', {\n    money: '$$$',\n    printMoney: function() {\n        alert('$$$$$$$');\n    }\n});\n\nExt.define('Thief', {\n    ...\n});\n\nThief.borrow(Bank, ['money', 'printMoney']);\n\nvar steve = new Thief();\n\nalert(steve.money); // alerts '$$$'\nsteve.printMoney(); // alerts '$$$$$$$'\n

Parameters

fromClass : Ext.Base
The class to borrow members from
\n
members : Array/String
The names of the members to borrow
\n

Returns

Ext.Base
this
\n

Ext.Base
view source

create( ) : Objectstatic

Create a new instance of this Class. ...

Create a new instance of this Class.

\n\n

Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.create({\n    someConfig: true\n});\n

\n\n

All parameters are passed to the constructor of the class.

Returns

Object
the created instance.
\n

Ext.Base
view source

createAlias( String/Object alias, String/Object origin )static

Create aliases for existing prototype methods. ...

Create aliases for existing prototype methods. Example:

\n\n

Ext.define('My.cool.Class', {\n    method1: function() { ... },\n    method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n    method3: 'method1',\n    method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -> test.method1()\n

Parameters

alias : String/Object
The new method name, or an object to set multiple aliases. See\nflexSetter
\n
origin : String/Object
The original method name
\n

Ext.Base
view source

extend( Object config )privatestatic

...

Parameters

config : Object
\n

Ext.dom.AbstractElement
view source

get( String/HTMLElement/Ext.Element el ) : Ext.dom.Elementstatic

Retrieves Ext.dom.Element objects. ...

Retrieves Ext.dom.Element objects. Ext.get is alias for Ext.dom.Element.get.

\n\n

This method does not retrieve Components. This method retrieves Ext.dom.Element\nobjects which encapsulate DOM elements. To retrieve a Component by its ID, use Ext.ComponentManager.get.

\n\n

Uses simple caching to consistently return the same object. Automatically fixes if an object was recreated with\nthe same id via AJAX or DOM.

Parameters

el : String/HTMLElement/Ext.Element
The id of the node, a DOM Node or an existing Element.
\n

Returns

Ext.dom.Element
The Element object (or null if no matching element was found)
\n

Ext.Base
view source

getName( ) : Stringstatic

Get the current class' name in string format. ...

Get the current class' name in string format.

\n\n

Ext.define('My.cool.Class', {\n    constructor: function() {\n        alert(this.self.getName()); // alerts 'My.cool.Class'\n    }\n});\n\nMy.cool.Class.getName(); // 'My.cool.Class'\n

Returns

String
className
\n

Ext.Base
view source

implement( )deprecatedstatic

Adds members to class. ...

Adds members to class.

This method has been deprecated since 4.1

Use addMembers instead.

\n\n

Ext.dom.AbstractElement
view source

mergeClsList( Mixed clsList1, Mixed clsList2 ) : Arraystatic

Returns an array of unique class names based upon the input strings, or string arrays. ...

Returns an array of unique class names based upon the input strings, or string arrays.

\n\n\n

The number of parameters is unlimited.

\n\n\n

Example

\n\n\n

\n\n// Add x-invalid and x-mandatory classes, do not duplicate\nmyElement.dom.className = Ext.core.Element.mergeClsList(this.initialClasses, 'x-invalid x-mandatory');\n
\n\n\n

Parameters

clsList1 : Mixed
A string of class names, or an array of class names.
\n
clsList2 : Mixed
A string of class names, or an array of class names.
\n

Returns

Array
An array of strings representing remaining unique, merged class names. If class names were added to the first list, the changed property will be true.
\n

Ext.Base
view source

mixin( Object name, Object mixinClass )privatestatic

Used internally by the mixins pre-processor ...

Used internally by the mixins pre-processor

Parameters

name : Object
\n
mixinClass : Object
\n

Ext.Base
view source

onExtended( Object fn, Object scope )privatestatic

...

Parameters

fn : Object
\n
scope : Object
\n

Ext.Base
view source

override( Object members ) : Ext.Basedeprecatedstatic

Override members of this class. ...

Override members of this class. Overridden methods can be invoked via\ncallParent.

\n\n

Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        this.callParent(arguments);\n\n        alert(\"Meeeeoooowwww\");\n    }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n                          // alerts \"I'm a cat!\"\n                          // alerts \"Meeeeoooowwww\"\n

\n\n

As of 4.1, direct use of this method is deprecated. Use Ext.define\ninstead:

\n\n

Ext.define('My.CatOverride', {\n    override: 'My.Cat',\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        this.callParent(arguments);\n\n        alert(\"Meeeeoooowwww\");\n    }\n});\n

\n\n

The above accomplishes the same result but can be managed by the Ext.Loader\nwhich can properly order the override and its target class and the build process\ncan determine whether the override is needed based on the required state of the\ntarget class (My.Cat).

This method has been deprecated since 4.1.0

Use Ext.define instead

\n\n

Parameters

members : Object
The properties to add to this class. This should be\nspecified as an object literal containing one or more properties.
\n

Returns

Ext.Base
this class
\n

Ext.dom.AbstractElement
view source

removeCls( Mixed existingClsList, Mixed removeClsList ) : Arraystatic

Returns an array of unique class names deom the first parameter with all class names\nfrom the second parameter removed. ...

Returns an array of unique class names deom the first parameter with all class names\nfrom the second parameter removed.

\n\n\n

Example

\n\n\n

\n\n// Remove x-invalid and x-mandatory classes if present.\nmyElement.dom.className = Ext.core.Element.removeCls(this.initialClasses, 'x-invalid x-mandatory');\n
\n\n\n

Parameters

existingClsList : Mixed
A string of class names, or an array of class names.
\n
removeClsList : Mixed
A string of class names, or an array of class names to remove from existingClsList.
\n

Returns

Array
An array of strings representing remaining class names. If class names were removed, the changed property will be true.
\n

Ext.dom.Element
view source

select( String/HTMLElement[] selector, [Boolean unique], [HTMLElement/String root] ) : Ext.CompositeElementLite/Ext.CompositeElementstatic

Selects elements based on the passed CSS selector to enable Element methods\nto be applied to many related elements in...

Selects elements based on the passed CSS selector to enable Element methods\nto be applied to many related elements in one statement through the returned CompositeElement or\nCompositeElementLite object.

Parameters

selector : String/HTMLElement[]
The CSS selector or an array of elements
\n
unique : Boolean (optional)
true to create a unique Ext.Element for each element (defaults to a shared flyweight object)
\n
root : HTMLElement/String (optional)
The root element of the query or id of the root
\n

Returns

Ext.CompositeElementLite/Ext.CompositeElement
\n

Ext.Base
view source

triggerExtended( )privatestatic

...

Defined By

e : Ext.EventObject
The Ext.EventObject encapsulating the DOM event.
\n
t : HTMLElement
The target of the event.
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n