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

Defaults to: true

Available since: 1.1.0

The element's default display mode.

Defined in override Ext.dom.Element_fx.

Defaults to: ""

Available since: 1.1.0

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)

Defined in override Ext.dom.Element_style.

Available since: 4.0.0

Parameters

• className : String

  The class to add

• testFn : Function (optional)

  A test function to execute before adding the class. The passed parameter will be the Element instance. If this functions returns false, the class will not be added.

• scope : Object (optional)

  The scope to execute the testFn in.

Returns

• Ext.dom.Element

  this

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

Defined in override Ext.dom.Element_style.

Available since: 4.0.0

Parameters

• className : String

  The class to add

• testFn : Function (optional)

  A test function to execute before adding the class. The passed parameter will be the Element instance. If this functions returns false, the class will not be added.

• scope : Object (optional)

  The scope to execute the testFn in.

Returns

• Ext.dom.Element

  this

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

Defined in override Ext.dom.Element_style.

Available since: 4.0.0

Parameters

• className : String

  The class to add

• testFn : Function (optional)

  A test function to execute before adding the class. The passed parameter will be the Element instance. If this functions returns false, the class will not be added.

• scope : Object (optional)

  The scope to execute the testFn in.

Returns

• Ext.dom.Element

  this

Convenience method for constructing a KeyMap

Available since: 1.1.0

Parameters

• key : String/Number/Number[]/Object

  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/Array
  • shift : Boolean
  • ctrl : Boolean
  • alt : Boolean
• 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

Creates a KeyMap for this element

Available since: 1.1.0

Parameters

• config : Object

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

Returns

• Ext.util.KeyMap

  The KeyMap created

Shorthand for on.

Appends an event handler to this element.

Available since: 1.1.0

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 call that setup the listener.

• 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.dom.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

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

  this

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

Defined in override Ext.dom.Element_style.

Available since: 4.0.0

Parameters

• dimension : Object

Returns

• Number

  0 or 1

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]);

Defined in override Ext.dom.Element_alignment.

Available since: 1.1.0

Parameters

• element : String/HTMLElement/Ext.Element

  The element to align to.

• position : String (optional)

  The position to align to

  Defaults to: "tl-bl?"

• offsets : Number[] (optional)

  Offset the positioning by [x, y]

• animate : Boolean/Object (optional)

  true for the default animation or a standard Element animation config object

Returns

• Ext.Element

  this

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

Defined in override Ext.dom.Element_alignment.

Available since: 1.1.0

Parameters

• element : String/HTMLElement/Ext.Element

  The element to align to.

• position : String

  The position to align to.

• offsets : Number[] (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 (optional)

  The function to call after the animation finishes

Returns

• Ext.Element

  this

• process the passed fx configuration.

Defined in override Ext.dom.Element_anim.

Available since: 4.1.2

Parameters

• config : Object

Performs custom animation on this Element.

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

• x - The page X position in pixels.

• y - The page Y position in pixels

• left - The element's CSS left value. Units must be supplied.

• top - The element's CSS top value. Units must be supplied.

• width - The element's CSS width value. Units must be supplied.

• height - The element's CSS height value. Units must be supplied.

• scrollLeft - The element's scrollLeft value.

• scrollTop - The element's scrollTop value.

• opacity - The element's opacity value. This must be a value between 0 and 1.

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

Defined in override Ext.dom.Element_anim.

Available since: 1.1.0

Parameters

• config : Object

  Configuration for Ext.fx.Anim. Note that the to config is required.

Returns

• Ext.dom.Element

  this

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

Available since: 1.1.0

Returns

• Ext.dom.Element

  this

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.dom.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");

Defined in override Ext.dom.Element_style.

Available since: 1.1.0

Parameters

• class : String (optional)

  A base CSS class to apply to the containing wrapper element. 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.

  Defaults to: 'x-box'

Returns

• Ext.dom.Element

  The outermost wrapping element of the created box structure.

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

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

var restoreScroll = myPanel.el.cacheScrollValues();
myOtherContainer.add(myPanel);
restoreScroll();

Available since: 4.1.0

Returns

• Function

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

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

Defined in override Ext.dom.Element_alignment.

Available since: 1.1.0

Parameters

• centerIn : String/HTMLElement/Ext.Element (optional)

  The element in which to center the element.

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

Available since: 1.1.0

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.

  Defaults to: false

Alias for removeAllListeners.

Removes all previous added listeners from this element

Available since: 4.0.0

Returns

• Ext.dom.Element

  this

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

Defined in override Ext.dom.Element_style.

Available since: 1.1.0

Returns

• Ext.dom.Element

  this

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

Defined in override Ext.dom.Element_position.

Available since: 1.1.0

Parameters

• value : String (optional)

  The value to use for the left, right, top, bottom. You could use 'auto'.

  Defaults to: ''

Returns

• Ext.dom.AbstractElement

  this

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

Defined in override Ext.dom.Element_style.

Available since: 1.1.0

Returns

• Ext.dom.Element

  this

Creates a proxy element of this element

Available since: 1.1.0

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

  The new proxy element

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

Available since: 1.1.0

Returns

• Ext.dom.Element

  The new shim element

Convenience method for setVisibilityMode(Element.DISPLAY)

Available since: 1.1.0

Parameters

• display : String (optional)

  What to set display to when visible

Returns

• Ext.dom.Element

  this

Fade an element in (from transparent to opaque). The ending opacity can be specified using the opacity 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({ opacity: .75, duration: 2000});

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

Defined in override Ext.dom.Element_anim.

Available since: 4.0.0

Parameters

• options : Object (optional)

  Object literal with any of the Fx config options

Returns

• Ext.Element

  The Element

Fade an element out (from opaque to transparent). The ending opacity can be specified using the opacity 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({ opacity: .25, duration: 2000});

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

Defined in override Ext.dom.Element_anim.

Available since: 4.0.0

Parameters

• options : Object (optional)

  Object literal with any of the Fx config options

Returns

• Ext.Element

  The Element

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

Available since: 1.1.0

Parameters

• defer : Number (optional)

  Milliseconds to defer the focus

Returns

• Ext.dom.Element

  this

Alias for isFocusable.

Checks whether this element can be focused.

Available since: 4.0.7

Parameters

• asFocusEl : Object

Returns

• Boolean

  True if the element is focusable

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: 3000 });

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

