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

Defaults to: "px"

Available since: 1.1.0

The DOM element

Available since: 1.1.0

The DOM element ID

Available since: 1.1.0

The element's default display mode

Defaults to: ""

Available since: 1.1.0

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

Available since: 3.4.0

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

Available since: 1.1.0

Defaults to 'x-hide-nosize'

Defaults to: Ext.baseCSSPrefix + 'hide-nosize'

Available since: 3.4.0

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

Available since: 4.0.0

Parameters

• className : String/String[]

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

Returns

• Ext.Element

  this

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)

Available since: 4.0.0

Parameters

• className : String

Returns

• Ext.Element

  this

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

Available since: 4.0.0

Parameters

• className : String

Returns

• Ext.Element

  this

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

Available since: 4.0.0

Parameters

• className : String

Returns

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

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

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

  this

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

Available since: 1.1.0

Parameters

• size : Object

  {Mixed} The size to set

• units : Object

  {String} The units to append to a numeric size value

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

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

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.

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

Appends the passed element(s) to this element

Available since: 1.1.0

Parameters

• el : String/HTMLElement/Ext.Element

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

Returns

• Ext.Element

  this

Appends this element to the passed element

Available since: 1.1.0

Parameters

• el : String/HTMLElement/Ext.Element

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

Returns

• Ext.Element

  this

More flexible version of setStyle for setting style properties.

Available since: 1.1.0

Parameters

• styles : String/Object/Function

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

Returns

• Ext.Element

  this

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

Available since: 1.1.0

Returns

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

Available since: 1.1.0

Parameters

• class : String (optional)

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

Returns

• Ext.Element

  The outermost wrapping element of the created box structure.

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

Available since: 1.1.0

Parameters

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

  The element in which to center the element.

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

Available since: 1.1.0

Parameters

• selector : String

  The CSS selector

• returnDom : Boolean (optional)

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

Returns

• HTMLElement/Ext.Element

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

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.

Alias for removeAllListeners.

Removes all previous added listeners from this element

Available since: 4.0.0

Returns

• Ext.Element

  this

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

Available since: 1.1.0

Returns

• Ext.Element

  this

Clear positioning back to the default when the document was loaded

Available since: 1.1.0

Parameters

• value : String (optional)

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

Returns

• Ext.Element

  this

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

Available since: 1.1.0

Returns

• Ext.Element

  this

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

Available since: 1.1.0

Parameters

• el : HTMLElement/String

  The element to check

Returns

• Boolean

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

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

Available since: 1.1.0

Parameters

• config : Object

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

• insertBefore : HTMLElement (optional)

  a child element of this element

• returnDom : Boolean (optional)

  true to return the dom node instead of creating an Element

Returns

• Ext.Element

  The new child element

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

  The new shim element

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

Available since: 4.0.0

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

Available since: 1.1.0

Parameters

• selector : String

  The CSS selector

• returnDom : Boolean (optional)

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

Returns

• HTMLElement/Ext.Element

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

Convenience method for setVisibilityMode(Element.DISPLAY)

Available since: 1.1.0

Parameters

• display : String (optional)

  What to set display to when visible

Returns

• Ext.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
});

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

Available since: 4.0.0

Parameters

• options : Object (optional)

  Object literal with any of the Fx config options

Returns

• Ext.Element

  The Element

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)

Available since: 1.1.0

Parameters

• selector : String

  The simple selector to test

• maxDepth : Number/String/HTMLElement/Ext.Element (optional)

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

• returnEl : Boolean (optional)

  True to return a Ext.Element object instead of DOM node

Returns

• HTMLElement

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

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

Available since: 1.1.0

Parameters

• selector : String

  The simple selector to test

• maxDepth : Number/String/HTMLElement/Ext.Element (optional)

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

• returnEl : Boolean (optional)

  True to return a Ext.Element object instead of DOM node

Returns

• HTMLElement

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

Gets the first child, skipping text nodes

Available since: 2.3.0

Parameters

• selector : String (optional)

  Find the next sibling that matches the passed simple selector

• returnDom : Boolean (optional)

  True to return a raw dom node instead of an Ext.Element

Returns

• Ext.Element/HTMLElement

  The first child or null

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

  this

Checks whether this element can be focused.

Available since: Ext JS 4.0.7

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

Available since: 4.0.0

Parameters

• color : String (optional)

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

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

  The Element

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

Available since: 4.0.1

Returns

• HTMLElement

  The active (focused) element in the document.

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

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]

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

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

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

Available since: 3.4.0

Parameters

• name : String

  The attribute name

• namespace : String (optional)

  The namespace in which to look for the attribute

