For up to date documentation and features, visit http://docs.sencha.com/ext-js/4-0

## Sencha Documentation

# Ext.core.Element

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

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

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

Usage:

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

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

Animations

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

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

    // no animation
    el.setWidth(100);

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

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

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

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

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

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

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

Also see the `animate` method for another animation technique.

Composite (Collections of) Elements

For working with collections of Elements, see Ext.CompositeElement

Defined By

### Properties

Ext.core.Element
view source
DISPLAY : Number

Visibility mode constant for use with setVisibilityMode. Use display to hide element

Visibility mode constant for use with setVisibilityMode. Use display to hide element

Ext.core.Element
view source
OFFSETS : Number

Visibility mode constant for use with setVisibilityMode. Use offsets (x and y positioning offscreen) to hide element.

Visibility mode constant for use with setVisibilityMode. Use offsets (x and y positioning offscreen) to hide element.

Ext.core.Element
view source
VISIBILITY : Number

Visibility mode constant for use with setVisibilityMode. Use visibility to hide element

Visibility mode constant for use with setVisibilityMode. Use visibility to hide element

Ext.core.Element
view source
autoBoxAdjust : Boolean

true to automatically adjust width and height settings for box-model issues (default to true)

true to automatically adjust width and height settings for box-model issues (default to true)

Ext.core.Element
view source
defaultUnit : String

The default unit to append to CSS values where a unit isn't provided (defaults to px).

The default unit to append to CSS values where a unit isn't provided (defaults to px).

Ext.core.Element
view source
dom : HTMLElement

The DOM element

The DOM element

Ext.core.Element
view source
getAttribute : Object

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.

Ext.core.Element
view source
hasCls : Object

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.

Ext.core.Element
view source
id : String

The DOM element ID

The DOM element ID

Ext.core.Element
view source
originalDisplay : String

The element's default display mode (defaults to "")

The element's default display mode (defaults to "")

Ext.core.Element
view source
toggleCls : Object

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

Ext.core.Element
view source
visibilityCls : String

Defaults to 'x-hide-nosize'

Defaults to 'x-hide-nosize'

Defined By

### Methods

Ext.core.Element
view source
addCls( String/Array className) : Ext.core.Element

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

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

### Parameters

- className : String/Array

  The CSS classes to add separated by space, or an array of classes

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
addClsOnClick( String className) : Ext.core.Element
Sets up event handlers to add and remove a css class when the mouse is down and then up on this element (a click 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)

### Parameters

- className : String

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
addClsOnFocus( String className) : Ext.core.Element

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

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

### Parameters

- className : String

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
addClsOnOver( String className) : Ext.core.Element

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

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

### Parameters

- className : String

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
addKeyListener( Number/Array/Object/String key, Function fn, [Object scope]) : Ext.util.KeyMap

Convenience method for constructing a KeyMap

Convenience method for constructing a KeyMap

### Parameters

- key : Number/Array/Object/String

  Either a string with the keys to listen for, the numeric key code, array of key codes or an object with the following options: `{key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)}`

- fn : Function

  The function to call

- scope : Object

  (optional) The scope (`this` reference) in which the specified function is executed. Defaults to this Element.

### Returns

- Ext.util.KeyMap

  The KeyMap created

Ext.core.Element
view source
addKeyMap( Object config) : Ext.util.KeyMap

Creates a KeyMap for this element

Creates a KeyMap for this element

### Parameters

- config : Object

  The KeyMap config. See Ext.util.KeyMap for more details

### Returns

- Ext.util.KeyMap

  The KeyMap created

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

Appends an event handler to this element. The shorthand version on is equivalent.

Appends an event handler to this element. The shorthand version on is equivalent.

### Parameters

- eventName : String

  The name of event to handle.

- fn : Function

  The handler function the event invokes. This function is passed the following parameters:

  - evt : EventObject
    The EventObject describing the event.
  - el : HtmlElement
    The DOM element which was the target of the event. Note that this may be filtered by using the `delegate` option.
  - o : Object
    The options object from the addListener call.
- scope : Object

  (optional) The scope (`this` reference) in which the handler function is executed. If omitted, defaults to this Element..

- options : Object

  (optional) An object containing handler configuration properties. This may contain any of the following properties:

  - scope Object :
    The scope (`this` reference) in which the handler function is executed. If omitted, defaults to this Element.
  - delegate String:
    A simple selector to filter the target or look for a descendant of the target. See below for additional details.
  - stopEvent Boolean:
    True to stop the event. That is stop propagation, and prevent the default action.
  - preventDefault Boolean:
    True to prevent the default action
  - stopPropagation Boolean:
    True to prevent event propagation
  - normalized Boolean:
    False to pass a browser event to the handler function instead of an Ext.EventObject
  - target Ext.core.Element:
    Only call the handler if the event was fired on the target Element, not if the event was bubbled up from a child node.
  - delay Number:
    The number of milliseconds to delay the invocation of the handler after the event fires.
  - single Boolean:
    True to add a handler to handle just the next firing of the event, and then remove itself.
  - buffer Number:
    Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.

  Combining Options
  In the following examples, the shorthand form on is used rather than the more verbose addListener. The two are equivalent. Using the options argument, it is possible to combine different types of listeners:
  A delayed, one-time listener that auto stops the event and adds a custom argument (forumId) to the options object. The options object is available as the third parameter in the handler function.

  Code:

      el.on('click', this.onClick, this, {
          single: true,
          delay: 100,
          stopEvent : true,
          forumId: 4
      });

  Attaching multiple handlers in 1 call
  The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers.

  Code:

      el.on({
          'click' : {
              fn: this.onClick,
              scope: this,
              delay: 100
          },
          'mouseover' : {
              fn: this.onMouseOver,
              scope: this
          },
          'mouseout' : {
              fn: this.onMouseOut,
              scope: this
          }
      });

  Or a shorthand syntax:
  Code:

      el.on({
          'click' : this.onClick,
          'mouseover' : this.onMouseOver,
          'mouseout' : this.onMouseOut,
          scope: this
      });

  delegate

  This is a configuration option that you can pass along when registering a handler for an event to assist with event delegation. Event delegation is a technique that is used to reduce memory consumption and prevent exposure to memory-leaks. By registering an event for a container element as opposed to each element within a container. By setting this configuration option to a simple selector, the target element will be filtered to look for a descendant of the target. For example:

      // using this markup:
      <div id='elId'>
          <p id='p1'>paragraph one</p>
          <p id='p2' class='clickable'>paragraph two</p>
          <p id='p3'>paragraph three</p>
      </div>
      // utilize event delegation to registering just one handler on the container element:
      el = Ext.get('elId');
      el.on(
          'click',
          function(e,t) {
              // handle click
              console.info(t.id); // 'p2'
          },
          this,
          {
              // filter the target element to be a descendant with the class 'clickable'
              delegate: '.clickable'
          }
      );

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
adjustWidth( Object width) : void

TODO: Look at this

TODO: Look at this

### Parameters

- width : Object

### Returns

- void

Ext.core.Element
view source
alignTo( Mixed element, String position, [Array offsets], [Boolean/Object animate]) : Ext.core.Element
Aligns this element with another element relative to the specified anchor points. If the other element is the documen...

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

- Blank: Defaults to aligning the element's top-left corner to the target's bottom-left corner ("tl-bl").
- One anchor (deprecated): The passed anchor position is used as the target element's anchor point. The element being aligned will position its top-left corner (tl) to that point. This method has been deprecated in favor of the newer two anchor syntax below.
- Two anchors: If two values from the table below are passed separated by a dash, the first value is used as the element's anchor point, and the second value is used as the target's anchor point.

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

    Value  Description
    -----  -----------------------------
    tl     The top left corner (default)
    t      The center of the top edge
    tr     The top right corner
    l      The center of the left edge
    c      In the center of the element
    r      The center of the right edge
    bl     The bottom left corner
    b      The center of the bottom edge
    br     The bottom right corner

Example Usage:

    // align el to other-el using the default positioning ("tl-bl", non-constrained)
    el.alignTo("other-el");

    // align the top left corner of el with the top right corner of other-el (constrained to viewport)
    el.alignTo("other-el", "tr?");

    // align the bottom right corner of el with the center left edge of other-el
    el.alignTo("other-el", "br-l?");

    // align the center of el with the bottom left corner of other-el and
    // adjust the x position by -6 pixels (and the y position by 0)
    el.alignTo("other-el", "c-bl", [-6, 0]);

### Parameters

- element : Mixed

  The element to align to.

- position : String

  (optional, defaults to "tl-bl?") The position to align to.

- offsets : Array

  (optional) Offset the positioning by [x, y]

- animate : Boolean/Object

  (optional) true for the default animation or a standard Element animation config object

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
anchorTo( Mixed element, String position, [Array offsets], [Boolean/Object animate], [Boolean/Number monitorScroll], Function callback) : Ext.core.Element

Anchors an element to another element and realigns it when the window is resized.

Anchors an element to another element and realigns it when the window is resized.

### Parameters

- element : Mixed

  The element to align to.

- position : String

  The position to align to.

- offsets : Array

  (optional) Offset the positioning by [x, y]

- animate : Boolean/Object

  (optional) True for the default animation or a standard Element animation config object