Defined in override Ext.dom.Element_anim.

Available since: 4.0.0

Parameters

• color : String (optional)

  The hex color value for the border.

  Defaults to: '#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.dom.Element

  The Element

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

Defined in override Ext.dom.Element_alignment.

Available since: 1.1.0

Parameters

• element : String/HTMLElement/Ext.Element

  The element to align to.

• position : String (optional)

  The position to align to (defaults to )

  Defaults to: "tl-bl?"

• offsets : Number[] (optional)

  Offset the positioning by [x, y]

Returns

• Number[]

  [x, y]

Overrides: Ext.dom.AbstractElement.getAlignToXY

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

Defined in override Ext.dom.Element_alignment.

Available since: 1.1.0

Parameters

• anchor : String (optional)

  The specified anchor position. See alignTo for details on supported anchor positions.

  Defaults to: 'c'

• 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

• Number[]

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

Overrides: Ext.dom.AbstractElement.getAnchorXY

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

Available since: 1.1.0

Parameters

• namespace : String

  The namespace in which to look for the attribute

• name : String

  The attribute name

Returns

• String

  The attribute value

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

Defined in override Ext.dom.Element_alignment.

Available since: 1.1.0

Returns

• Number[]

  The x, y values [x, y]

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.

Defined in override Ext.dom.Element_style.

Available since: 1.1.0

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

Defined in override Ext.dom.Element_style.

Available since: 1.1.0

Returns

• Number

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.

Defined in override Ext.dom.Element_style.

Available since: 1.1.0

Returns

• Number

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.

Defined in override Ext.dom.Element_alignment.

Available since: 4.0.0

Parameters

• constrainTo : Ext.Element/Ext.util.Region

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

• proposedPosition : Number[]

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

Returns

• Number[]/Boolean

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

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

Defined in override Ext.dom.Element_style.

Available since: 1.1.0

Parameters

• sides : String

Returns

• Number

Gets this element's ElementLoader

Available since: 4.0.0

Returns

• Ext.ElementLoader

  The loader

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

Defined in override Ext.dom.Element_position.

Available since: 4.1.1

Returns

• Number

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

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

Defined in override Ext.dom.Element_position.

Available since: 4.1.1

Returns

• Number

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

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.

Defined in override Ext.dom.Element_position.

Available since: 2.3.0

Parameters

• element : String/HTMLElement/Ext.Element

  The element to get the offsets from.

Returns

• Number[]

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

Overrides: Ext.dom.AbstractElement.getOffsetsTo

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

Defined in override Ext.dom.Element_position.

Available since: 1.1.0

Returns

• Object

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

Defined in override Ext.dom.Element_position.

Available since: 1.1.0

Returns

• Ext.util.Region

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

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

Available since: 4.0.6

Returns

• HTMLElement

  The parent element

Returns the current scroll position of the element.

Defined in override Ext.dom.Element_scroll.

Available since: 1.1.0

Returns

• Object

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

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.

Defined in override Ext.dom.Element_style.

Available since: 3.4.0

Returns

• Object

  Object describing width and height.

  • width : Number
  • height : Number

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

Available since: 2.3.0

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.

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