Returns

• String

  The attribute value

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

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

Available since: 1.1.0

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

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

Available since: 1.1.0

Parameters

• local : Boolean

  True to get the local css position instead of page coordinate

Returns

• Number

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.

Available since: 1.1.0

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

Retrieves Ext.Element objects like Ext.get but is optimized for sub-elements. This is helpful for performance, because in IE (prior to IE 9), getElementById uses an non-optimized search. In those browsers, starting the search for an element with a matching ID at a parent of that element will greatly speed up the process.

Unlike Ext.get, this method only accepts ID's. If the ID is not a child of this element, it will still be found if it exists in the document, but will be slower than calling Ext.get directly.

Available since: 4.0.5

Parameters

• id : String

  The id of the element to get.

Returns

• Ext.Element

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

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

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.

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.

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.

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.

Available since: 4.0.0

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

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

Available since: 1.1.0

Parameters

• sides : String

Returns

• Number

Returns the offset height of the element

Available since: 1.1.0

Parameters

• contentHeight : Boolean (optional)

  true to get the height minus borders and padding

Returns

• Number

  The element's height

Gets the left X coordinate

Available since: 1.1.0

Parameters

• local : Boolean

  True to get the local css position instead of page coordinate

Returns

• Number

Gets this element's ElementLoader

Available since: 4.0.0

Returns

• Ext.ElementLoader

  The loader

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)

Available since: 4.0.0

Parameters

• sides : String (optional)

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

Returns

• Object/Number

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.

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

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

Available since: 1.1.0

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

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.

Available since: 4.0.0

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

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

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

Available since: 1.1.0

Returns

• Ext.util.Region

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

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

Available since: 1.1.0

Parameters

• local : Boolean

  True to get the local css position instead of page coordinate

Returns

• Number

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

Available since: 4.0.1

Parameters

• target : Object

  {Element} The top-most element being adjusted.

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.

Available since: 1.1.0

Returns

• Object

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

Returns the size of the element.

Available since: 1.1.0

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

Normalizes currentStyle and computedStyle.

Available since: 1.1.0

Parameters

• property : String

  The style property whose value is returned.

Returns

• String

  The current value of the style property for this element.

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.

Available since: 3.4.0

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

Available since: 1.1.0

Parameters

• style1 : String

  A style name

• style2 : String

  A style name

• etc : String

  .

Returns

• Object

  The style object

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.

Gets the top Y coordinate

Available since: 1.1.0

Parameters

• local : Boolean

  True to get the local css position instead of page coordinate

Returns

• Number

Returns the value of the "value" attribute

Available since: 1.1.0

Parameters

• asNumber : Boolean

  true to parse the value as a number

Returns

• String/Number

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

Available since: 4.0.0

Returns

• Ext.util.Region

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

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.

        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.

Available since: 1.1.0

Returns the offset width of the element

Available since: 1.1.0

Parameters

• contentWidth : Boolean (optional)

  true to get the width minus borders and padding

Returns

• Number

  The element's width

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

Available since: 1.1.0

Returns

• Number

  The X position of the element

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

Available since: 1.1.0

Returns

• Number[]

  The XY position of the element

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

Available since: 1.1.0

Returns

• Number

  The Y position of the element

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

Available since: 4.0.0

Parameters

• anchor : String (optional)

  One of the valid Fx anchor positions

  Defaults to: 'b'

• options : Object (optional)

  Object literal with any of the Fx config options

Returns

• Ext.Element

  The Element

Checks if the specified CSS class exists on this element's DOM node.

Available since: 4.0.0

Parameters

• className : String

  The CSS class to check for

Returns

• Boolean

  True if the class exists, else false

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

Available since: 3.4.0

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

Available since: 1.1.0

Parameters

• animate : Boolean/Object (optional)

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

Returns

• Ext.Element

  this

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

Available since: 4.0.0

Parameters

• color : String (optional)

  The highlight color. Should be a 6 char hex color without the leading #

  Defaults to: 'ffff9c'

• options : Object (optional)

  Object literal with any of the Fx config options

Returns

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

  this

Inserts this element after the passed element in the DOM

Available since: 1.1.0

Parameters

• el : String/HTMLElement/Ext.Element

  The element to insert after. The id of the node, a DOM Node or an existing Element.

Returns

• Ext.Element

  this

Inserts this element before the passed element in the DOM

Available since: 1.1.0

Parameters

• el : String/HTMLElement/Ext.Element

  The element before which this element will be inserted. The id of the node, a DOM Node or an existing Element.

Returns

• Ext.Element

  this

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

Available since: 1.1.0

Parameters