- monitorScroll : Boolean/Number

  (optional) True to monitor body scroll and reposition. If this parameter is a number, it is used as the buffer delay (defaults to 50ms).

- callback : Function

  The function to call after the animation finishes

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
appendChild( String/HTMLElement/Array/Element/CompositeElement el) : Ext.core.Element

Appends the passed element(s) to this element

Appends the passed element(s) to this element

### Parameters

- el : String/HTMLElement/Array/Element/CompositeElement

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
appendTo( Mixed el) : Ext.core.Element

Appends this element to the passed element

Appends this element to the passed element

### Parameters

- el : Mixed

  The new parent element

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
applyStyles( String/Object/Function styles) : Ext.core.Element

More flexible version of setStyle for setting style properties.

More flexible version of setStyle for setting style properties.

### Parameters

- styles : String/Object/Function

  A style specification string, e.g. "width:100px", or object in the form {width:"100px"}, or a function which returns such a specification.

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
blur : Ext.core.Element

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

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

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
boxWrap( [String class]) : Ext.core.Element
Wraps the specified element with a special 9 element markup/CSS block that renders by default as a gray container wit...

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

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

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

Example usage:

        // Basic box wrap
        Ext.get("foo").boxWrap();

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

### Parameters

- class : String

  (optional) A base CSS class to apply to the containing wrapper element (defaults to `'x-box'`). Note that there are a number of CSS rules that are dependent on this name to make the overall effect work, so if you supply an alternate base class, make sure you also supply all of the necessary rules.

### Returns

- Ext.core.Element

  The outermost wrapping element of the created box structure.

Ext.core.Element
view source
center( [Mixed centerIn]) : void

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

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

### Parameters

- centerIn : Mixed

  (optional) The element in which to center the element.

### Returns

- void

Ext.core.Element
view source
child( String selector, [Boolean returnDom]) : HTMLElement/Ext.core.Element

Selects a single direct child based on the passed CSS selector (the selector should not contain an id).

Selects a single direct child based on the passed CSS selector (the selector should not contain an id).

### Parameters

- selector : String

  The CSS selector

- returnDom : Boolean

  (optional) True to return the DOM node instead of Ext.core.Element (defaults to false)

### Returns

- HTMLElement/Ext.core.Element

  The child Ext.core.Element (or DOM node if returnDom = true)

Ext.core.Element
view source
clean( [Boolean forceReclean]) : void

Removes Empty, or whitespace filled text nodes. Combines adjacent 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 so you can call this over and over. However, if you update the element and need to force a reclean, you can pass true.

### Returns

- void

Ext.core.Element
view source
clearListeners : Ext.core.Element

Removes all previous added listeners from this element

Removes all previous added listeners from this element

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
clearOpacity : Ext.core.Element

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

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

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
clearPositioning( [String value]) : Ext.core.Element

Clear positioning back to the default when the document was loaded

Clear positioning back to the default when the document was loaded

### Parameters

- value : String

  (optional) The value to use for the left,right,top,bottom, defaults to '' (empty string). You could use 'auto'.

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
clip : Ext.core.Element

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

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

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
contains( HTMLElement/String el) : Boolean

Returns true if this element is an ancestor of the passed element

Returns true if this element is an ancestor of the passed element

### Parameters

- el : HTMLElement/String

  The element to check

### Returns

- Boolean

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

Ext.core.Element
view source
createChild( Object config, [HTMLElement insertBefore], [Boolean returnDom]) : Ext.core.Element
Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child e...

Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child element.

### Parameters

- config : Object

  DomHelper element config object. If no tag is specified (e.g., {tag:'input'}) then a div will be automatically generated with the specified attributes.

- insertBefore : HTMLElement

  (optional) a child element of this element

- returnDom : Boolean

  (optional) true to return the dom node instead of creating an Element

### Returns

- Ext.core.Element

  The new child element

Ext.core.Element
view source
createProxy( String/Object config, [String/HTMLElement renderTo], [Boolean matchBox]) : Ext.core.Element

Creates a proxy element of this element

Creates a proxy element of this element

### Parameters

- config : String/Object

  The class name of the proxy element or a DomHelper config object

- renderTo : String/HTMLElement

  (optional) The element or element id to render the proxy to (defaults to document.body)

- matchBox : Boolean

  (optional) True to align and size the proxy to this element now (defaults to false)

### Returns

- Ext.core.Element

  The new proxy element

Ext.core.Element
view source
createShim : Ext.core.Element

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

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

### Returns

- Ext.core.Element

  The new shim element

Ext.core.Element
view source
destroy : void

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

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

### Returns

- void

Ext.core.Element
view source
down( String selector, [Boolean returnDom]) : HTMLElement/Ext.core.Element
Selects a single child at any depth below this element based on the passed CSS selector (the selector should not cont...

Selects a single child at any depth below this element based on the passed CSS selector (the selector should not contain an id).

### Parameters

- selector : String

  The CSS selector

- returnDom : Boolean

  (optional) True to return the DOM node instead of Ext.core.Element (defaults to false)

### Returns

- HTMLElement/Ext.core.Element

  The child Ext.core.Element (or DOM node if returnDom = true)

Ext.core.Element
view source
enableDisplayMode( [String display]) : Ext.core.Element

Convenience method for setVisibilityMode(Element.DISPLAY)

Convenience method for setVisibilityMode(Element.DISPLAY)

### Parameters

- display : String

  (optional) What to set display to when visible

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
fadeIn( [Object options]) : Ext.Element
Fade an element in (from transparent to opaque). The ending opacity can be specified using the endOpacity config opt...

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

    // default: fade in from opacity 0 to 100%
    el.fadeIn();

    // custom: fade in from opacity 0 to 75% over 2 seconds
    el.fadeIn({ endOpacity: .75, duration: 2});

    // common config options shown with default values
    el.fadeIn({
        endOpacity: 1, //can be any value between 0 and 1 (e.g. .5)
        easing: 'easeOut',
        duration: 500
    });

### Parameters

- options : Object

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

### Returns

- Ext.Element

  The Element

Ext.core.Element
view source
fadeOut( [Object options]) : Ext.Element
Fade an element out (from opaque to transparent). The ending opacity can be specified using the endOpacity config op...

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

    // default: fade out from the element's current opacity to 0
    el.fadeOut();

    // custom: fade out from the element's current opacity to 25% over 2 seconds
    el.fadeOut({ endOpacity: .25, duration: 2});

    // common config options shown with default values
    el.fadeOut({
        endOpacity: 0, //can be any value between 0 and 1 (e.g. .5)
        easing: 'easeOut',
        duration: 500,
        remove: false,
        useDisplay: false
    });

### Parameters

- options : Object

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

### Returns

- Ext.Element

  The Element

Ext.core.Element
view source
findParent( String selector, [Number/Mixed maxDepth], [Boolean returnEl]) : HTMLElement
Looks at this node and then at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:fi...

Looks at this node and then at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child)

### Parameters

- selector : String

  The simple selector to test

- maxDepth : Number/Mixed

  (optional) The max depth to search as a number or element (defaults to 50 || document.body)

- returnEl : Boolean

  (optional) True to return a Ext.core.Element object instead of DOM node

### Returns

- HTMLElement

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

Ext.core.Element
view source
findParentNode( String selector, [Number/Mixed maxDepth], [Boolean returnEl]) : HTMLElement

Looks at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child)

Looks at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child)

### Parameters

- selector : String

  The simple selector to test

- maxDepth : Number/Mixed

  (optional) The max depth to

              search as a number or element (defaults to 10 || document.body)

- returnEl : Boolean

  (optional) True to return a Ext.core.Element object instead of DOM node

### Returns

- HTMLElement

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

Ext.core.Element
view source
first( [String selector], [Boolean returnDom]) : Ext.core.Element/HTMLElement

Gets the first child, skipping text nodes

Gets the first child, skipping text nodes

### Parameters

- selector : String

  (optional) Find the next sibling that matches the passed simple selector

- returnDom : Boolean

  (optional) True to return a raw dom node instead of an Ext.core.Element

### Returns

- Ext.core.Element/HTMLElement

  The first child or null

Ext.core.Element
view source
fly( String/HTMLElement el, [String named]) : Element
Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to t...

Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element - the dom node can be overwritten by other code. Shorthand of fly

Use this to make one-time references to DOM elements which are not going to be accessed again either by application code, or by Ext's classes. If accessing an element which will be processed regularly, then Ext.get will be more appropriate to take advantage of the caching provided by the Ext.core.Element class.

### Parameters

- el : String/HTMLElement

  The dom node or id

- named : String

  (optional) Allows for creation of named reusable flyweights to prevent conflicts (e.g. internally Ext uses "_global")

### Returns

- Element

  The shared Element object (or null if no matching element was found)

Ext.core.Element
view source
focus( [Number defer], Object dom) : Ext.core.Element

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

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

### Parameters

- defer : Number

  (optional) Milliseconds to defer the focus