Defined in override Ext.dom.Element_position.

Available since: 4.0.0

Returns

• Ext.util.Region

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

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

Defined in override Ext.dom.Element_position.

Available since: 1.1.0

Returns

• Number[]

  The XY position of the element

Overrides: Ext.dom.AbstractElement.getXY

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: 2000 });

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

Defined in override Ext.dom.Element_anim.

Available since: 4.0.0

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

  The Element

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

Defined in override Ext.dom.Element_fx.

Available since: 3.4.0

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

Defined in override Ext.dom.Element_fx.

Available since: 1.1.0

Parameters

• animate : Boolean/Object (optional)

  true for the default animation or a standard Element animation config object

Returns

• Ext.dom.Element

  this

Overrides: Ext.dom.AbstractElement.hide

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: 2000 });

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

Defined in override Ext.dom.Element_anim.

Available since: 4.0.0

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

  The Element

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

Available since: 2.3.0

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 options parameter.

Returns

• Ext.dom.Element

  this

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

Defined in override Ext.dom.Element_dd.

Available since: 1.1.0

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

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

Defined in override Ext.dom.Element_dd.

Available since: 1.1.0

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

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

Defined in override Ext.dom.Element_dd.

Available since: 1.1.0

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

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

Available since: 1.1.0

Returns

• Boolean

Returns true if display is not "none"

Available since: 1.1.0

Returns

• Boolean

Checks whether this element can be focused.

Available since: Ext JS 4.1.3

Parameters

• asFocusEl : Object

Returns

• Boolean

  True if the element is focusable

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

Available since: 1.1.0

Returns

• Boolean

Returns true if this element is scrollable.

Defined in override Ext.dom.Element_scroll.

Available since: 1.1.0

Returns

• Boolean

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

Available since: 1.1.0

Parameters

• deep : Boolean (optional)

  True to walk the dom and see if parent elements are hidden. If false, the function only checks the visibility of the element itself and it may return true even though a parent is not visible.

  Defaults to: false

Returns

• Boolean

  true if the element is currently visible, else false

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

Available since: 1.1.0

Parameters

• options : Object

Returns

• Ext.dom.Element

  this

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.

Available since: 1.1.0

Parameters

• msg : String (optional)

  A message to display in the mask

• msgCls : String (optional)

  A css class to apply to the msg element

Returns

• Ext.dom.Element

  The mask element

Overrides: Ext.dom.AbstractElement.mask

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.

Available since: 4.0.0

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 (optional)

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

Move this element relative to its current position.

Defined in override Ext.dom.Element_position.

Available since: 1.1.0

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

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

Defined in override Ext.dom.Element_position.

Available since: 1.1.0

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.dom.AbstractElement

  this

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

Available since: 4.1.0

Appends an event handler to this element.

Available since: 1.1.0

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 call that setup the listener.

• 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.dom.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

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

  this

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

Defined in override Ext.dom.Element_anim.

Available since: 4.0.0

Parameters

• seconds : Number

  The length of time to pause (in seconds)

Returns

• Ext.Element

  The Element

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.

Defined in override Ext.dom.Element_position.

Available since: 1.1.0

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

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

Defined in override Ext.dom.Element_anim.

Available since: 4.0.0

Parameters

• options : Object (optional)

  Object literal with any of the Fx config options

Returns

• Ext.dom.Element

  The Element

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

Available since: 3.4.0

Returns

• Ext.dom.Element

  this

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

Available since: 1.1.0

Parameters

• eventName : String

  The type of event to relay

• observable : Object

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

Removes all previous added listeners from this element

Available since: 1.1.0

Returns

• Ext.dom.Element

  this

Remove any anchor to this element. See anchorTo.

Defined in override Ext.dom.Element_alignment.

Available since: 3.4.0

Returns

• Ext.dom.Element

  this

Shorthand for un.

Removes an event handler from this element.

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

Example:

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

Available since: 1.1.0

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 on 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.dom.Element

  this

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: 350
    }
);

Defined in override Ext.dom.Element_anim.

Available since: 4.0.0

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

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

Defined in override Ext.dom.Element_scroll.

Available since: 1.1.0

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.

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

All of the following are equivalent:

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

Defined in override Ext.dom.Element_scroll.

Available since: 4.1.0

Parameters

• deltaX : Number/Number[]/Object

  Either the x delta, an Array specifying x and y deltas or an object with "x" and "y" properties.

• deltaY : Number/Boolean/Object

  Either the y delta, or an animate flag or config object.

• animate : Boolean/Object

  Animate flag/config object if the delta values were passed separately.

Returns

• Ext.Element

  this

Defined in override Ext.dom.Element_scroll.

Available since: 4.0.0

Parameters

• child : Object
• hscroll : Object

Scrolls this element into view within the passed container.