• el : String/HTMLElement/Ext.Element/Object

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

Returns

• Ext.Element

  The new child

Inserts an html fragment into this element

Available since: 1.1.0

Parameters

• where : String

  Where to insert the html in relation to this element - beforeBegin, afterBegin, beforeEnd, afterEnd. See Ext.DomHelper.insertHtml for details.

• html : String

  The HTML fragment

• returnEl : Boolean (optional)

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

Returns

• HTMLElement/Ext.Element

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

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

Available since: 1.1.0

Parameters

• el : String/HTMLElement/Ext.Element/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.Element

Returns

• Ext.Element

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

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

Available since: 1.1.0

Parameters

• selector : String

  The simple selector to test

Returns

• Boolean

  True if this element matches the selector, else false

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

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.

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

  Defaults to: false

Returns

• Boolean

  True if the element is currently visible, else false

Gets the last child, skipping text nodes

Available since: 2.3.0

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

Returns

• Ext.Element/HTMLElement

  The last child or null

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

  The mask element

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

  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.

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

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

  this

Gets the next sibling, skipping text nodes

Available since: 2.3.0

Parameters

• selector : String (optional)

  Find the next sibling that matches the passed simple selector

• returnDom : Boolean (optional)

  True to return a raw dom node instead of an Ext.Element

Returns

• Ext.Element/HTMLElement

  The next sibling or null

Shorthand for addListener.

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

  this

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

Available since: 2.3.0

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

Returns

• Ext.Element/HTMLElement

  The parent node or null

el.pause(1);

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.

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

Gets the previous sibling, skipping text nodes

Available since: 2.3.0

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

Returns

• Ext.Element/HTMLElement

  The previous sibling or null

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

Available since: 4.0.0

Parameters

• options : Object (optional)

  Object literal with any of the Fx config options

Returns

• Ext.Element

  The Element

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

Available since: 3.4.0

Returns

• Ext.Element

  this

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

Available since: 1.1.0

Parameters

• selector : String

  The CSS selector

Returns

• HTMLElement[]

  An array of the matched nodes

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

Available since: 4.0.0

Parameters

• className : String/String[]

  The CSS class to add, or an array of classes

Returns

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

• object : Object

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

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

Available since: 1.1.0

Removes all previous added listeners from this element

Available since: 1.1.0

Returns

• Ext.Element

  this

Remove any anchor to this element. See anchorTo.

Available since: 3.4.0

Returns

• Ext.Element

  this

Removes one or more CSS classes from the element.

Available since: 4.0.0

Parameters

• className : String/String[]

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

Returns

• Ext.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.removeListener('click', this.handlerFn);
// or
el.un('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 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.Element

  this

Forces the browser to repaint this element

Available since: 1.1.0

Returns

• Ext.Element

  this

Replaces the passed element with this element

Available since: 1.1.0

Parameters

• el : String/HTMLElement/Ext.Element

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

Returns

• Ext.Element

  this

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

Available since: 4.0.0

Parameters

• oldClassName : String

  The CSS class to replace

• newClassName : String

  The replacement CSS class

Returns

• Ext.Element

  this

Replaces this element with the passed element

Available since: 2.3.0

Parameters

• el : String/HTMLElement/Ext.Element/Object

  The new element (id of the node, a DOM Node or an existing Element) or a DomHelper config of an element to create

Returns

• Ext.Element

  this

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

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.

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.

private

Available since: 4.0.0

Parameters

• child : Object
• hscroll : Object

Scrolls this element into view within the passed container.

Available since: 1.1.0

Parameters

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

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

• hscroll : Boolean (optional)

  False to disable horizontal scroll (defaults to true)

Returns

• Ext.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().

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

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

Available since: 1.1.0

Parameters

• selector : String/HTMLElement[]

  The CSS selector or an array of elements

• root : HTMLElement/String (optional)

  The root element of the query or id of the root

Returns

• Ext.CompositeElementLite/Ext.CompositeElement

Enable text selection for this element (normalized across browsers)

Available since: 4.0.6

Returns

• Ext.Element

  this

Serializes a DOM form into a url encoded string

Available since: 4.0.0

Parameters

• form : Object

  The form

Returns

• String

  The url encoded form

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

Available since: 1.1.0

Parameters

• o : Object

  The object with the attributes

• useSet : Boolean (optional)

  false to override the default setAttribute to use expandos.

Returns

• Ext.Element

  this

Sets the element's CSS bottom style.

Available since: 1.1.0

Parameters

• bottom : String

  The bottom CSS property value

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.

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

  this

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.

Available since: 1.1.0

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

  this

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

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

  this

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

Available since: 1.1.0

Parameters

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

  this

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

Available since: 1.1.0

Parameters

• left : String

  The left CSS property value

Returns

• Ext.Element

  this

Quick set left and top adding default units

Available since: 1.1.0

Parameters

• left : String

  The left CSS property value

• top : String

  The top CSS property value

Returns

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

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

  this

Set the opacity of the element

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

Returns

• Ext.Element

  this

Set positioning with an object returned by getPositioning().

Available since: 1.1.0

Parameters

• posCfg : Object

Returns

• Ext.Element

  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.

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

  this

Sets the element's CSS right style.

Available since: 1.1.0

Parameters

• right : String

  The right CSS property value

Returns

• Ext.Element

  this

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

Available since: 1.1.0

Parameters

• 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.
  • A size object in the format {width: widthValue, height: heightValue}.

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

  this

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

Available since: 1.1.0

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

  this

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

Available since: 1.1.0

Parameters

• top : String

  The top CSS property value

Returns

• Ext.Element

  this

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.

Available since: 1.1.0

Parameters

• visMode : Number

  Ext.Element.VISIBILITY or Ext.Element.DISPLAY

Returns

• Ext.Element

  this

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.

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

  this

Set the width of this Element.

Available since: 1.1.0

Parameters

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

• animate : Boolean/Object (optional)

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

Returns

• Ext.Element

  this

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

Available since: 1.1.0

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

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

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

Available since: 1.1.0

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

  this

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

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.

Available since: 1.1.0

Parameters

• animate : Boolean/Object (optional)

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

Returns

• Ext.Element

  this

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

Available since: 4.0.0

Parameters

• anchor : String (optional)

  One of the valid Fx anchor positions

  Defaults to: 't'

• options : Object (optional)

  Object literal with any of the Fx config options

Returns

• Ext.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
});