- dom : Object

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
frame( [String color], [Number count], [Object options]) : Ext.core.Element
Shows a ripple of exploding, attenuating borders to draw attention to an Element. Usage: // default: a single light ...

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

    // default: a single light blue ripple
    el.frame();

    // custom: 3 red ripples lasting 3 seconds total
    el.frame("#ff0000", 3, { duration: 3 });

    // common config options shown with default values
    el.frame("#C3DAF9", 1, {
        duration: 1 //duration of each individual ripple.
        // Note: Easing is not configurable and will be ignored if included
    });

### Parameters

- color : String

  (optional) The color of the border. Should be a 6 char hex color without the leading # (defaults to light blue: 'C3DAF9').

- count : Number

  (optional) The number of ripples to display (defaults to 1)

- options : Object

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

### Returns

- Ext.core.Element

  The Element

Ext.core.Element
view source
fromPoint( Number x, Number x) : String

Returns the top Element that is located at the passed coordinates

Returns the top Element that is located at the passed coordinates

### Parameters

- x : Number

  The x coordinate

- x : Number

  The y coordinate

### Returns

- String

  The found Element

Ext.core.Element
view source
get( Mixed el) : Element
Retrieves Ext.core.Element objects. This method does not retrieve Components. This method retrieves Ext.core.Element...

Retrieves Ext.core.Element objects.

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

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

### Parameters

- el : Mixed

  The id of the node, a DOM Node or an existing Element.

### Returns

- Element

  The Element object (or null if no matching element was found)

Ext.core.Element
view source
getAlignToXY( Mixed element, String position, [Array offsets]) : Array
Gets the x,y coordinates to align this element with another element. See alignTo for more info on the supported posit...

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

### Parameters

- element : Mixed

  The element to align to.

- position : String

  (optional, defaults to "tl-bl?") The position to align to.

- offsets : Array

  (optional) Offset the positioning by [x, y]

### Returns

- Array

  [x, y]

Ext.core.Element
view source
getAnchorXY( [String anchor], [Boolean local], [Object size]) : Array

Gets the x,y coordinates specified by the anchor position on the element.

Gets the x,y coordinates specified by the anchor position on the element.

### Parameters

- anchor : String

  (optional) The specified anchor position (defaults to "c"). See alignTo for details on supported anchor positions.

- local : Boolean

  (optional) True to get the local (element top/left-relative) anchor position instead of page coordinates

