setPostioning to get snapshot before performing an update and then restoring

$className : Stringprivate

...

Defaults to: 'Ext.Base'

_positionTopRight : Arrayprivate

Defined in override Ext.rtl.dom.Element_position. ...

Defined in override Ext.rtl.dom.Element_position.

Defaults to: ['position', 'top', 'right']

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

configMap : Objectprivate

...

Defaults to: {}

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.

\n\n

Overridden in Ext.dom.AbstractElement_static.

Defaults to: "px"

dom : HTMLElement

The DOM element

getTrueXY : Objectprivate

Returns the X,Y position of the passed element in browser document space without regard\nto any RTL direction settings. ...

Returns the X,Y position of the passed element in browser document space without regard\nto any RTL direction settings.

\n\n

Defined in override Ext.dom.Element_position.

id : String

The DOM element ID

initConfigList : Arrayprivate

...

Defaults to: []

initConfigMap : Objectprivate

...

Defaults to: {}

isInstance : Booleanprivate

...

Defaults to: true

Ext.dom.Layer
view source

isLayer : Booleanprivate

...

Defaults to: true

Ext.dom.Layer
view source

localXYNames : Objectprivate

...

Defaults to: {get: 'getLocalXY', set: 'setLocalXY'}

originalDisplay : String

The element's default display mode. ...

The element's default display mode.

\n\n

Defined in override Ext.dom.Element_fx.

Defaults to: ""

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

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.

\n\n

Defined in override Ext.dom.AbstractElement_style.

Defaults to: {}

Defined By

Static Properties

$onExtended : Arrayprivatestatic

...

Defaults to: []

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

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

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

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

borders : Objectprivatestatic

Defined in override Ext.dom.AbstractElement_static. ...

Defined in override Ext.dom.AbstractElement_static.

Defaults to: {l: 'border-left-width', r: 'border-right-width', t: 'border-top-width', b: 'border-bottom-width'}

camelRe : RegExpprivatestatic

Defined in override Ext.dom.AbstractElement_static. ...

Defined in override Ext.dom.AbstractElement_static.

Defaults to: /(-[a-z])/gi

cssRe : RegExpprivatestatic

Defined in override Ext.dom.AbstractElement_static. ...

Defined in override Ext.dom.AbstractElement_static.

Defaults to: /([a-z0-9\\-]+)\\s*:\\s*([^;\\s]+(?:\\s*[^;\\s]+)*)?;?/gi

margins : Objectprivatestatic

Defined in override Ext.dom.AbstractElement_static. ...

Defined in override Ext.dom.AbstractElement_static.

Defaults to: {l: 'margin-left', r: 'margin-right', t: 'margin-top', b: 'margin-bottom'}

msRe : RegExpprivatestatic

Defined in override Ext.dom.AbstractElement_static. ...

Defined in override Ext.dom.AbstractElement_static.

Defaults to: /^-ms-/

opacityRe : RegExpprivatestatic

Defined in override Ext.dom.AbstractElement_static. ...

Defined in override Ext.dom.AbstractElement_static.

Defaults to: /alpha\$opacity=(.*)\$/i

paddings : Objectprivatestatic

Defined in override Ext.dom.AbstractElement_static. ...

Defined in override Ext.dom.AbstractElement_static.

Defaults to: {l: 'padding-left', r: 'padding-right', t: 'padding-top', b: 'padding-bottom'}

propertyCache : Objectprivatestatic

Defined in override Ext.dom.AbstractElement_static. ...

Defined in override Ext.dom.AbstractElement_static.

Defaults to: {}

Ext.dom.Layer
view source

shims : Arrayprivatestatic

...

Defaults to: []

trimRe : RegExpprivatestatic

...

Defaults to: /^\\s+|\\s+$/g

unitRe : RegExpprivatestatic

Defined in override Ext.dom.AbstractElement_static. ...

Defined in override Ext.dom.AbstractElement_static.

Defaults to: /\\d+(px|em|%|en|ex|pt|in|cm|mm|pc)$/i

whitespaceRe : RegExpprivatestatic

...

Defaults to: /\\s/

Methods

Defined By

Instance Methods

Ext.dom.Layer
view source

newExt.dom.Layer( [config], [existingEl] ) : Ext.dom.Layer

Creates new Layer. ...

Creates new Layer.

Parameters

config : Object (optional)
An object with config options.
\n
existingEl : String/HTMLElement (optional)
Uses an existing DOM element.\nIf the element is not found it creates it.
\n

Returns

Ext.dom.Layer
\n

Overrides: Ext.dom.Element.constructor