Available since: 4.0.0

Parameters

• anchor : String (optional)

  One of the valid Fx anchor positions

  Defaults to: 't'

• options : Object (optional)

  Object literal with any of the Fx config options

Returns

• Ext.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.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
});

Available since: 4.0.0

Parameters

• options : Object (optional)

  Object literal with any of the Fx config options

Returns

• Ext.Element

  The Element

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

Available since: 1.1.0

Parameters

• animate : Boolean/Object (optional)

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

Returns

• Ext.Element

  this

Toggles the specified CSS class on this element (removes it if it already exists, otherwise adds it).

Available since: 4.0.0

Parameters

• className : String

  The CSS class to toggle

Returns

• Ext.Element

  this

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

Available since: 1.1.0

Parameters

• x : Number/Number[]

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

Shorthand for removeListener.

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.removeListener('click', this.handlerFn);
// or
el.un('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 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.Element

  this

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

Available since: 1.1.0

Returns

• Ext.Element

  this

Removes a previously applied mask.

Available since: 1.1.0

Disables text selection for this element (normalized across browsers)

Available since: 1.1.0

Returns

• Ext.Element

  this

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

Available since: 1.1.0

Parameters

• selector : String

  The simple selector to test

• maxDepth : Number/String/HTMLElement/Ext.Element (optional)

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

Returns

• Ext.Element

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

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

Available since: 1.1.0

Parameters

• html : String

  The new HTML

• loadScripts : Boolean (optional)

  True to look for and process scripts

  Defaults to: false

• callback : Function (optional)

  For async script loading you can be notified when the update completes

Returns

• Ext.Element

  this

Creates and wraps this element with another element

Available since: 1.1.0

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

Returns

• HTMLElement/Ext.Element

  The newly created wrapper element

Returns the top Element that is located at the passed coordinates

Available since: 4.0.0

Parameters

• x : Number

  The x coordinate

• y : Number

  The y coordinate

Returns

• String

  The found Element

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

This method does not retrieve Components. This method retrieves Ext.Element objects which encapsulate DOM elements. To retrieve a Component by its ID, use Ext.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.

Available since: 1.1.0

Parameters

• el : String/HTMLElement/Ext.Element

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

Returns

• Ext.Element

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

Retrieves the document height

Available since: 4.0.0

Returns

• Number

  documentHeight

Retrieves the document width

Available since: 4.0.0

Returns

• Number

  documentWidth

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

Available since: 4.0.0

Returns

• String

  Orientation of window: 'portrait' or 'landscape'

Retrieves the viewport size of the window.

Available since: 4.0.0

Returns

• Object

  object containing width and height properties

Retrieves the viewport height of the window.

Available since: 4.0.0

Returns

• Number

  viewportHeight

Retrieves the viewport width of the window.

Available since: 4.0.0

Returns

• Number

  viewportWidth

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

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

Available since: 4.0.0

Parameters

• prop : String

  The property to normalize

Returns

• String

  The normalized string

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)