Defined in override Ext.dom.Element_scroll.

Available since: 1.1.0

Parameters

• container : String/HTMLElement/Ext.Element (optional)

  The container element to scroll. Should be a string (id), dom node, or Ext.Element.

  Defaults to: document.body

• hscroll : Boolean (optional)

  False to disable horizontal scroll.

  Defaults to: true

• animate : Boolean/Object (optional)

  true for the default animation or a standard Element animation config object

Returns

• Ext.dom.Element

  this

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.

Defined in override Ext.dom.Element_scroll.

Available since: 1.1.0

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

• Ext.Element

  this

Enable text selection for this element (normalized across browsers)

Defined in override Ext.dom.Element_style.

Available since: 4.0.6

Returns

• Ext.Element

  this

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

Defined in override Ext.dom.Element_position.

Available since: 1.1.0

Parameters

• x : Number

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

• y : Number

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

• width : Number/String

  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 : Number/String

  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.dom.AbstractElement

  this

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

Defined in override Ext.dom.Element_fx.

Available since: 1.1.0

Parameters

• value : Boolean/String

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

Returns

• Ext.dom.Element

  this

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

Defined in override Ext.dom.Element_style.

Available since: Ext JS 4.1.3

Conveniently sets left and top adding default units.

Defined in override Ext.dom.Element_position.

Available since: 1.1.0

Parameters

• left : String

  The left CSS property value

• top : String

  The top CSS property value

Returns

• Ext.dom.Element

  this

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

Defined in override Ext.dom.Element_position.

Available since: 1.1.0

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.dom.AbstractElement

  this

Set the opacity of the element

Defined in override Ext.dom.Element_style.

Available since: 1.1.0

Parameters

• opacity : Number

  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: 350, easing: 'easeIn'})

Returns

• Ext.dom.Element

  this

Set positioning with an object returned by getPositioning.

Defined in override Ext.dom.Element_position.

Available since: 1.1.0

Parameters

• posCfg : Object

Returns

• Ext.dom.AbstractElement

  this

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

Defined in override Ext.dom.Element_position.

Available since: 1.1.0

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.dom.AbstractElement

  this

Changes this Element's state to "vertical" (rotated 90 or 270 degrees). This involves inverting the getters and setters for height and width (getWidth becomes getHeight and vice versa), setStyle and getStyle will also return the inverse when height or width are being operated on.

Defined in override Ext.dom.Element_style.

Available since: Ext JS 4.1.3

Parameters

• cls : String

  an optional css class that contains the required styles for switching the element to vertical orientation. Omit this if the element already contains vertical styling. If cls is provided, it will be removed from the element when setHorizontal is called.

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.

Defined in override Ext.dom.Element_fx.

Available since: 1.1.0

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

  this

Overrides: Ext.dom.AbstractElement.setVisible

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

Defined in override Ext.dom.Element_position.

Available since: 1.1.0

Parameters

• pos : Number[]

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

  this

Overrides: Ext.dom.AbstractElement.setXY

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: 350
});

Defined in override Ext.dom.Element_anim.

Available since: 4.0.0

Parameters

• options : Object

  Object literal with any of the Fx config options

Returns

• Ext.Element

  The Element

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

Defined in override Ext.dom.Element_fx.

Available since: 1.1.0

Parameters

• animate : Boolean/Object (optional)

  true for the default animation or a standard Element animation config object

Returns

• Ext.dom.Element

  this

Overrides: Ext.dom.AbstractElement.show

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: 2000 });

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

Defined in override Ext.dom.Element_anim.

Available since: 4.0.0

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

  • preserveScroll : Boolean

    Set to true if preservation of any descendant elements' scrollTop values is required. By default the DOM wrapping operation performed by slideIn and slideOut causes the browser to lose all scroll positions.

Returns

• Ext.dom.Element

  The Element

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: 2000 });

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

Defined in override Ext.dom.Element_anim.

Available since: 4.0.0

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

  The Element

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

Available since: 1.1.0

Parameters

• eventName : String/String[]

  an event / array of events to stop from bubbling

• preventDefault : Boolean (optional)

  true to prevent the default action too

Returns

• Ext.dom.Element

  this

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

Defined in override Ext.dom.Element_anim.

Available since: 4.0.0

Parameters

• options : Object (optional)

  Object literal with any of the Fx config options

Returns

• Ext.dom.Element

  The Element

. Currently used for updating grid cells without modifying DOM structure

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

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

Available since: 4.1.1

Parameters

• source : Object

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

Defined in override Ext.dom.Element_fx.

Available since: 1.1.0

Parameters

• animate : Boolean/Object (optional)

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

Returns

• Ext.dom.Element

  this

Removes an event handler from this element.

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

Example:

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

Available since: 1.1.0

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 on call.

• scope : Object

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