addCls( 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.

\n\n

Defined in override Ext.dom.AbstractElement_style.

Parameters

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

Returns

Ext.dom.Element
this
\n

addClsOnClick( className, [testFn], [scope] ) : Ext.dom.Elementchainable

Sets up event handlers to add and remove a css class when the mouse is down and then up on this element (a click effe...

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)

\n\n

Defined in override Ext.dom.Element_style.

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

addClsOnFocus( className, [testFn], [scope] ) : Ext.dom.Elementchainable

Sets up event handlers to add and remove a css class when this element has the focus\n\nDefined in override Ext.dom.Ele...

Sets up event handlers to add and remove a css class when this element has the focus

\n\n

Defined in override Ext.dom.Element_style.

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

addClsOnOver( className, [testFn], [scope] ) : Ext.dom.Elementchainable

Sets up event handlers to add and remove a css class when the mouse is over this element\n\nDefined in override Ext.dom...

Sets up event handlers to add and remove a css class when the mouse is over this element

\n\n

Defined in override Ext.dom.Element_style.

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

addKeyListener( key, fn, [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

addKeyMap( 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

addListener( eventName, fn, [scope], [options] ) : Ext.dom.Elementchainable

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

adjustDirect2DDimension( 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.

\n\n

Defined in override Ext.dom.Element_style.

Parameters

dimension : Object
\n

Returns

Number
0 or 1
\n

Ext.dom.Layer
view source

afterFx( )private

...

anchorAnimX( anchor )private

Defined in override Ext.dom.Element_anim. ...

Defined in override Ext.dom.Element_anim.

Parameters

anchor : Object
\n

anim( config )private

process the passed fx configuration. ...

process the passed fx configuration.

\n\n\n

Defined in override Ext.dom.Element_anim.

Parameters

config : Object
\n

animate( config ) : Ext.dom.Elementchainable

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.

\n\n

Defined in override Ext.dom.Element_anim.

Parameters

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

Returns

Ext.dom.Element
this
\n

appendChild( el, [returnDom] ) : Ext.dom.AbstractElement

Appends the passed element(s) to this element\n\nDefined in override Ext.dom.AbstractElement_insertion. ...

Appends the passed element(s) to this element

\n\n

Defined in override Ext.dom.AbstractElement_insertion.

Parameters

el : String/HTMLElement/Ext.dom.AbstractElement/Object
The id or element to insert or a DomHelper config\nThe id of the node, a DOM Node or an existing Element.
\n
returnDom : Boolean (optional)
True to return the raw DOM element instead of Ext.dom.AbstractElement
\n
Defaults to: false

Returns

Ext.dom.AbstractElement
The inserted Element.
\n

appendTo( el ) : Ext.dom.AbstractElementchainable

Appends this element to the passed element\n\nDefined in override Ext.dom.AbstractElement_insertion. ...

Appends this element to the passed element

\n\n

Defined in override Ext.dom.AbstractElement_insertion.

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

applyStyles( styles ) : Ext.dom.Element

More flexible version of setStyle for setting style properties. ...

More flexible version of setStyle for setting style properties.

\n\n

Defined in override Ext.dom.AbstractElement_style.

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.Layer
view source

beforeAction( )private

...

Ext.dom.Layer
view source

beforeFx( )private

...

Ext.dom.Layer
view source

beginUpdate( )private

...

blur( ) : Ext.dom.Elementchainable

Tries to blur the element. ...

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

Returns

Ext.dom.Element
this
\n

boxWrap( [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

\n\n

Defined in override Ext.dom.Element_style.

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

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

callOverridden( 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

callParent( 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

\n\n

To override a method and replace it and also call the superclass method, use\ncallSuper. This is often done to patch a method to fix a bug.

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

callSuper( args ) : Objectprotected

This method is used by an override to call the superclass method but bypass any\noverridden method. ...

This method is used by an override to call the superclass method but bypass any\noverridden method. This is often done to \"patch\" a method that contains a bug\nbut for whatever reason cannot be fixed directly.

\n\n

Consider:

\n\n

 Ext.define('Ext.some.Class', {\n     method: function () {\n         console.log('Good');\n     }\n });\n\n Ext.define('Ext.some.DerivedClass', {\n     method: function () {\n         console.log('Bad');\n\n         // ... logic but with a bug ...\n\n         this.callParent();\n     }\n });\n

\n\n

To patch the bug in DerivedClass.method, the typical solution is to create an\noverride:

\n\n

 Ext.define('App.paches.DerivedClass', {\n     override: 'Ext.some.DerivedClass',\n\n     method: function () {\n         console.log('Fixed');\n\n         // ... logic but with bug fixed ...\n\n         this.callSuper();\n     }\n });\n

\n\n

The patch method cannot use callParent to call the superclass method since\nthat would call the overridden method containing the bug. In other words, the\nabove patch would only produce \"Fixed\" then \"Good\" in the console log, whereas,\nusing callParent would produce \"Fixed\" then \"Bad\" then \"Good\".

Parameters

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

Returns

Object
Returns the result of calling the superclass method
\n

center( centerIn )

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

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

\n\n

Defined in override Ext.dom.Element_position.

Parameters

centerIn : String/HTMLElement/Ext.dom.Element
element in\nwhich to center the element.
\n

child( selector, [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).

\n\n

Defined in override Ext.dom.AbstractElement_traversal.

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

clean( [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

clearListeners( ) : Ext.dom.Elementchainable

Alias for removeAllListeners. ...

Alias for removeAllListeners.

\n\n

Removes all previous added listeners from this element

Returns

Ext.dom.Element
this
\n\n

clearOpacity( ) : Ext.dom.Elementchainable

Clears any opacity settings from this element. ...

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

\n\n

Defined in override Ext.dom.Element_style.

Returns

Ext.dom.Element
this
\n

clearPositioning( [value] ) : Ext.dom.Elementchainable

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

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

\n\n

Defined in override Ext.dom.Element_position.

Parameters

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

Returns

Ext.dom.Element
this
\n

clip( ) : Ext.dom.Elementchainable

Store the current overflow setting and clip overflow on the element - use unclip to remove\n\nDefined in override Ext.d...

Store the current overflow setting and clip overflow on the element - use unclip to remove

\n\n

Defined in override Ext.dom.Element_style.

Returns

Ext.dom.Element
this
\n

configClass( )private

...

constrainScrollLeft( left )private

Defined in override Ext.dom.Element_scroll. ...

Defined in override Ext.dom.Element_scroll.

Parameters

left : Object
\n

constrainScrollTop( top )private

Defined in override Ext.dom.Element_scroll. ...

Defined in override Ext.dom.Element_scroll.

Parameters

top : Object
\n

Ext.dom.Layer
view source

constrainXY( ) : Ext.dom.Layerchainableprivate

...

Returns

Ext.dom.Layer
this
\n

contains( 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.Layer
view source

createCB( callback )private

...

Parameters

callback : Object
\n

createChild( config, [insertBefore], [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.

\n\n

Defined in override Ext.dom.AbstractElement_insertion.

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

createProxy( config, [renderTo], [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

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

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.Layer
view source

disableShadow( )private

...

down( selector, [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).

\n\n

Defined in override Ext.dom.AbstractElement_traversal.

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

enableDisplayMode( [display] ) : Ext.dom.Elementchainable

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.Layer
view source

enableShadow( show )private

...

Parameters

show : Object
\n

Ext.dom.Layer
view source

endUpdate( )private

...

fadeIn( [options] ) : Ext.Elementchainable

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

\n\n

Defined in override Ext.dom.Element_anim.

Parameters

options : Object (optional)
Object literal with any of the Ext.fx.Anim config options
\n

Returns

Ext.Element
The Element
\n

fadeOut( [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

\n\n

Defined in override Ext.dom.Element_anim.

Parameters

options : Object (optional)
Object literal with any of the Ext.fx.Anim config options
\n

Returns

Ext.Element
The Element
\n

findParent( selector, [limit], [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)

\n\n

Defined in override Ext.dom.AbstractElement_traversal.

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

findParentNode( selector, [limit], [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)

\n\n

Defined in override Ext.dom.AbstractElement_traversal.

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

first( [selector], [returnDom] ) : Ext.dom.Element/HTMLElement

Gets the first child, skipping text nodes\n\nDefined in override Ext.dom.AbstractElement_traversal. ...

Gets the first child, skipping text nodes

\n\n

Defined in override Ext.dom.AbstractElement_traversal.

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

focus( [defer] ) : Ext.dom.Elementchainable

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

focusable( asFocusEl ) : Boolean

Alias for isFocusable. ...

Alias for isFocusable.

\n\n

Checks whether this element can be focused.

Parameters

asFocusEl : Object
\n

Returns

Boolean
True if the element is focusable
\n\n

frame( [color], [count], [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

\n\n

Defined in override Ext.dom.Element_anim.

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 Ext.fx.Anim config options
\n

Returns

Ext.dom.Element
The Element
\n

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.

\n\n

Defined in override Ext.dom.AbstractElement_static.

Returns

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

getAttribute( name, [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

getAttributeNS( namespace, 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

getBorderWidth( side ) : Number

Gets the width of the border(s) for the specified side(s)\n\nDefined in override Ext.dom.AbstractElement_style. ...

Gets the width of the border(s) for the specified side(s)

\n\n

Defined in override Ext.dom.AbstractElement_style.

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

getBottom( local ) : Numberdeprecated

Gets the bottom Y coordinate of the element (element Y position + element height)\n\nDefined in override Ext.dom.Elemen...

Gets the bottom Y coordinate of the element (element Y position + element height)

\n\n

Defined in override Ext.dom.Element_position.

This method has been deprecated

\n \n\n

Parameters

local : Boolean
True to get the local css position instead of page\ncoordinate
\n

Returns

Number
\n

getById( id, [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

getCache( )private

...

getCenterXY( ) : Number[]deprecated

Calculates the x, y to center this element on the screen\n\nDefined in override Ext.dom.Element_position. ...

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

\n\n

Defined in override Ext.dom.Element_position.

This method has been deprecated

\n \n\n

Returns

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

getColor( attr, defaultValue, [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.

\n\n

Defined in override Ext.dom.Element_style.

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

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.

\n\n

Defined in override Ext.dom.Element_style.

Returns

Number
\n

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.

\n\n

Defined in override Ext.dom.Element_style.

Returns

Number
\n

getConfig( name )private

...

Parameters

name : Object
\n

Ext.dom.Layer
view source

getConstrainOffset( )private

...

getFrameWidth( 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.

\n\n

Defined in override Ext.dom.Element_style.

Parameters

sides : String
\n

Returns

Number
\n

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.

getHeight( [contentHeight] ) : Number

Returns the offset height of the element\n\nDefined in override Ext.dom.AbstractElement_style. ...

Returns the offset height of the element

\n\n

Defined in override Ext.dom.AbstractElement_style.

Parameters

contentHeight : Boolean (optional)
true to get the height minus borders and padding
\n

Returns

Number
The element's height
\n

getInitialConfig( [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

getLeft( local ) : Numberdeprecated

Gets the left X coordinate\n\nDefined in override Ext.dom.Element_position. ...

Gets the left X coordinate

\n\n

Defined in override Ext.dom.Element_position.

This method has been deprecated

Use getX or getLocalX

\n\n

Parameters

local : Boolean
True to get the local css position instead of\npage coordinate
\n

Returns

Number
\n

getLoader( ) : Ext.ElementLoader

Gets this element's ElementLoader ...

Gets this element's ElementLoader

Returns

Ext.ElementLoader
The loader
\n

getLocalX( ) : Number

Gets the local CSS X position for the element\n\nDefined in override Ext.dom.Element_position. ...

Gets the local CSS X position for the element

\n\n

Defined in override Ext.dom.Element_position.

Returns

Number
\n

getLocalXY( ) : Array

Gets the local CSS X and Y position for the element\n\nDefined in override Ext.dom.Element_position. ...

Gets the local CSS X and Y position for the element

\n\n

Defined in override Ext.dom.Element_position.

Returns

Array
[x, y]
\n

getLocalY( ) : Number

Gets the local CSS Y position for the element\n\nDefined in override Ext.dom.Element_position. ...

Gets the local CSS Y position for the element

\n\n

Defined in override Ext.dom.Element_position.

Returns

Number
\n

getMargin( [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)

\n\n

Defined in override Ext.dom.AbstractElement_style.

Parameters

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

Returns

Object/Number
\n

getPadding( side ) : Number

Gets the width of the padding(s) for the specified side(s)\n\nDefined in override Ext.dom.AbstractElement_style. ...

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

\n\n

Defined in override Ext.dom.AbstractElement_style.

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

getPageBox( [asRegion] ) : Object/Ext.util.Regiondeprecated

Returns an object defining the area of this Element which can be passed to\nExt.util.Positionable.setBox to set anothe...

Returns an object defining the area of this Element which can be passed to\nExt.util.Positionable.setBox to set another Element's size/location to match this element.

\n\n

Defined in override Ext.dom.Element_position.

This method has been deprecated

use Ext.util.Positionable.getBox to get a box object, and\nExt.util.Positionable.getRegion to get a Region.

\n\n

Parameters

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

Returns

Object/Ext.util.Region
box An object in the following 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\nthe X position and index 1 contains the Y position. So the result may also be\nused for setXY
\n

getPositioning( autoPx )private

Defined in override Ext.rtl.dom.Element_position. ...

Defined in override Ext.rtl.dom.Element_position.

\n\n

From override Ext.dom.Element_position: Gets an object with all CSS positioning properties. Useful along with

\n\n

setPostioning to get snapshot before performing an update and then restoring

\n\n

the element.

Parameters

autoPx : Object
\n

getRight( local ) : Numberdeprecated

Gets the right X coordinate of the element (element X position + element width)\n\nDefined in override Ext.dom.Element_...

Gets the right X coordinate of the element (element X position + element width)

\n\n

Defined in override Ext.dom.Element_position.

This method has been deprecated

\n \n\n

Parameters

local : Boolean
True to get the local css position instead of page\ncoordinates
\n

Returns

Number
\n

getRightMarginFixCleaner( 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.

\n\n

Defined in override Ext.dom.AbstractElement_static.

Parameters

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

getScroll( ) : Object

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

Returns the current scroll position of the element.

\n\n

Defined in override Ext.dom.Element_scroll.

Returns

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

getScrollLeft( ) : Number

Gets the left scroll position\n\nDefined in override Ext.dom.Element_scroll. ...

Gets the left scroll position

\n\n

Defined in override Ext.dom.Element_scroll.

Returns

Number
The left scroll position
\n

getScrollTop( ) : Number

Gets the top scroll position\n\nDefined in override Ext.dom.Element_scroll. ...

Gets the top scroll position

\n\n

Defined in override Ext.dom.Element_scroll.

Returns

Number
The top scroll position
\n

Ext.dom.Layer
view source

getShim( )private

...

getSize( [contentSize] ) : Object

Returns the size of the element. ...

Returns the size of the element.

\n\n

Defined in override Ext.dom.AbstractElement_style.

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

getStyle( property, [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.

\n\n

Defined in override Ext.dom.AbstractElement_style.

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

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.

\n\n

Defined in override Ext.dom.Element_style.

Returns

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

getTextWidth( text, [min], [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

getTop( local ) : Numberdeprecated

Gets the top Y coordinate\n\nDefined in override Ext.dom.Element_position. ...

Gets the top Y coordinate

\n\n

Defined in override Ext.dom.Element_position.

This method has been deprecated

Use getY or getLocalY

\n\n

Parameters

local : Boolean
True to get the local css position instead of page\ncoordinates
\n

Returns

Number
\n

getValue( 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

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.

\n\n

Defined in override Ext.dom.AbstractElement_style.

Returns

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

getVisibilityMode( )private

...

getWidth( [contentWidth] ) : Number

Returns the offset width of the element\n\nDefined in override Ext.dom.AbstractElement_style. ...

Returns the offset width of the element

\n\n

Defined in override Ext.dom.AbstractElement_style.

Parameters

contentWidth : Boolean (optional)
true to get the width minus borders and padding
\n

Returns

Number
The element's width
\n

getX( ) : Number

Gets element X position in page coordinates\n\nDefined in override Ext.dom.Element_position. ...

Gets element X position in page coordinates

\n\n

Defined in override Ext.dom.Element_position.

Returns

Number
\n

getY( ) : Number

Gets element Y position in page coordinates\n\nDefined in override Ext.dom.Element_position. ...

Gets element Y position in page coordinates

\n\n

Defined in override Ext.dom.Element_position.

Returns

Number
\n

Ext.dom.Layer
view source

getZIndex( )private

...

ghost( [anchor], [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

\n\n

Defined in override Ext.dom.Element_anim.

Parameters

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

Returns

Ext.dom.Element
The Element
\n

hasCls( 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.

\n\n

Defined in override Ext.dom.AbstractElement_style.

Parameters

className : String
The CSS class to check for
\n

Returns

Boolean
True if the class exists, else false
\n

hasConfig( config )private

...

Parameters

config : Object
\n

hasMetrics( )private

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

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

\n\n

Defined in override Ext.dom.Element_fx.

hide( [animate] ) : Ext.dom.Elementchainable

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.

\n\n

Defined in override Ext.dom.Element_fx.

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.Layer
view source

hideShim( )private

...

Ext.dom.Layer
view source

hideUnders( )private

...

highlight( [color], [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

\n\n

Defined in override Ext.dom.Element_anim.

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 Ext.fx.Anim config options
\n

Returns

Ext.dom.Element
The Element
\n

hover( overFn, outFn, [scope], [options] ) : Ext.dom.Elementchainable

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

initConfig( config ) : Ext.Basechainableprotected

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

initDD( group, config, 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.

\n\n

Defined in override Ext.dom.Element_dd.

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

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

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

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

\n\n

Defined in override Ext.dom.Element_dd.

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

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

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

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

\n\n

Defined in override Ext.dom.Element_dd.

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

insertAfter( el ) : Ext.dom.AbstractElementchainable

Inserts this element after the passed element in the DOM\n\nDefined in override Ext.dom.AbstractElement_insertion. ...

Inserts this element after the passed element in the DOM

\n\n

Defined in override Ext.dom.AbstractElement_insertion.

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

insertBefore( el ) : Ext.dom.AbstractElementchainable

Inserts this element before the passed element in the DOM\n\nDefined in override Ext.dom.AbstractElement_insertion. ...

Inserts this element before the passed element in the DOM

\n\n

Defined in override Ext.dom.AbstractElement_insertion.

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

insertFirst( el ) : Ext.dom.AbstractElement

Inserts (or creates) an element (or DomHelper config) as the first child of this element\n\nDefined in override Ext.dom...

Inserts (or creates) an element (or DomHelper config) as the first child of this element

\n\n

Defined in override Ext.dom.AbstractElement_insertion.

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

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

Inserts an html fragment into this element\n\nDefined in override Ext.dom.AbstractElement_insertion. ...

Inserts an html fragment into this element

\n\n

Defined in override Ext.dom.AbstractElement_insertion.

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

insertSibling( el, [where], [returnDom] ) : Ext.dom.AbstractElement

Inserts (or creates) the passed element (or DomHelper config) as a sibling of this element\n\nDefined in override Ext.d...

Inserts (or creates) the passed element (or DomHelper config) as a sibling of this element

\n\n

Defined in override Ext.dom.AbstractElement_insertion.

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

is( 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

isAncestor( element )private

Defined in override Ext.dom.AbstractElement_traversal. ...

Defined in override Ext.dom.AbstractElement_traversal.

Parameters

element : Object
\n

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

isDisplayed( ) : Boolean

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

Returns true if display is not \"none\"

Returns

Boolean
\n

isFocusable( asFocusEl ) : Boolean

Checks whether this element can be focused. ...

Checks whether this element can be focused.

Parameters

asFocusEl : Object
\n

Returns

Boolean
True if the element is focusable
\n\n

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

isScrollable( ) : Boolean

Returns true if this element is scrollable. ...

Returns true if this element is scrollable.

\n\n

Defined in override Ext.dom.Element_scroll.

Returns

Boolean
\n

isStyle( style, 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.

\n\n

Defined in override Ext.dom.AbstractElement_style.

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

isTransparent( 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.

\n\n

Defined in override Ext.dom.AbstractElement_style.

Parameters

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

Returns

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

isVisible( [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

last( [selector], [returnDom] ) : Ext.dom.Element/HTMLElement

Gets the last child, skipping text nodes\n\nDefined in override Ext.dom.AbstractElement_traversal. ...

Gets the last child, skipping text nodes

\n\n

Defined in override Ext.dom.AbstractElement_traversal.

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

load( options ) : Ext.dom.Elementchainable

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

mask( [msg], [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

matchNode( dir, start, selector, returnDom )private

Defined in override Ext.dom.AbstractElement_traversal. ...

Defined in override Ext.dom.AbstractElement_traversal.

Parameters

dir : Object
\n
start : Object
\n
selector : Object
\n
returnDom : Object
\n

monitorMouseLeave( delay, handler, [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

moveTo( x, y, [animate] ) : Ext.dom.Elementchainabledeprecated

Sets the position of the element in page coordinates. ...

Sets the position of the element in page coordinates.

\n\n

Defined in override Ext.dom.Element_position.

This method has been deprecated

Use setXY instead.

\n\n

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\nElement animation config object
\n

Returns

Ext.dom.Element
this
\n

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.

next( [selector], [returnDom] ) : Ext.dom.Element/HTMLElement

Gets the next sibling, skipping text nodes\n\nDefined in override Ext.dom.AbstractElement_traversal. ...

Gets the next sibling, skipping text nodes

\n\n

Defined in override Ext.dom.AbstractElement_traversal.

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

on( eventName, fn, [scope], [options] ) : Ext.dom.Elementchainable

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

onConfigUpdate( names, callback, scope )private

...

Parameters

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

Ext.dom.Layer
view source

onOpacitySet( opacity )private

...

Parameters

opacity : Object
\n

parent( [selector], [returnDom] ) : Ext.dom.Element/HTMLElement

Gets the parent node for this element, optionally chaining up trying to match a selector\n\nDefined in override Ext.dom...

Gets the parent node for this element, optionally chaining up trying to match a selector

\n\n

Defined in override Ext.dom.AbstractElement_traversal.

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

pause( 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

\n\n

Defined in override Ext.dom.Element_anim.

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

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

Initializes positioning on this element. ...

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

\n\n

Defined in override Ext.dom.Element_position.

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

prev( [selector], [returnDom] ) : Ext.dom.Element/HTMLElement

Gets the previous sibling, skipping text nodes\n\nDefined in override Ext.dom.AbstractElement_traversal. ...

Gets the previous sibling, skipping text nodes

\n\n

Defined in override Ext.dom.AbstractElement_traversal.

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

puff( [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

\n\n

Defined in override Ext.dom.Element_anim.

Parameters

options : Object (optional)
Object literal with any of the Ext.fx.Anim config options
\n

Returns

Ext.dom.Element
The Element
\n

purgeAllListeners( ) : Ext.dom.Elementchainable

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

query( 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).

\n\n

Defined in override Ext.dom.AbstractElement_traversal.

Parameters

selector : String
The CSS selector
\n

Returns

HTMLElement[]
An array of the matched nodes
\n

radioCls( 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.

\n\n

Defined in override Ext.dom.AbstractElement_style.

Parameters

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

Returns

Ext.dom.Element
this
\n

relayEvent( eventName, 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.Layer
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

Overrides: Ext.dom.AbstractElement.remove

removeAllListeners( ) : Ext.dom.Elementchainable

Removes all previous added listeners from this element ...

Removes all previous added listeners from this element

Returns

Ext.dom.Element
this
\n\n

removeCls( className ) : Ext.dom.Element

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

Removes one or more CSS classes from the element.

\n\n

Defined in override Ext.dom.AbstractElement_style.

Parameters

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

Returns

Ext.dom.Element
this
\n

removeListener( eventName, fn, scope ) : Ext.dom.Elementchainable

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

repaint( ) : Ext.dom.Elementchainable

Forces the browser to repaint this element\n\nDefined in override Ext.dom.AbstractElement_style. ...

Forces the browser to repaint this element

\n\n

Defined in override Ext.dom.AbstractElement_style.

Returns

Ext.dom.Element
this
\n

replace( el ) : Ext.dom.AbstractElementchainable

Replaces the passed element with this element\n\nDefined in override Ext.dom.AbstractElement_insertion. ...

Replaces the passed element with this element

\n\n

Defined in override Ext.dom.AbstractElement_insertion.

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

replaceCls( oldClassName, 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.

\n\n

Defined in override Ext.dom.AbstractElement_style.

Parameters

oldClassName : String
The CSS class to replace
\n
newClassName : String
The replacement CSS class
\n

Returns

Ext.dom.Element
this
\n

replaceWith( el ) : Ext.dom.AbstractElement

Replaces this element with the passed element\n\nDefined in override Ext.dom.AbstractElement_insertion. ...

Replaces this element with the passed element

\n\n

Defined in override Ext.dom.AbstractElement_insertion.

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

rtlGetLocalX( )private

Defined in override Ext.rtl.dom.Element_position. ...

Defined in override Ext.rtl.dom.Element_position.

rtlGetLocalXY( )private

Defined in override Ext.rtl.dom.Element_position. ...

Defined in override Ext.rtl.dom.Element_position.

rtlSetLocalX( x )private

Defined in override Ext.rtl.dom.Element_position. ...

Defined in override Ext.rtl.dom.Element_position.

Parameters

x : Object
\n

rtlSetLocalXY( x, y )private

Defined in override Ext.rtl.dom.Element_position. ...

Defined in override Ext.rtl.dom.Element_position.

Parameters

x : Object
\n
y : Object
\n

rtlSetX( x, animate )private

Defined in override Ext.rtl.dom.Element_position. ...

Defined in override Ext.rtl.dom.Element_position.

Parameters

x : Object
\n
animate : Object
\n

rtlSetXY( xy, animate )private

Defined in override Ext.rtl.dom.Element_position. ...

Defined in override Ext.rtl.dom.Element_position.

Parameters

xy : Object
\n
animate : Object
\n

rtlSetY( y, animate )private

Defined in override Ext.rtl.dom.Element_position. ...

Defined in override Ext.rtl.dom.Element_position.

Parameters

y : Object
\n
animate : Object
\n

rtlTranslatePoints( x, y )private

Defined in override Ext.rtl.dom.Element_position. ...

Defined in override Ext.rtl.dom.Element_position.

Parameters

x : Object
\n
y : Object
\n

rtlTranslateXY( x, y )private

Defined in override Ext.rtl.dom.Element_position. ...

Defined in override Ext.rtl.dom.Element_position.

Parameters

x : Object
\n
y : Object
\n

scale( width, height, [options] ) : Ext.Elementchainabledeprecated

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

\n\n

Defined in override Ext.dom.Element_anim.

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 Ext.fx.Anim config options
\n

Returns

Ext.Element
The Element
\n

scroll( direction, distance, [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.

\n\n

Defined in override Ext.dom.Element_scroll.

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

scrollBy( deltaX, deltaY, 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

\n\n

Defined in override Ext.dom.Element_scroll.

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

scrollChildIntoView( child, hscroll )private

Defined in override Ext.dom.Element_scroll. ...

Defined in override Ext.dom.Element_scroll.

Parameters

child : Object
\n
hscroll : Object
\n

scrollIntoView( [container], [hscroll], [animate], [highlight] ) : Ext.dom.Elementchainable

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

Scrolls this element into view within the passed container.

\n\n

Defined in override Ext.dom.Element_scroll.

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
\n
highlight : Boolean (optional)
true to highlight the element when it is in view.\nanimation config object
\n
Defaults to: false

Returns

Ext.dom.Element
this
\n

scrollTo( side, value, [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.

\n\n

Defined in override Ext.dom.Element_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

select( selector, [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).

\n\n

Defined in override Ext.dom.AbstractElement_traversal.

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

selectable( ) : Ext.Element

Enable text selection for this element (normalized across browsers)\n\nDefined in override Ext.dom.Element_style. ...

Enable text selection for this element (normalized across browsers)

\n\n

Defined in override Ext.dom.Element_style.

Returns

Ext.Element
this
\n

serializeForm( form ) : String

Serializes a DOM form into a url encoded string\n\nDefined in override Ext.dom.AbstractElement_static. ...

Serializes a DOM form into a url encoded string

\n\n

Defined in override Ext.dom.AbstractElement_static.

Parameters

form : Object
The form
\n

Returns

String
The url encoded form
\n

set( o, [useSet] ) : Ext.dom.Elementchainable

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

setBottom( bottom ) : Ext.dom.Elementchainabledeprecated

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

Sets the element's CSS bottom style.

\n\n

Defined in override Ext.dom.Element_position.

This method has been deprecated

\n \n\n

Parameters

bottom : Number/String
Number of pixels or CSS string value to set as\nthe bottom CSS property value
\n

Returns

Ext.dom.Element
this
\n

Ext.dom.Layer
view source

setBounds( x, y, width, height, [animate] ) : Ext.dom.Elementdeprecated

overridden Element method\n\nSets the element's position and size in one shot. ...

overridden Element method

\n\n

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

\n\n

Defined in override Ext.dom.Element_position.

This method has been deprecated

Use Ext.util.Positionable.setBox instead.

\n\n

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\ndefaultUnits (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\ndefaultUnits (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\na standard Element animation config object
\n

Returns

Ext.dom.Element
this
\n

Overrides: Ext.dom.Element.setBounds

setConfig( config, applyIfNotSet ) : Ext.Basechainableprivate

...

Parameters

config : Object
\n
applyIfNotSet : Object
\n

Returns

Ext.Base
this
\n

setDisplayed( value ) : Ext.dom.Elementchainable

Sets the CSS display property. ...

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

\n\n

Defined in override Ext.dom.Element_fx.

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

setHTML( html ) : Ext.Elementchainable

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.Layer
view source

setHeight( height ) : Ext.dom.Element

overridden Element method\n\nSet the height of this Element. ...

overridden Element method

\n\n

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

\n\n

Defined in override Ext.dom.AbstractElement_style.

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

Returns

Ext.dom.Element
this
\n

Overrides: Ext.dom.AbstractElement.setHeight

setHorizontal( )private

Removes \"vertical\" state from this element (reverses everything done\nby setVertical). ...

Removes \"vertical\" state from this element (reverses everything done\nby setVertical).

\n\n

Defined in override Ext.dom.Element_style.

Ext.dom.Layer
view source

setLeft( left ) : Ext.dom.Elementchainabledeprecated

overridden Element method\n\nSets the element's left position directly using CSS style\n(instead of setX). ...

overridden Element method

\n\n

Sets the element's left position directly using CSS style\n(instead of setX).

\n\n

Defined in override Ext.dom.Element_position.

This method has been deprecated

\n \n\n

Parameters

left : Number/String
Number of pixels or CSS string value to\nset as the left CSS property value
\n

Returns

Ext.dom.Element
this
\n

Overrides: Ext.dom.Element.setLeft

Ext.dom.Layer
view source

setLeftTop( left, top ) : Ext.dom.Elementdeprecated

Sets the element's left and top positions directly using CSS style\n\nDefined in override Ext.dom.Element_position. ...

Sets the element's left and top positions directly using CSS style

\n\n

Defined in override Ext.dom.Element_position.

This method has been deprecated

\n \n\n

Parameters

left : Number/String
Number of pixels or CSS string value to\nset as the left CSS property value
\n
top : Number/String
Number of pixels or CSS string value to\nset as the top CSS property value
\n

Returns

Ext.dom.Element
this
\n

Overrides: Ext.dom.Element.setLeftTop

Ext.dom.Layer
view source

setLocalX( )private

...

Ext.dom.Layer
view source

setLocalXY( )private

...

Ext.dom.Layer
view source

setLocalY( )private

...

setLocation( x, y, [animate] ) : Ext.dom.Elementchainabledeprecated

Sets the position of the element in page coordinates. ...

Sets the position of the element in page coordinates.

\n\n

Defined in override Ext.dom.Element_position.

This method has been deprecated

Use setXY instead.

\n\n

Parameters

x : Number
X value for new position
\n
y : Number
Y value for new position
\n
animate : Boolean/Object (optional)
True for the default animation, or a standard\nElement animation config object
\n

Returns

Ext.dom.Element
this
\n

setOpacity( opacity, [animate] ) : Ext.dom.Elementchainable

Set the opacity of the element\n\nDefined in override Ext.dom.Element_style. ...

Set the opacity of the element

\n\n

Defined in override Ext.dom.Element_style.

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

setPositioning( posCfg ) : Ext.dom.Elementchainable

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

Set positioning with an object returned by getPositioning.

\n\n

Defined in override Ext.dom.Element_position.

Parameters

posCfg : Object
\n

Returns

Ext.dom.Element
this
\n

setRight( right ) : Ext.dom.Elementchainabledeprecated

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

Sets the element's CSS right style.

\n\n

Defined in override Ext.dom.Element_position.

This method has been deprecated

\n \n\n

Parameters

right : Number/String
Number of pixels or CSS string value to\nset as the right CSS property value
\n

Returns

Ext.dom.Element
this
\n

setScrollLeft( left ) : Ext.dom.Elementchainable

Sets the left scroll position\n\nDefined in override Ext.dom.Element_scroll. ...

Sets the left scroll position

\n\n

Defined in override Ext.dom.Element_scroll.

Parameters

left : Number
The left scroll position
\n

Returns

Ext.dom.Element
this
\n

setScrollTop( top ) : Ext.dom.Elementchainable

Sets the top scroll position\n\nDefined in override Ext.dom.Element_scroll. ...

Sets the top scroll position

\n\n

Defined in override Ext.dom.Element_scroll.

Parameters

top : Number
The top scroll position
\n

Returns

Ext.dom.Element
this
\n

Ext.dom.Layer
view source

setSize( width, height ) : Ext.dom.Element

overridden Element method\n\nSet the size of this Element. ...

overridden Element method

\n\n

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

\n\n

Defined in override Ext.dom.AbstractElement_style.

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

Returns

Ext.dom.Element
this
\n

Overrides: Ext.dom.AbstractElement.setSize

setStyle( property, [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.

\n\n

Defined in override Ext.dom.AbstractElement_style.

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.Layer
view source

setTop( top ) : Ext.dom.Elementchainabledeprecated

Sets the element's top position directly using CSS style\n(instead of setY). ...

Sets the element's top position directly using CSS style\n(instead of setY).

\n\n

Defined in override Ext.dom.Element_position.

This method has been deprecated

\n \n\n

Parameters

top : Number/String
Number of pixels or CSS string value to\nset as the top CSS property value
\n

Returns

Ext.dom.Element
this
\n

Overrides: Ext.dom.Element.setTop

setVertical( angle, cls )private

Changes this Element's state to \"vertical\" (rotated 90 or 270 degrees). ...

Changes this Element's state to \"vertical\" (rotated 90 or 270 degrees).\nThis involves inverting the getters and setters for height and width,\nand applying hooks for rotating getters and setters for border/margin/padding.\n(getWidth becomes getHeight and vice versa), setStyle and getStyle will\nalso return the inverse when height or width are being operated on.

\n\n

Defined in override Ext.dom.Element_style.

Parameters

angle : Number
the angle of rotation - either 90 or 270
\n
cls : String
an optional css class that contains the required\nstyles for switching the element to vertical orientation. Omit this if\nthe element already contains vertical styling. If cls is provided,\nit will be removed from the element when setHorizontal is called.
\n

setVisibilityMode( mode ) : Ext.dom.AbstractElementchainable

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

Returns

Ext.dom.AbstractElement
this
\n

Ext.dom.Layer
view source

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

overridden Element method\n\nSets the visibility of the element (see details). ...

overridden Element method

\n\n

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.

\n\n

Defined in override Ext.dom.Element_fx.

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.Element.setVisible

Ext.dom.Layer
view source

setWidth( width ) : Ext.dom.Element

overridden Element method\n\nSet the width of this Element. ...

overridden Element method

\n\n

Set the width of this Element.

\n\n

Defined in override Ext.dom.AbstractElement_style.

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

Returns

Ext.dom.Element
this
\n

Overrides: Ext.dom.AbstractElement.setWidth

Ext.dom.Layer
view source

setX( x, animate, duration, callback, easing ) : Ext.dom.Layerchainableprivate

overridden Element method ...

overridden Element method

Parameters

x : Object
\n
animate : Object
\n
duration : Object
\n
callback : Object
\n
easing : Object
\n

Returns

Ext.dom.Layer
this
\n

Overrides: Ext.dom.Element.setX

Ext.dom.Layer
view source

setXY( xy, animate, duration, callback, easing )private

...

Parameters

xy : Object
\n
animate : Object
\n
duration : Object
\n
callback : Object
\n
easing : Object
\n

Overrides: Ext.dom.Element.setXY

Ext.dom.Layer
view source

setY( y, animate, duration, callback, easing ) : Ext.dom.Layerchainableprivate

overridden Element method ...

overridden Element method

Parameters

y : Object
\n
animate : Object
\n
duration : Object
\n
callback : Object
\n
easing : Object
\n

Returns

Ext.dom.Layer
this
\n

Overrides: Ext.dom.Element.setY

Ext.dom.Layer
view source

setZIndex( zindex ) : Ext.Layer

Sets the z-index of this layer and adjusts any shadow and shim z-indexes. ...

Sets the z-index of this layer and adjusts any shadow and shim z-indexes. The layer\nz-index is automatically incremented depending upon the presence of a shim or a\nshadow in so that it always shows above those two associated elements.

\n\n

Any shim, will be assigned the passed z-index. A shadow will be assigned the next\nhighet z-index, and the Layer's element will receive the highest z-index.

Parameters

zindex : Number
The new z-index to set
\n

Returns

Ext.Layer
The Layer
\n

shift( options ) : Ext.Elementchainabledeprecated

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

\n\n

Defined in override Ext.dom.Element_anim.

This method has been deprecated since 4.0

Just use animate instead.

\n\n

Parameters

options : Object
Object literal with any of the Ext.fx.Anim config options
\n

Returns

Ext.Element
The Element
\n

show( [animate] ) : Ext.dom.Elementchainable

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.

\n\n

Defined in override Ext.dom.Element_fx.

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

slideIn( [anchor], [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\nExt.fx.Anim 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

\n\n

Defined in override Ext.dom.Element_anim.

Parameters

anchor : String (optional)
One of the valid Ext.fx.Anim anchor positions (defaults to top: 't')
\n
options : Object (optional)
Object literal with any of the Ext.fx.Anim 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

slideOut( [anchor], [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\nExt.fx.Anim 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

\n\n

Defined in override Ext.dom.Element_anim.

Parameters

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

Returns

Ext.dom.Element
The Element
\n

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

swallowEvent( eventName, [preventDefault] ) : Ext.dom.Elementchainable

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

switchOff( [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

\n\n

Defined in override Ext.dom.Element_anim.

Parameters

options : Object (optional)
Object literal with any of the Ext.fx.Anim config options
\n

Returns

Ext.dom.Element
The Element
\n

Ext.dom.Layer
view source

sync( doShow )private

Synchronize this Layer's associated elements, the shadow, and possibly the shim. ...

Synchronize this Layer's associated elements, the shadow, and possibly the shim.

\n\n

This code can execute repeatedly in milliseconds,\neg: dragging a Component configured liveDrag: true, or which has no ghost method\nso code size was sacrificed for efficiency (e.g. no getBox/setBox, no XY calls)

Parameters

doShow : Boolean
Pass true to ensure that the shadow is shown.
\n

syncContent( 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

toggle( [animate] ) : Ext.dom.Elementchainable

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

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

\n\n

Defined in override Ext.dom.Element_fx.

Parameters

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

Returns

Ext.dom.Element
this
\n

toggleCls( 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).

\n\n

Defined in override Ext.dom.AbstractElement_style.

Parameters

className : String
The CSS class to toggle
\n

Returns

Ext.dom.Element
this
\n

translatePoints( x, y )private

Defined in override Ext.rtl.dom.Element_position. ...

Defined in override Ext.rtl.dom.Element_position.

Parameters

x : Object
\n
y : Object
\n

translateXY( x, y )private

Defined in override Ext.rtl.dom.Element_position. ...

Defined in override Ext.rtl.dom.Element_position.

Parameters

x : Object
\n
y : Object
\n

un( eventName, fn, scope ) : Ext.dom.Elementchainable

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

unclip( ) : Ext.dom.Elementchainable

Return clipping (overflow) to original clipping before clip was called\n\nDefined in override Ext.dom.Element_style. ...

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

\n\n

Defined in override Ext.dom.Element_style.

Returns

Ext.dom.Element
this
\n

unmask( )

Hides a previously applied mask. ...

Hides a previously applied mask.

Overrides: Ext.dom.AbstractElement.unmask

unselectable( ) : Ext.dom.Elementchainable

Disables text selection for this element (normalized across browsers)\n\nDefined in override Ext.dom.Element_style. ...

Disables text selection for this element (normalized across browsers)

\n\n

Defined in override Ext.dom.Element_style.

Returns

Ext.dom.Element
this
\n

up( selector, [limit], [returnDom] ) : 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.

\n\n

Defined in override Ext.dom.AbstractElement_traversal.

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
returnDom : Boolean (optional)
True to return the DOM node instead of Ext.dom.Element
\n
Defaults to: false

Returns

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

update( html, [loadScripts], [callback] ) : Ext.dom.Elementchainable

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

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

Creates and wraps this element with another element\n\nDefined in override Ext.dom.AbstractElement_insertion. ...

Creates and wraps this element with another element

\n\n

Defined in override Ext.dom.AbstractElement_insertion.

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

addMembers( members )chainablestatic

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

addMethods( )privatestatic

...

addStatics( members ) : Ext.Basechainablestatic

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

addToCache( el, id )privatestatic

...

Parameters

el : Object
\n
id : Object
\n

addUnits( size, units )privatestatic

Test if size has a unit, otherwise appends the passed unit string, or the default for this Element. ...

Test if size has a unit, otherwise appends the passed unit string, or the default for this Element.

\n\n

Defined in override Ext.dom.AbstractElement_static.

Parameters

size : Object
{Object} The size to set
\n
units : Object
{String} The units to append to a numeric size value
\n

addXtype( xtype )chainableprivatestatic

...

Parameters

xtype : Object
\n

borrow( fromClass, members ) : Ext.Basechainableprivatestatic

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

camelReplaceFn( m, a )privatestatic

private\n\nDefined in override Ext.dom.AbstractElement_static. ...

private

\n\n

Defined in override Ext.dom.AbstractElement_static.

Parameters

m : Object
\n
a : Object
\n

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

createAlias( alias, 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

extend( config )privatestatic

...

Parameters

config : Object
\n

fromPoint( x, y ) : Stringstatic

Returns the top Element that is located at the passed coordinates\n\nDefined in override Ext.dom.AbstractElement_static. ...

Returns the top Element that is located at the passed coordinates

\n\n

Defined in override Ext.dom.AbstractElement_static.

Parameters

x : Number
The x coordinate
\n
y : Number
The y coordinate
\n

Returns

String
The found Element
\n

get( 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

When passing an id, it should not include the # character that is used for a css selector.

\n\n

// For an element with id 'foo'\nExt.get('foo'); // Correct\nExt.get('#foo'); // Incorrect\n

\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

getDocumentHeight( ) : Numberstatic

Retrieves the document height\n\nDefined in override Ext.dom.AbstractElement_static. ...

Retrieves the document height

\n\n

Defined in override Ext.dom.AbstractElement_static.

Returns

Number
documentHeight
\n

getDocumentWidth( ) : Numberstatic

Retrieves the document width\n\nDefined in override Ext.dom.AbstractElement_static. ...

Retrieves the document width

\n\n

Defined in override Ext.dom.AbstractElement_static.

Returns

Number
documentWidth
\n

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

getOrientation( ) : Stringstatic

Retrieves the current orientation of the window. ...

Retrieves the current orientation of the window. This is calculated by\ndeterming if the height is greater than the width.

\n\n

Defined in override Ext.dom.AbstractElement_static.

Returns

String
Orientation of window: 'portrait' or 'landscape'
\n

getViewSize( ) : Objectstatic

Retrieves the viewport size of the window. ...

Retrieves the viewport size of the window.

\n\n

Defined in override Ext.dom.AbstractElement_static.

Returns

Object
object containing width and height properties
\n

getViewportHeight( ) : Numberstatic

Retrieves the viewport height of the window. ...

Retrieves the viewport height of the window.

\n\n

Defined in override Ext.dom.AbstractElement_static.

Returns

Number
viewportHeight
\n

getViewportWidth( ) : Numberstatic

Retrieves the viewport width of the window. ...

Retrieves the viewport width of the window.

\n\n

Defined in override Ext.dom.AbstractElement_static.

Returns

Number
viewportWidth
\n

implement( )deprecatedstatic

Adds members to class. ...

Adds members to class.

This method has been deprecated since 4.1

Use addMembers instead.

\n\n

isAncestor( p, c )privatestatic

Defined in override Ext.dom.AbstractElement_static. ...

Defined in override Ext.dom.AbstractElement_static.

Parameters

p : Object
\n
c : Object
\n

mergeClsList( clsList1, 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

// 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

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

mixin( name, mixinClass )privatestatic

Used internally by the mixins pre-processor ...

Used internally by the mixins pre-processor

Parameters

name : Object
\n
mixinClass : Object
\n

normalize( prop ) : Stringstatic

Normalizes CSS property keys from dash delimited to camel case JavaScript Syntax. ...

Normalizes CSS property keys from dash delimited to camel case JavaScript Syntax.\nFor example:

\n\n

border-width -> borderWidth
padding-top -> paddingTop

\n\n\n

Defined in override Ext.dom.AbstractElement_static.

Parameters

prop : String
The property to normalize
\n

Returns

String
The normalized string
\n

onExtended( fn, scope )chainableprivatestatic

...

Parameters

fn : Object
\n
scope : Object
\n

override( members ) : Ext.Basechainabledeprecatedstatic

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

parseBox( box ) : Objectstatic

Parses a number or string representing margin sizes into an object. ...

Parses a number or string representing margin sizes into an object. Supports CSS-style margin declarations\n(e.g. 10, \"10\", \"10 10\", \"10 10 10\" and \"10 10 10 10\" are all valid options and would return the same result)

\n\n

Defined in override Ext.dom.AbstractElement_static.

Parameters

box : Number/String
The encoded margins
\n

Returns

Object
An object with margin sizes for top, right, bottom and left
\n

parseStyles( styles ) : Objectstatic

Converts a CSS string into an object with a property for each style. ...

Converts a CSS string into an object with a property for each style.

\n\n

The sample code below would return an object with 2 properties, one\nfor background-color and one for color.

\n\n

var css = 'background-color: red;color: blue; ';\nconsole.log(Ext.dom.Element.parseStyles(css));\n

\n\n

Defined in override Ext.dom.AbstractElement_static.

Parameters

styles : String
A CSS string
\n

Returns

Object
styles
\n

removeCls( existingClsList, 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

// 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

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

triggerExtended( )privatestatic

...