- size : Object

  (optional) An object containing the size to use for calculating anchor position {width: (target width), height: (target height)} (defaults to the element's current size)

### Returns

- Array

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

Ext.core.Element
view source
getAttributeNS( String namespace, String name) : String

Returns the value of a namespaced attribute from the element's underlying DOM node.

Returns the value of a namespaced attribute from the element's underlying DOM node.

### Parameters

- namespace : String

  The namespace in which to look for the attribute

- name : String

  The attribute name

### Returns

- String

  The attribute value @deprecated

Ext.core.Element
view source
getBorderWidth( String side) : Number

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

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

### Parameters

- side : String

  Can be t, l, r, b or any combination of those to add multiple values. For example, passing `'lr'` would get the border left width + the border right width.

### Returns

- Number

  The width of the sides passed added together

Ext.core.Element
view source
getBottom( Boolean local) : Number

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

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

### Parameters

- local : Boolean

  True to get the local css position instead of page coordinate

### Returns

- Number

Ext.core.Element
view source
getBox( [Boolean contentBox], [Boolean local]) : Object
Return an object defining the area of this Element which can be passed to setBox to set another Element's size/locati...

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

### Parameters

- contentBox : Boolean

  (optional) If true a box for the content of the element is returned.

- local : Boolean

  (optional) If true the element's left and top are returned instead of page x/y.

### Returns

- Object

  box An object in the format

      {
          x: <Element's X position>,
          y: <Element's Y position>,
          width: <Element's width>,
          height: <Element's height>,
          bottom: <Element's lower bound>,
          right: <Element's rightmost bound>
      }

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

Ext.core.Element
view source
getCenterXY : Array

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

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

### Returns

- Array

  The x, y values [x, y]

Ext.core.Element
view source
getColor( String attr, String defaultValue, [String prefix]) : void
Return the CSS color for the specified CSS attribute. rgb, 3 digit (like #fff) and valid values are convert to standa...

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

### Parameters

- attr : String

  The css attribute

- defaultValue : String

  The default value to use when a valid color isn't found

- prefix : String

  (optional) defaults to #. Use an empty string when working with color anims.

### Returns

- void

Ext.core.Element
view source
getComputedHeight : Number
Returns either the offsetHeight or the height of this element based on CSS height adjusted by padding or borders when...

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

### Returns

- Number

Ext.core.Element
view source
getComputedWidth : Number
Returns either the offsetWidth or the width of this element based on CSS width adjusted by padding or borders when ne...

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

### Returns

- Number

Ext.core.Element
view source
getConstrainVector( Object constrainTo, Object proposedPosition) : Array
Returns the [X, Y] vector by which this element must be translated to make a best attempt to constrain within the pas...

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

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

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

### Parameters

- constrainTo : Object

  {Mixed} The Element or Region into which this element is to be constrained.

- proposedPosition : Object

  {Array} A proposed `[X, Y]` position to test for validity and to produce a vector for instead of using this Element's current position;

### Returns

- Array

  If this element needs to be translated, an `[X, Y]` vector by which this element must be translated. Otherwise, `false`.

Ext.core.Element
view source
getDocumentHeight : Number

Retrieves the document height

Retrieves the document height

### Returns

- Number

  documentHeight

Ext.core.Element
view source
getDocumentWidth : Number

Retrieves the document width

Retrieves the document width

### Returns

- Number

  documentWidth

Ext.core.Element
view source
getFrameWidth( String sides, Object onlyContentBox) : Number
Returns the sum width of the padding and borders for the passed "sides". See getBorderWidth() for more informat...

Returns the sum width of the padding and borders for the passed "sides". See getBorderWidth()

         for more information about the sides.

### Parameters

- sides : String
- onlyContentBox : Object

### Returns

- Number

Ext.core.Element
view source
getHeight( [Boolean contentHeight], Object preciseHeight) : Number

Returns the offset height of the element

Returns the offset height of the element

### Parameters

- contentHeight : Boolean

  (optional) true to get the height minus borders and padding

- preciseHeight : Object

### Returns

- Number

  The element's height

Ext.core.Element
view source
getLeft( Boolean local) : Number

Gets the left X coordinate

Gets the left X coordinate

### Parameters

- local : Boolean

  True to get the local css position instead of page coordinate

### Returns

- Number

Ext.core.Element
view source
getLoader : Ext.ElementLoader

Gets this element's ElementLoader

Gets this element's ElementLoader

### Returns

- Ext.ElementLoader

  The loader

Ext.core.Element
view source
getMargin( [String sides]) : Object/Number
Returns an object with properties top, left, right and bottom representing the margins of this element unless sides i...

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

### Parameters

- sides : String

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

### Returns

- Object/Number

Ext.core.Element
view source
getOffsetsTo( Mixed element) : Array
Returns the offsets of this element from the passed element. Both element must be part of the DOM tree and not have d...

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

### Parameters

- element : Mixed

  The element to get the offsets from.

### Returns

- Array

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

Ext.core.Element
view source
getOrientation : String
Retrieves the current orientation of the window. This is calculated by determing if the height is greater than the wi...

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

### Returns

- String

  Orientation of window: 'portrait' or 'landscape'

Ext.core.Element
view source
getPadding( String side) : Number

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

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

### Parameters

- side : String

  Can be t, l, r, b or any combination of those to add multiple values. For example, passing `'lr'` would get the padding left + the padding right.

### Returns

- Number

  The padding of the sides passed added together

Ext.core.Element
view source
getPageBox( [Boolean asRegion]) : Object
Return an object defining the area of this Element which can be passed to setBox to set another Element's size/locati...

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

### Parameters

- asRegion : Boolean

  (optional) If true an Ext.util.Region will be returned

### Returns

- Object

  box An object in the format

      {
          x: <Element's X position>,
          y: <Element's Y position>,
          width: <Element's width>,
          height: <Element's height>,
          bottom: <Element's lower bound>,
          right: <Element's rightmost bound>
      }

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

Ext.core.Element
view source
getPositioning : Object
Gets an object with all CSS positioning properties. Useful along with setPostioning to get snapshot before performing...

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

### Returns

- Object

Ext.core.Element
view source
getRegion : Region
Returns the region of this element. The element must be part of the DOM tree to have a region (display:none or elemen...

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

### Returns

- Region

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

Ext.core.Element
view source
getRight( Boolean local) : Number

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

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

### Parameters

- local : Boolean

  True to get the local css position instead of page coordinate

### Returns

- Number

Ext.core.Element
view source
getScroll : Object

Returns the current scroll position of the element.

Returns the current scroll position of the element.

### Returns

- Object

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

Ext.core.Element
view source
getSize( [Boolean contentSize]) : Object

Returns the size of the element.

Returns the size of the element.

### Parameters

- contentSize : Boolean

  (optional) true to get the width/size minus borders and padding

### Returns

- Object

  An object containing the element's size {width: (element width), height: (element height)}

Ext.core.Element
view source
getStyle( String property) : String

Normalizes currentStyle and computedStyle.

Normalizes currentStyle and computedStyle.

### Parameters

- property : String

  The style property whose value is returned.

### Returns

- String

  The current value of the style property for this element.

Ext.core.Element
view source
getStyleSize : void
Returns the dimensions of the element available to lay content out in. getStyleSize utilizes prefers style sizing if...

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

getStyleSize utilizes prefers style sizing if present, otherwise it chooses the larger of offsetHeight/clientHeight and offsetWidth/clientWidth. To obtain the size excluding scrollbars, use getViewSize Sizing of the document body is handled at the adapter level which handles special cases for IE and strict modes, etc.

### Returns

- void

Ext.core.Element
view source
getStyles( String style1, String style2, String etc) : Object
Returns an object with properties matching the styles requested. For example, el.getStyles('color', 'font-size', 'wid...

Returns an object with properties matching the styles requested. For example, el.getStyles('color', 'font-size', 'width') might return {'color': '#FFFFFF', 'font-size': '13px', 'width': '100px'}.

### Parameters

- style1 : String

  A style name

- style2 : String

  A style name

- etc : String

  .

### Returns

- Object

  The style object

Ext.core.Element
view source
getTextWidth( String text, Number min, Number max) : Number

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

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

### Parameters

- text : String

  The text to measure. Defaults to the innerHTML of the element.

- min : Number

  (Optional) The minumum value to return.

- max : Number

  (Optional) The maximum value to return.

### Returns

- Number

  The text width in pixels.

Ext.core.Element
view source
getTop( Boolean local) : Number

Gets the top Y coordinate

Gets the top Y coordinate

### Parameters

- local : Boolean

  True to get the local css position instead of page coordinate

### Returns

- Number

Ext.core.Element
view source
getValue( Boolean asNumber) : String/Number

Returns the value of the "value" attribute

Returns the value of the "value" attribute

### Parameters

- asNumber : Boolean

  true to parse the value as a number

### Returns

- String/Number

Ext.core.Element
view source
getViewRegion : Region

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

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

### Returns

- Region

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

Ext.core.Element
view source
getViewSize : void
Returns the dimensions of the element available to lay content out in. If the element (or any ancestor element) has C...

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

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

example:

            var vpSize = Ext.getBody().getViewSize();

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

getViewSize utilizes clientHeight/clientWidth which excludes sizing of scrollbars. To obtain the size including scrollbars, use getStyleSize Sizing of the document body is handled at the adapter level which handles special cases for IE and strict modes, etc.

### Returns

- void

Ext.core.Element
view source
getViewportHeight : Number

Retrieves the viewport height of the window.

Retrieves the viewport height of the window.

### Returns

- Number

  viewportHeight

Ext.core.Element
view source
getViewportWidth : Number

Retrieves the viewport width of the window.

Retrieves the viewport width of the window.

### Returns

- Number

  viewportWidth

Ext.core.Element
view source
getWidth( [Boolean contentWidth], Object preciseWidth) : Number

Returns the offset width of the element

Returns the offset width of the element

### Parameters

- contentWidth : Boolean

  (optional) true to get the width minus borders and padding

- preciseWidth : Object

### Returns

- Number

  The element's width

Ext.core.Element
view source
getX : Number
Gets the current X position of the element based on page coordinates. Element must be part of the DOM tree to have p...

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

### Returns

- Number

  The X position of the element

Ext.core.Element
view source
getXY : Array
Gets the current position of the element based on page coordinates. Element must be part of the DOM tree to have pag...

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

### Returns

- Array

  The XY position of the element

Ext.core.Element
view source
getY : Number
Gets the current Y position of the element based on page coordinates. Element must be part of the DOM tree to have p...

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

### Returns

- Number

  The Y position of the element

Ext.core.Element
view source
ghost( [String anchor], [Object options]) : Ext.core.Element
Slides the element while fading it out of view. An anchor point can be optionally passed to set the ending point of ...

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

    // default: slide the element downward while fading out
    el.ghost();

    // custom: slide the element out to the right with a 2-second duration
    el.ghost('r', { duration: 2 });

    // common config options shown with default values
    el.ghost('b', {
        easing: 'easeOut',
        duration: 500
    });

### Parameters

- anchor : String

  (optional) One of the valid Fx anchor positions (defaults to bottom: 'b')

- options : Object

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

### Returns

- Ext.core.Element

  The Element

Ext.core.Element
view source
hide( [Boolean/Object animate]) : Ext.core.Element

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

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

### Parameters

- animate : Boolean/Object

  (optional) true for the default animation or a standard Element animation config object

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
highlight( [String color], [Object options]) : Ext.core.Element
Highlights the Element by setting a color (applies to the background-color by default, but can be changed using the "...

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

    // default: highlight background to yellow
    el.highlight();

    // custom: highlight foreground text to blue for 2 seconds
    el.highlight("0000ff", { attr: 'color', duration: 2 });

    // common config options shown with default values
    el.highlight("ffff9c", {
        attr: "backgroundColor", //can be any valid CSS property (attribute) that supports a color value
        endColor: (current color) or "ffffff",
        easing: 'easeIn',
        duration: 1000
    });

### Parameters

- color : String

  (optional) The highlight color. Should be a 6 char hex color without the leading # (defaults to yellow: 'ffff9c')

- options : Object

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

### Returns

- Ext.core.Element

  The Element

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

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

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

### Parameters

- overFn : Function

  The function to call when the mouse enters the Element.

- outFn : Function

  The function to call when the mouse leaves the Element.

- scope : Object

  (optional) The scope (`this` reference) in which the functions are executed. Defaults to the Element's DOM element.

- options : Object

  (optional) Options for the listener. See the <tt>options</tt> parameter.

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
initDD( String group, Object config, Object overrides) : Ext.dd.DD

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

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

### Parameters

- group : String

  The group the DD object is member of

- config : Object

  The DD config object

- overrides : Object

  An object containing methods to override/implement on the DD object

### Returns

- Ext.dd.DD

  The DD object

Ext.core.Element
view source
initDDProxy( String group, Object config, Object overrides) : Ext.dd.DDProxy

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

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

### Parameters

- group : String

  The group the DDProxy object is member of

- config : Object

  The DDProxy config object

- overrides : Object

  An object containing methods to override/implement on the DDProxy object

### Returns

- Ext.dd.DDProxy

  The DDProxy object

Ext.core.Element
view source
initDDTarget( String group, Object config, Object overrides) : Ext.dd.DDTarget

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

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

### Parameters

- group : String

  The group the DDTarget object is member of

- config : Object

  The DDTarget config object

- overrides : Object

  An object containing methods to override/implement on the DDTarget object

### Returns

- Ext.dd.DDTarget

  The DDTarget object

Ext.core.Element
view source
insertAfter( Mixed el) : Ext.core.Element

Inserts this element after the passed element in the DOM

Inserts this element after the passed element in the DOM

### Parameters

- el : Mixed

  The element to insert after

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
insertBefore( Mixed el) : Ext.core.Element

Inserts this element before the passed element in the DOM

Inserts this element before the passed element in the DOM

### Parameters

- el : Mixed

  The element before which this element will be inserted

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
insertFirst( Mixed/Object el, Object returnDom) : Ext.core.Element

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

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

### Parameters

- el : Mixed/Object

  The id or element to insert or a DomHelper config to create and insert

- returnDom : Object

### Returns

- Ext.core.Element

  The new child

Ext.core.Element
view source
insertHtml( String where, String html, [Boolean returnEl]) : HTMLElement/Ext.core.Element

Inserts an html fragment into this element

Inserts an html fragment into this element

### Parameters

- where : String

  Where to insert the html in relation to this element - beforeBegin, afterBegin, beforeEnd, afterEnd.

- html : String

  The HTML fragment

- returnEl : Boolean

  (optional) True to return an Ext.core.Element (defaults to false)

### Returns

- HTMLElement/Ext.core.Element

  The inserted node (or nearest related if more than 1 inserted)

Ext.core.Element
view source
insertSibling( Mixed/Object/Array el, [String where], [Boolean returnDom]) : Ext.core.Element

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

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

### Parameters

- el : Mixed/Object/Array

  The id, element to insert or a DomHelper config to create and insert or an array of any of those.

- where : String

  (optional) 'before' or 'after' defaults to before

- returnDom : Boolean

  (optional) True to return the .;ll;l,raw DOM element instead of Ext.core.Element

### Returns

- Ext.core.Element

  The inserted Element. If an array is passed, the last inserted element is returned.

Ext.core.Element
view source
is( String selector) : Boolean

Returns true if this element matches the passed simple selector (e.g. div.some-class or span:first-child)

Returns true if this element matches the passed simple selector (e.g. div.some-class or span:first-child)

### Parameters

- selector : String

  The simple selector to test

### Returns

- Boolean

  True if this element matches the selector, else false

Ext.core.Element
view source
isBorderBox : Boolean

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

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

### Returns

- Boolean

Ext.core.Element
view source
isDisplayed : Boolean

Returns true if display is not "none"

Returns true if display is not "none"

### Returns

- Boolean

Ext.core.Element
view source
isMasked : Boolean

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

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

### Returns

- Boolean

Ext.core.Element
view source
isScrollable : Boolean

Returns true if this element is scrollable.

Returns true if this element is scrollable.

### Returns

- Boolean

Ext.core.Element
view source
isVisible : 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.

### Returns

- Boolean

  True if the element is currently visible, else false

Ext.core.Element
view source
last( [String selector], [Boolean returnDom]) : Ext.core.Element/HTMLElement

Gets the last child, skipping text nodes

Gets the last child, skipping text nodes

### Parameters

- selector : String

  (optional) Find the previous sibling that matches the passed simple selector

- returnDom : Boolean

  (optional) True to return a raw dom node instead of an Ext.core.Element

### Returns

- Ext.core.Element/HTMLElement

  The last child or null

Ext.core.Element
view source
load( Object options) : Ext.core.Element
Direct access to the Ext.ElementLoader Ext.ElementLoader.load method. The method takes the same object parameter as E...

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

### Parameters

- options : Object

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
mask( [String msg], [String msgCls]) : Element
Puts a mask over this element to disable user interaction. Requires core.css. This method can only be applied to elem...

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

### Parameters

- msg : String

  (optional) A message to display in the mask

- msgCls : String

  (optional) A css class to apply to the msg element

### Returns

- Element

  The mask element

Ext.core.Element
view source
monitorMouseLeave( Number delay, Function handler, Object scope) : Object
Monitors this Element for the mouse leaving. Calls the function after the specified delay only if the mouse was not m...

Monitors this Element for the mouse leaving. Calls the function after the specified delay only if the mouse was not moved back into the Element within the delay. If the mouse was moved back 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.

- handler : Function

  The function to call if the mouse remains outside of this Element for the specified time.

- scope : Object

  The scope (`this` reference) in which the handler function executes. Defaults to this Element.

### Returns

- Object

  The listeners object which was added to this element so that monitoring can be stopped. Example usage:`// Hide the menu if the mouse moves out for 250ms or more this.mouseLeaveMonitor = this.menuEl.monitorMouseLeave(250, this.hideMenu, this);`

  ... // Remove mouseleave monitor on menu destroy this.menuEl.un(this.mouseLeaveMonitor);

Ext.core.Element
view source
move( String direction, Number distance, [Boolean/Object animate]) : Ext.core.Element

Move this element relative to its current position.

Move this element relative to its current position.

### Parameters

- direction : String

  Possible values are: "l" (or "left"), "r" (or "right"), "t" (or "top", or "up"), "b" (or "bottom", or "down").

- distance : Number

  How far to move the element in pixels

- animate : Boolean/Object

  (optional) true for the default animation or a standard Element animation config object

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
moveTo( Number x, Number y, [Boolean/Object animate]) : Ext.core.Element
Sets the position of the element in page coordinates, regardless of how the element is positioned. The element must b...

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

### Parameters

- x : Number

  X value for new position (coordinates are page-based)

- y : Number

  Y value for new position (coordinates are page-based)

- animate : Boolean/Object

  (optional) True for the default animation, or a standard Element animation config object

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
next( [String selector], [Boolean returnDom]) : Ext.core.Element/HTMLElement

Gets the next sibling, skipping text nodes

Gets the next sibling, skipping text nodes

### Parameters

- selector : String

  (optional) Find the next sibling that matches the passed simple selector

- returnDom : Boolean

  (optional) True to return a raw dom node instead of an Ext.core.Element

### Returns

- Ext.core.Element/HTMLElement

  The next sibling or null

Ext.core.Element
view source
normalize( String prop) : String
Normalizes CSS property keys from dash delimited to camel case JavaScript Syntax. For example: border-width -> bor...

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

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

### Parameters

- prop : String

  The property to normalize

### Returns

- String

  The normalized string

Ext.core.Element
view source
on( String eventName, Function fn, [Object scope], [Object options]) : void

Appends an event handler (shorthand for addListener).

Appends an event handler (shorthand for addListener).

### Parameters

- eventName : String

  The name of event to handle.

- fn : Function

  The handler function the event invokes.

- scope : Object

  (optional) The scope (`this` reference) in which the handler function is executed.

- options : Object

  (optional) An object containing standard addListener options

### Returns

- void

Ext.core.Element
view source
parent( [String selector], [Boolean returnDom]) : Ext.core.Element/HTMLElement

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

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

### Parameters

- selector : String

  (optional) Find a parent node that matches the passed simple selector

- returnDom : Boolean

  (optional) True to return a raw dom node instead of an Ext.core.Element

### Returns

- Ext.core.Element/HTMLElement

  The parent node or null

Ext.core.Element
view source
parseBox( Number|String box) : Object
Parses a number or string representing margin sizes into an object. Supports CSS-style margin declarations (e.g. 10, ...

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

### Parameters

- box : Number|String

  The encoded margins

### Returns

- Object

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

Ext.core.Element
view source
parseStyles( String styles) : Object
Converts a CSS string into an object with a property for each style. The sample code below would return an object w...

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

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

    var css = 'background-color: red;color: blue; ';
    console.log(Ext.core.Element.parseStyles(css));

### Parameters

- styles : String

  A CSS string

### Returns

- Object

  styles

Ext.core.Element
view source
pause( Number seconds) : Ext.Element
@deprecated 4.0 Creates a pause before any subsequent queued effects begin. If there are no effects queued after the...

@deprecated 4.0 Creates a pause before any subsequent queued effects begin. If there are no effects queued after the pause it will have no effect. Usage:

    el.pause(1);

### Parameters

- seconds : Number

  The length of time to pause (in seconds)

### Returns

- Ext.Element

  The Element

Ext.core.Element
view source
position( [String pos], [Number zIndex], [Number x], [Number y]) : void
Initializes positioning on this element. If a desired position is not passed, it will make the the element positioned...

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

### Parameters

- pos : String

  (optional) Positioning to use "relative", "absolute" or "fixed"

- zIndex : Number

  (optional) The zIndex to apply

- x : Number

  (optional) Set the page X position

- y : Number

  (optional) Set the page Y position

### Returns

- void

Ext.core.Element
view source
prev( [String selector], [Boolean returnDom]) : Ext.core.Element/HTMLElement

Gets the previous sibling, skipping text nodes

Gets the previous sibling, skipping text nodes

### Parameters

- selector : String

  (optional) Find the previous sibling that matches the passed simple selector

- returnDom : Boolean

  (optional) True to return a raw dom node instead of an Ext.core.Element

### Returns

- Ext.core.Element/HTMLElement

  The previous sibling or null

Ext.core.Element
view source
puff( [Object options]) : Ext.core.Element
Fades the element out while slowly expanding it in all directions. When the effect is completed, the element will be...

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

    // default
    el.puff();

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

### Parameters

- options : Object

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

### Returns

- Ext.core.Element

  The Element

Ext.core.Element
view source
purgeAllListeners : Ext.core.Element

Recursively removes all previous added listeners from this element and its children

Recursively removes all previous added listeners from this element and its children

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
query( String selector) : Array

Selects child nodes based on the passed CSS selector (the selector should not contain an id).

Selects child nodes based on the passed CSS selector (the selector should not contain an id).

### Parameters

- selector : String

  The CSS selector

### Returns

- Array

  An array of the matched nodes

Ext.core.Element
view source
radioCls( String/Array className) : Ext.core.Element

Adds one or more CSS classes to this element and removes the same class(es) from all siblings.

Adds one or more CSS classes to this element and removes the same class(es) from all siblings.

### Parameters

- className : String/Array

  The CSS class to add, or an array of classes

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
relayEvent( String eventName, Object object) : void
Create an event handler on this element such that when the event fires and is handled by this element, it will be rel...

Create an event handler on this element such that when the event fires and is handled by this element, it 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

- object : Object

  Any object that extends Ext.util.Observable that will provide the context for firing the relayed event

### Returns

- void

Ext.core.Element
view source
remove : void

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

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

### Returns

- void

Ext.core.Element
view source
removeAllListeners : Ext.core.Element

Removes all previous added listeners from this element

Removes all previous added listeners from this element

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
removeAnchor : Ext.core.Element

Remove any anchor to this element. See anchorTo.

Remove any anchor to this element. See anchorTo.

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
removeCls( String/Array className) : Ext.core.Element

Removes one or more CSS classes from the element.

Removes one or more CSS classes from the element.

### Parameters

- className : String/Array

  The CSS classes to remove separated by space, or an array of classes

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
removeListener( String eventName, Function fn, Object scope) : Ext.core.Element
Removes an event handler from this element. The shorthand version un is equivalent. Note: if a scope was explicitly ...

Removes an event handler from this element. The shorthand version un is equivalent. Note: if a scope was explicitly specified when adding the listener, the same scope must be specified here. Example:

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

### Parameters

- eventName : String

  The name of the event from which to remove the handler.

- fn : Function

  The handler function to remove. This must be a reference to the function passed into the addListener call.

- scope : Object

  If a scope (`this` reference) was specified when the listener was added, then this must refer to the same object.

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
repaint : Ext.core.Element

Forces the browser to repaint this element

Forces the browser to repaint this element

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
replace( Mixed el) : Ext.core.Element

Replaces the passed element with this element

Replaces the passed element with this element

### Parameters

- el : Mixed

  The element to replace

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
replaceCls( String oldClassName, String newClassName) : Ext.core.Element

Replaces a CSS class on the element with another. If the old name does not exist, the new name will simply be added.

Replaces a CSS class on the element with another. If the old name does not exist, the new name will simply be added.

### Parameters

- oldClassName : String

  The CSS class to replace

- newClassName : String

  The replacement CSS class

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
replaceWith( Mixed/Object el) : Ext.core.Element

Replaces this element with the passed element

Replaces this element with the passed element

### Parameters

- el : Mixed/Object

  The new element or a DomHelper config of an element to create

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
scale( Number width, Number height, [Object options]) : Ext.Element
@deprecated 4.0 Animates the transition of an element's dimensions from a starting height/width to an ending height/w...

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

    // change height and width to 100x100 pixels
    el.scale(100, 100);

    // common config options shown with default values.  The height and width will default to
    // the element's existing values if passed as null.
    el.scale(
        [element's width],
        [element's height], {
            easing: 'easeOut',
            duration: .35
        }
    );

### Parameters

- width : Number

  The new width (pass undefined to keep the original width)

- height : Number

  The new height (pass undefined to keep the original height)

- options : Object

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

### Returns

- Ext.Element

  The Element

Ext.core.Element
view source
scroll( String direction, Number distance, [Boolean/Object animate]) : Boolean
Scrolls this element the specified direction. Does bounds checking to make sure the scroll is within this element's s...

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

### Parameters

- direction : String

  Possible values are: "l" (or "left"), "r" (or "right"), "t" (or "top", or "up"), "b" (or "bottom", or "down").

- distance : Number

  How far to scroll the element in pixels

- animate : Boolean/Object

  (optional) true for the default animation or a standard Element animation config object

### Returns

- Boolean

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

Ext.core.Element
view source
scrollIntoView( [Mixed container], [Boolean hscroll]) : Ext.core.Element

Scrolls this element into view within the passed container.

Scrolls this element into view within the passed container.

### Parameters

- container : Mixed

  (optional) The container element to scroll (defaults to document.body). Should be a string (id), dom node, or Ext.core.Element.

- hscroll : Boolean

  (optional) False to disable horizontal scroll (defaults to true)

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
scrollTo( String side, Number value, [Boolean/Object animate]) : Element
Scrolls this element the specified scroll point. It does NOT do bounds checking so if you scroll to a weird value it ...

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

### Parameters

- side : String

  Either "left" for scrollLeft values or "top" for scrollTop values.

- value : Number

  The new scroll value

- animate : Boolean/Object

  (optional) true for the default animation or a standard Element animation config object

### Returns

- Element

  this

Ext.core.Element
view source
select( String selector) : CompositeElement/CompositeElement
Creates a Ext.CompositeElement for child nodes based on the passed CSS selector (the selector should not contain an i...

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

### Parameters

- selector : String

  The CSS selector

### Returns

- CompositeElement/CompositeElement

  The composite element

Ext.core.Element
view source
serializeForm( Object form) : String

Serializes a DOM form into a url encoded string

Serializes a DOM form into a url encoded string

### Parameters

- form : Object

  The form

### Returns

- String

  The url encoded form

Ext.core.Element
view source
set( Object o, [Boolean useSet]) : Ext.core.Element

Sets the passed attributes as attributes of this element (a style attribute can be a string, object or function)

Sets the passed attributes as attributes of this element (a style attribute can be a string, object or function)

### Parameters

- o : Object

  The object with the attributes

- useSet : Boolean

  (optional) false to override the default setAttribute to use expandos.

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
setBottom( String bottom) : Ext.core.Element

Sets the element's CSS bottom style.

Sets the element's CSS bottom style.

### Parameters

- bottom : String

  The bottom CSS property value

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
setBounds( Number x, Number y, Mixed width, Mixed height, [Boolean/Object animate]) : Ext.core.Element
Sets the element's position and size in one shot. If animation is true then width, height, x and y will be animated c...

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

### Parameters

- x : Number

  X value for new position (coordinates are page-based)

- y : Number

  Y value for new position (coordinates are page-based)

- width : Mixed

  The new width. This may be one of:

  - A Number specifying the new width in this Element's defaultUnits (by default, pixels)
  - A String used to set the CSS width style. Animation may not be used.
- height : Mixed

  The new height. This may be one of:

  - A Number specifying the new height in this Element's defaultUnits (by default, pixels)
  - A String used to set the CSS height style. Animation may not be used.
- animate : Boolean/Object

  (optional) true for the default animation or a standard Element animation config object

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
setBox( Object box, [Boolean adjust], [Boolean/Object animate]) : Ext.core.Element
Sets the element's box. Use getBox() on another element to get a box obj. If animate is true then width, height, x an...

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

### Parameters

- box : Object

  The box to fill {x, y, width, height}

- adjust : Boolean

  (optional) Whether to adjust for box-model issues automatically

- animate : Boolean/Object

  (optional) true for the default animation or a standard Element animation config object

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
setDisplayed( Mixed value) : Ext.core.Element

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

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

### Parameters

- value : Mixed

  Boolean value to display the element using its default display, or a string to set the display directly.

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
setHeight( Mixed height, [Boolean/Object animate]) : Ext.core.Element
Set the height of this Element. // change the height to 200px and animate with default configuration Ext.fly('elemen...

Set the height of this Element.

    // change the height to 200px and animate with default configuration
    Ext.fly('elementId').setHeight(200, true);

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

### Parameters

- height : Mixed

  The new height. This may be one of:

  - A Number specifying the new height in this Element's defaultUnits (by default, pixels.)
  - A String used to set the CSS height style. Animation may not be used.
- animate : Boolean/Object

  (optional) true for the default animation or a standard Element animation config object

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
setLeft( String left) : Ext.core.Element

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

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

### Parameters

- left : String

  The left CSS property value

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
setLeftTop( String left, String top) : Ext.core.Element

Quick set left and top adding default units

Quick set left and top adding default units

### Parameters

- left : String

  The left CSS property value

- top : String

  The top CSS property value

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
setLocation( Number x, Number y, [Boolean/Object animate]) : Ext.core.Element
Sets the position of the element in page coordinates, regardless of how the element is positioned. The element must b...

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

### Parameters

- x : Number

  X value for new position (coordinates are page-based)

- y : Number

  Y value for new position (coordinates are page-based)

- animate : Boolean/Object

  (optional) True for the default animation, or a standard Element animation config object

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
setOpacity( Float opacity, [Boolean/Object animate]) : Ext.core.Element

Set the opacity of the element

Set the opacity of the element

### Parameters

- opacity : Float

  The new opacity. 0 = transparent, .5 = 50% visibile, 1 = fully visible, etc

- animate : Boolean/Object

  (optional) a standard Element animation config object or `true` for the default animation (`{duration: .35, easing: 'easeIn'}`)

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
setPositioning( Object posCfg) : Ext.core.Element

Set positioning with an object returned by getPositioning().

Set positioning with an object returned by getPositioning().

### Parameters

- posCfg : Object

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
setRegion( Ext.util.Region region, [Boolean/Object animate]) : Ext.core.Element
Sets the element's position and size the specified region. If animation is true then width, height, x and y will be a...

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

### Parameters

- region : Ext.util.Region

  The region to fill

- animate : Boolean/Object

  (optional) true for the default animation or a standard Element animation config object

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
setRight( String right) : Ext.core.Element

Sets the element's CSS right style.

Sets the element's CSS right style.

### Parameters

- right : String

  The right CSS property value

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
setSize( Mixed width, Mixed height, [Boolean/Object animate]) : Ext.core.Element

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

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

### Parameters

- width : Mixed

  The new width. This may be one of:

  - A Number specifying the new width in this Element's defaultUnits (by default, pixels).
  - A String used to set the CSS width style. Animation may not be used.
  - A size object in the format `{width: widthValue, height: heightValue}`.
- height : Mixed

  The new height. This may be one of:

  - A Number specifying the new height in this Element's defaultUnits (by default, pixels).
  - A String used to set the CSS height style. Animation may not be used.
- animate : Boolean/Object

  (optional) true for the default animation or a standard Element animation config object

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
setStyle( String/Object property, [String value]) : Ext.core.Element

Wrapper for setting style properties, also takes single object parameter of multiple styles.

Wrapper for setting style properties, also takes single object parameter of multiple styles.

### Parameters

- property : String/Object

  The style property to be set, or an object of multiple styles.

- value : String

  (optional) The value to apply to the given property, or null if an object was passed.

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
setTop( String top) : Ext.core.Element

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

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

### Parameters

- top : String

  The top CSS property value

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
setVisibilityMode( Number visMode) : Ext.core.Element
Sets the element's visibility mode. When setVisible() is called it will use this to determine whether to set the visi...

Sets the element's visibility mode. When setVisible() is called it will use this to determine whether to set the visibility or the display property.

### Parameters

- visMode : Number

  Ext.core.Element.VISIBILITY or Ext.core.Element.DISPLAY

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
setVisible( Boolean visible, [Boolean/Object animate]) : Ext.core.Element
Sets the visibility of the element (see details). If the visibilityMode is set to Element.DISPLAY, it will use the di...

Sets the visibility of the element (see details). If the visibilityMode is set to Element.DISPLAY, it will use the display property to hide the element, otherwise it uses visibility. The default is to hide and show using the visibility property.

### Parameters

- visible : Boolean

  Whether the element is visible

- animate : Boolean/Object

  (optional) True for the default animation, or a standard Element animation config object

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
setWidth( Mixed width, [Boolean/Object animate]) : Ext.core.Element

Set the width of this Element.

Set the width of this Element.

### Parameters

- width : Mixed

  The new width. This may be one of:

  - A Number specifying the new width in this Element's defaultUnits (by default, pixels).
  - A String used to set the CSS width style. Animation may not be used.
- animate : Boolean/Object

  (optional) true for the default animation or a standard Element animation config object

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
setX( Number The, [Boolean/Object animate]) : Ext.core.Element
Sets the X position of the element based on page coordinates. Element must be part of the DOM tree to have page coor...

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

### Parameters

- The : Number

  X position of the element

- animate : Boolean/Object

  (optional) True for the default animation, or a standard Element animation config object

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
setXY( Array pos, [Boolean/Object animate]) : Ext.core.Element
Sets the position of the element in page coordinates, regardless of how the element is positioned. The element must b...

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

### Parameters

- pos : Array

  Contains X & Y [x, y] values for new position (coordinates are page-based)

- animate : Boolean/Object

  (optional) True for the default animation, or a standard Element animation config object

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
setY( Number The, [Boolean/Object animate]) : Ext.core.Element
Sets the Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coor...

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

### Parameters

- The : Number

  Y position of the element

- animate : Boolean/Object

  (optional) True for the default animation, or a standard Element animation config object

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
shift( Object options) : Ext.Element
@deprecated 4.0 Animates the transition of any combination of an element's dimensions, xy position and/or opacity. An...

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

    // slide the element horizontally to x position 200 while changing the height and opacity
    el.shift({ x: 200, height: 50, opacity: .8 });

    // common config options shown with default values.
    el.shift({
        width: [element's width],
        height: [element's height],
        x: [element's x position],
        y: [element's y position],
        opacity: [element's opacity],
        easing: 'easeOut',
        duration: .35
    });

### Parameters

- options : Object

  Object literal with any of the Fx config options

### Returns

- Ext.Element

  The Element

Ext.core.Element
view source
show( [Boolean/Object animate]) : Ext.core.Element

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

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

### Parameters

- animate : Boolean/Object

  (optional) true for the default animation or a standard Element animation config object

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
slideIn( [String anchor], [Object options], Object slideOut) : Ext.core.Element
Slides the element into view. An anchor point can be optionally passed to set the point of origin for the slide effe...

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

    // default: slide the element in from the top
    el.slideIn();

    // custom: slide the element in from the right with a 2-second duration
    el.slideIn('r', { duration: 2 });

    // common config options shown with default values
    el.slideIn('t', {
        easing: 'easeOut',
        duration: 500
    });

### Parameters

- anchor : String

  (optional) One of the valid Fx anchor positions (defaults to top: 't')

- options : Object

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

- slideOut : Object

### Returns

- Ext.core.Element

  The Element

Ext.core.Element
view source
slideOut( [String anchor], [Object options]) : Ext.core.Element
Slides the element out of view. An anchor point can be optionally passed to set the end point for the slide effect. ...

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

    // default: slide the element out to the top
    el.slideOut();

    // custom: slide the element out to the right with a 2-second duration
    el.slideOut('r', { duration: 2 });

    // common config options shown with default values
    el.slideOut('t', {
        easing: 'easeOut',
        duration: 500,
        remove: false,
        useDisplay: false
    });

### Parameters

- anchor : String

  (optional) One of the valid Fx anchor positions (defaults to top: 't')

- options : Object

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

### Returns

- Ext.core.Element

  The Element

Ext.core.Element
view source
swallowEvent( String/Array eventName, [Boolean preventDefault]) : Ext.core.Element

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

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

### Parameters

- eventName : String/Array

  an event / array of events to stop from bubbling

- preventDefault : Boolean

  (optional) true to prevent the default action too

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
switchOff( [Object options]) : Ext.core.Element
Blinks the element as if it was clicked and then collapses on its center (similar to switching off a television). Whe...

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

    // default
    el.switchOff();

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

### Parameters

- options : Object

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

### Returns

- Ext.core.Element

  The Element

Ext.core.Element
view source
toggle( [Boolean/Object animate]) : Ext.core.Element

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

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

### Parameters

- animate : Boolean/Object

  (optional) True for the default animation, or a standard Element animation config object

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
translatePoints( Number/Array x, [Number y]) : Object

Translates the passed page coordinates into left/top css values for this element

Translates the passed page coordinates into left/top css values for this element

### Parameters

- x : Number/Array

  The page x or an array containing [x, y]

- y : Number

  (optional) The page y, required if x is not an array

### Returns

- Object

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

Ext.core.Element
view source
un( String eventName, Function fn, Object scope) : Ext.core.Element

Removes an event handler from this element (see removeListener for additional notes).

Removes an event handler from this element (see removeListener for additional notes).

### Parameters

- eventName : String

  The name of the event from which to remove the handler.

- fn : Function

  The handler function to remove. This must be a reference to the function passed into the addListener call.

- scope : Object

  If a scope (`this` reference) was specified when the listener was added, then this must refer to the same object.

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
unclip : Ext.core.Element

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

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

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
unitizeBox( Number|String box, String units) : String
Parses a number or string representing margin sizes into an object. Supports CSS-style margin declarations (e.g. 10, ...

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

### Parameters

- box : Number|String

  The encoded margins

- units : String

  The type of units to add

### Returns

- String

  An string with unitized (px if units is not specified) metrics for top, right, bottom and left

Ext.core.Element
view source
unmask : void

Removes a previously applied mask.

Removes a previously applied mask.

### Returns

- void

Ext.core.Element
view source
unselectable : Ext.core.Element

Disables text selection for this element (normalized across browsers)

Disables text selection for this element (normalized across browsers)

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
up( String selector, [Number/Mixed maxDepth]) : Ext.core.Element
Walks up the dom looking for a parent node that matches the passed simple selector (e.g. div.some-class or span:first...

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

### Parameters

- selector : String

  The simple selector to test

- maxDepth : Number/Mixed

  (optional) The max depth to

              search as a number or element (defaults to 10 || document.body)

### Returns

- Ext.core.Element

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

Ext.core.Element
view source
update( String html) : Ext.core.Element

Update the innerHTML of this element

Update the innerHTML of this element

### Parameters

- html : String

  The new HTML

### Returns

- Ext.core.Element

  this

Ext.core.Element
view source
wrap( [Object config], [Boolean returnDom]) : HTMLElement/Element

Creates and wraps this element with another element

Creates and wraps this element with another element

### Parameters

- config : Object

  (optional) DomHelper element config object for the wrapper element or null for an empty div

- returnDom : Boolean

  (optional) True to return the raw DOM element instead of Ext.core.Element

### Returns

- HTMLElement/Element

  The newly created wrapper element

Defined By

### Events

Ext.core.Element
view source
DOMActivate( Ext.EventObject e, HtmlElement t, Object o)

Where supported. Fires when an element is activated, for instance, through a mouse click or a keypress.

Where supported. Fires when an element is activated, for instance, through a mouse click or a keypress.

### Parameters

- e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

- t : HtmlElement

  The target of the event.

- o : Object

  The options configuration passed to the addListener call.

Ext.core.Element
view source
DOMAttrModified( Ext.EventObject e, HtmlElement t, Object o)

Where supported. Fires when an attribute has been modified.

Where supported. Fires when an attribute has been modified.

### Parameters

- e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

- t : HtmlElement

  The target of the event.

- o : Object

  The options configuration passed to the addListener call.

Ext.core.Element
view source
DOMCharacterDataModified( Ext.EventObject e, HtmlElement t, Object o)

Where supported. Fires when the character data has been modified.

Where supported. Fires when the character data has been modified.

### Parameters

- e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

- t : HtmlElement

  The target of the event.

- o : Object

  The options configuration passed to the addListener call.

Ext.core.Element
view source
DOMFocusIn( Ext.EventObject e, HtmlElement t, Object o)

Where supported. Similar to HTML focus event, but can be applied to any focusable element.

Where supported. Similar to HTML focus event, but can be applied to any focusable element.

### Parameters

- e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

- t : HtmlElement

  The target of the event.

- o : Object

  The options configuration passed to the addListener call.

Ext.core.Element
view source
DOMFocusOut( Ext.EventObject e, HtmlElement t, Object o)

Where supported. Similar to HTML blur event, but can be applied to any focusable element.

Where supported. Similar to HTML blur event, but can be applied to any focusable element.

### Parameters

- e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

- t : HtmlElement

  The target of the event.

- o : Object

  The options configuration passed to the addListener call.

Ext.core.Element
view source
DOMNodeInserted( Ext.EventObject e, HtmlElement t, Object o)

Where supported. Fires when a node has been added as a child of another node.

Where supported. Fires when a node has been added as a child of another node.

### Parameters

- e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

- t : HtmlElement

  The target of the event.

- o : Object

  The options configuration passed to the addListener call.

Ext.core.Element
view source
DOMNodeInsertedIntoDocument( Ext.EventObject e, HtmlElement t, Object o)

Where supported. Fires when a node is being inserted into a document.

Where supported. Fires when a node is being inserted into a document.

### Parameters

- e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

- t : HtmlElement

  The target of the event.

- o : Object

  The options configuration passed to the addListener call.

Ext.core.Element
view source
DOMNodeRemoved( Ext.EventObject e, HtmlElement t, Object o)

Where supported. Fires when a descendant node of the element is removed.

Where supported. Fires when a descendant node of the element is removed.

### Parameters

- e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

- t : HtmlElement

  The target of the event.

- o : Object

  The options configuration passed to the addListener call.

Ext.core.Element
view source
DOMNodeRemovedFromDocument( Ext.EventObject e, HtmlElement t, Object o)

Where supported. Fires when a node is being removed from a document.

Where supported. Fires when a node is being removed from a document.

### Parameters

- e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

- t : HtmlElement

  The target of the event.

- o : Object

  The options configuration passed to the addListener call.

Ext.core.Element
view source
DOMSubtreeModified( Ext.EventObject e, HtmlElement t, Object o)

Where supported. Fires when the subtree is modified.

Where supported. Fires when the subtree is modified.

### Parameters

- e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

- t : HtmlElement

  The target of the event.

- o : Object

  The options configuration passed to the addListener call.

Ext.core.Element
view source
abort( Ext.EventObject e, HtmlElement t, Object o)

Fires when an object/image is stopped from loading before completely loaded.

Fires when an object/image is stopped from loading before completely loaded.

### Parameters

- e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

- t : HtmlElement

  The target of the event.

- o : Object

  The options configuration passed to the addListener call.

Ext.core.Element
view source
blur( Ext.EventObject e, HtmlElement t, Object o)

Fires when an element loses focus either via the pointing device or by tabbing navigation.

Fires when an element loses focus either via the pointing device or by tabbing navigation.

### Parameters

- e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

- t : HtmlElement

  The target of the event.

- o : Object

  The options configuration passed to the addListener call.

Ext.core.Element
view source
change( Ext.EventObject e, HtmlElement t, Object o)

Fires when a control loses the input focus and its value has been modified since gaining focus.

Fires when a control loses the input focus and its value has been modified since gaining focus.

### Parameters

- e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

- t : HtmlElement

  The target of the event.

- o : Object

  The options configuration passed to the addListener call.

Ext.core.Element
view source
click( Ext.EventObject e, HtmlElement t, Object o)

Fires when a mouse click is detected within the element.

Fires when a mouse click is detected within the element.

### Parameters

- e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

- t : HtmlElement

  The target of the event.

- o : Object

  The options configuration passed to the addListener call.

Ext.core.Element
view source
contextmenu( Ext.EventObject e, HtmlElement t, Object o)

Fires when a right click is detected within the element.

Fires when a right click is detected within the element.

### Parameters

- e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

- t : HtmlElement

  The target of the event.

- o : Object

  The options configuration passed to the addListener call.

Ext.core.Element
view source
dblclick( Ext.EventObject e, HtmlElement t, Object o)

Fires when a mouse double click is detected within the element.

Fires when a mouse double click is detected within the element.

### Parameters

- e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

- t : HtmlElement

  The target of the event.

- o : Object

  The options configuration passed to the addListener call.

Ext.core.Element
view source
error( Ext.EventObject e, HtmlElement t, Object o)

Fires when an object/image/frame cannot be loaded properly.

Fires when an object/image/frame cannot be loaded properly.

### Parameters

- e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

- t : HtmlElement

  The target of the event.

- o : Object

  The options configuration passed to the addListener call.

Ext.core.Element
view source
focus( Ext.EventObject e, HtmlElement t, Object o)

Fires when an element receives focus either via the pointing device or by tab navigation.

Fires when an element receives focus either via the pointing device or by tab navigation.

### Parameters

- e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

- t : HtmlElement

  The target of the event.

- o : Object

  The options configuration passed to the addListener call.

Ext.core.Element
view source
keydown( Ext.EventObject e, HtmlElement t, Object o)

Fires when a keydown is detected within the element.

Fires when a keydown is detected within the element.

### Parameters

- e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

- t : HtmlElement

  The target of the event.

- o : Object

  The options configuration passed to the addListener call.

Ext.core.Element
view source
keypress( Ext.EventObject e, HtmlElement t, Object o)

Fires when a keypress is detected within the element.

Fires when a keypress is detected within the element.

### Parameters

- e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

- t : HtmlElement

  The target of the event.

- o : Object

  The options configuration passed to the addListener call.

Ext.core.Element
view source
keyup( Ext.EventObject e, HtmlElement t, Object o)

Fires when a keyup is detected within the element.

Fires when a keyup is detected within the element.

### Parameters

- e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

- t : HtmlElement

  The target of the event.

- o : Object

  The options configuration passed to the addListener call.

Ext.core.Element
view source
load( Ext.EventObject e, HtmlElement t, Object o)
Fires when the user agent finishes loading all content within the element. Only supported by window, frames, objects ...

Fires when the user agent finishes loading all content within the element. Only supported by window, frames, objects and images.

### Parameters

- e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

- t : HtmlElement

  The target of the event.

- o : Object

  The options configuration passed to the addListener call.

Ext.core.Element
view source
mousedown( Ext.EventObject e, HtmlElement t, Object o)

Fires when a mousedown is detected within the element.

Fires when a mousedown is detected within the element.

### Parameters

- e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

- t : HtmlElement

  The target of the event.

- o : Object

  The options configuration passed to the addListener call.

Ext.core.Element
view source
mouseenter( Ext.EventObject e, HtmlElement t, Object o)

Fires when the mouse enters the element.

Fires when the mouse enters the element.

### Parameters

- e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

- t : HtmlElement

  The target of the event.

- o : Object

  The options configuration passed to the addListener call.

Ext.core.Element
view source
mouseleave( Ext.EventObject e, HtmlElement t, Object o)

Fires when the mouse leaves the element.

Fires when the mouse leaves the element.

### Parameters

- e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

- t : HtmlElement

  The target of the event.

- o : Object

  The options configuration passed to the addListener call.

Ext.core.Element
view source
mousemove( Ext.EventObject e, HtmlElement t, Object o)

Fires when a mousemove is detected with the element.

Fires when a mousemove is detected with the element.

### Parameters

- e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

- t : HtmlElement

  The target of the event.

- o : Object

  The options configuration passed to the addListener call.

Ext.core.Element
view source
mouseout( Ext.EventObject e, HtmlElement t, Object o)

Fires when a mouseout is detected with the element.

Fires when a mouseout is detected with the element.

### Parameters

- e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

- t : HtmlElement

  The target of the event.

- o : Object

  The options configuration passed to the addListener call.

Ext.core.Element
view source
mouseover( Ext.EventObject e, HtmlElement t, Object o)

Fires when a mouseover is detected within the element.

Fires when a mouseover is detected within the element.

### Parameters

- e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

- t : HtmlElement

  The target of the event.

- o : Object

  The options configuration passed to the addListener call.

Ext.core.Element
view source
mouseup( Ext.EventObject e, HtmlElement t, Object o)

Fires when a mouseup is detected within the element.

Fires when a mouseup is detected within the element.

### Parameters

- e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

- t : HtmlElement

  The target of the event.

- o : Object

  The options configuration passed to the addListener call.

Ext.core.Element
view source
reset( Ext.EventObject e, HtmlElement t, Object o)

Fires when a form is reset.

Fires when a form is reset.

### Parameters

- e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

- t : HtmlElement

  The target of the event.

- o : Object

  The options configuration passed to the addListener call.

Ext.core.Element
view source
resize( Ext.EventObject e, HtmlElement t, Object o)

Fires when a document view is resized.

Fires when a document view is resized.

### Parameters

- e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

- t : HtmlElement

  The target of the event.

- o : Object

  The options configuration passed to the addListener call.

Ext.core.Element
view source
scroll( Ext.EventObject e, HtmlElement t, Object o)

Fires when a document view is scrolled.

Fires when a document view is scrolled.

### Parameters

- e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

- t : HtmlElement

  The target of the event.

- o : Object

  The options configuration passed to the addListener call.

Ext.core.Element
view source
select( Ext.EventObject e, HtmlElement t, Object o)

Fires when a user selects some text in a text field, including input and textarea.

Fires when a user selects some text in a text field, including input and textarea.

### Parameters

- e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

- t : HtmlElement

  The target of the event.

- o : Object

  The options configuration passed to the addListener call.

Ext.core.Element
view source
submit( Ext.EventObject e, HtmlElement t, Object o)

Fires when a form is submitted.

Fires when a form is submitted.

### Parameters

- e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

- t : HtmlElement

  The target of the event.

- o : Object

  The options configuration passed to the addListener call.

Ext.core.Element
view source
unload( Ext.EventObject e, HtmlElement t, Object o)
Fires when the user agent removes all content from a window or frame. For elements, it fires when the target element ...

Fires when the user agent removes all content from a window or frame. For elements, it fires when the target element or any of its content has been removed.

### Parameters

- e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

- t : HtmlElement

  The target of the event.

- o : Object

  The options configuration passed to the addListener call.