Available since: 4.0.0

Parameters

• box : Number/String

  The encoded margins

Returns

• Object

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

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.Element.parseStyles(css));

Available since: 4.0.0

Parameters

• styles : String

  A CSS string

Returns

• Object

  styles

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)

Available since: 4.0.0

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

Where supported. Fires when an attribute has been modified.

Available since: 2.3.0

Parameters

• e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

• t : HTMLElement

  The target of the event.

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

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

Available since: 2.3.0

Parameters

• e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

• t : HTMLElement

  The target of the event.

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

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

Available since: 2.3.0

Parameters

• e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

• t : HTMLElement

  The target of the event.

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

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

Available since: 2.3.0

Parameters

• e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

• t : HTMLElement

  The target of the event.

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

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

Available since: 2.3.0

Parameters

• e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

• t : HTMLElement

  The target of the event.

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

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

Available since: 2.3.0

Parameters

• e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

• t : HTMLElement

  The target of the event.

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

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

Available since: 2.3.0

Parameters

• e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

• t : HTMLElement

  The target of the event.

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

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

Available since: 2.3.0

Parameters

• e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

• t : HTMLElement

  The target of the event.

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Where supported. Fires when the subtree is modified.

Available since: 2.3.0

Parameters

• e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

• t : HTMLElement

  The target of the event.

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

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

Available since: 2.3.0

Parameters

• e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

• t : HTMLElement

  The target of the event.

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

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

Available since: 2.3.0

Parameters

• e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

• t : HTMLElement

  The target of the event.

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

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

Available since: 2.3.0

Parameters

• e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

• t : HTMLElement

  The target of the event.

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fires when a mouse click is detected within the element.

Available since: 2.3.0

Parameters

• e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

• t : HTMLElement

  The target of the event.

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fires when a right click is detected within the element.

Available since: 3.4.0

Parameters

• e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

• t : HTMLElement

  The target of the event.

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

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

Available since: 2.3.0

Parameters

• e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

• t : HTMLElement

  The target of the event.

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

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

Available since: 2.3.0

Parameters

• e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

• t : HTMLElement

  The target of the event.

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

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

Available since: 2.3.0

Parameters

• e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

• t : HTMLElement

  The target of the event.

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fires when a keydown is detected within the element.

Available since: 2.3.0

Parameters

• e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

• t : HTMLElement

  The target of the event.

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fires when a keypress is detected within the element.

Available since: 2.3.0

Parameters

• e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

• t : HTMLElement

  The target of the event.

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fires when a keyup is detected within the element.

Available since: 2.3.0

Parameters

• e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

• t : HTMLElement

  The target of the event.

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

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

Available since: 2.3.0

Parameters

• e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

• t : HTMLElement

  The target of the event.

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fires when a mousedown is detected within the element.

Available since: 2.3.0

Parameters

• e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

• t : HTMLElement

  The target of the event.

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fires when the mouse enters the element.

Available since: 3.4.0

Parameters

• e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

• t : HTMLElement

  The target of the event.

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fires when the mouse leaves the element.

Available since: 3.4.0

Parameters

• e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

• t : HTMLElement

  The target of the event.

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fires when a mousemove is detected with the element.

Available since: 2.3.0

Parameters

• e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

• t : HTMLElement

  The target of the event.

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fires when a mouseout is detected with the element.

Available since: 2.3.0

Parameters

• e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

• t : HTMLElement

  The target of the event.

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fires when a mouseover is detected within the element.

Available since: 2.3.0

Parameters

• e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

• t : HTMLElement

  The target of the event.

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fires when a mouseup is detected within the element.

Available since: 2.3.0

Parameters

• e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

• t : HTMLElement

  The target of the event.

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fires when a form is reset.

Available since: 2.3.0

Parameters

• e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

• t : HTMLElement

  The target of the event.

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fires when a document view is resized.

Available since: 2.3.0

Parameters

• e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

• t : HTMLElement

  The target of the event.

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fires when a document view is scrolled.

Available since: 2.3.0

Parameters

• e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

• t : HTMLElement

  The target of the event.

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

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

Available since: 2.3.0

Parameters

• e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

• t : HTMLElement

  The target of the event.

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fires when a form is submitted.

Available since: 2.3.0

Parameters

• e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

• t : HTMLElement

  The target of the event.

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

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.

Available since: 2.3.0

Parameters

• e : Ext.EventObject

  The Ext.EventObject encapsulating the DOM event.

• t : HTMLElement

  The target of the event.

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.