Print Friendly

Class Ext.Element

Package:Ext
Class:Element
Extends:Object
Subclasses:Layer
Defined In:Element.js
Represents an Element in the DOM.

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

// or with getEl
var el = getEl("my-div");

// or with a DOM element
var el = Ext.get(myDivElement);
Using Ext.get() or getEl() instead of calling the constructor directly ensures you get the same object each call instead of constructing a new one.

Animations
Many of the functions for manipulating an element have an optional "animate" parameter. The animate parameter should either be a boolean (true) or an object literal with animation options. The animation options are: 
Option    Default   Description
--------- --------  ---------------------------------------------
duration  .35       The duration of the animation in seconds
easing    easeOut   The YUI easing method
callback  none      A function to execute when the anim completes
scope     this      The scope (this) of the callback function
Also, the Anim object being used for the animation will be set on your options object as "anim", which allows you to stop or manipulate the animation. Here's an example: 
var el = Ext.get("my-div");

// no animation
el.setWidth(100);

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

// animation with some options set
el.setWidth(100, {
    duration: 1,
    callback: this.foo,
    scope: this
});

// using the "anim" property to get the Anim object
var opt = {
    duration: 1,
    callback: this.foo,
    scope: this
};
el.setWidth(100, opt);
...
if(opt.anim.isAnimated()){
    opt.anim.stop();
}
Composite (Collections of) Elements
For working with collections of Elements, see Ext.CompositeElement

Properties   -  Methods   -  Events

Public Properties

Property Defined By
  Element.DISPLAY : Number Element
<static> Visibility mode constant - Use display to hide element
  Element.VISIBILITY : Number Element
<static> Visibility mode constant - Use visibility to hide element
  defaultUnit : String Element
The default unit to append to CSS values where a unit isn't provided (defaults to px).
  dom : HTMLElement Element
The DOM element
  id : String Element
The DOM element ID
  originalDisplay : String Element
The element's default display mode (defaults to "")

Public Methods

Method Defined By
  Element( String/HTMLElement element, [Boolean forceNew] ) Element
Create a new Element directly.
  Element.fly( String/HTMLElement el, [String named] ) : Element Element
<static> Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a...
  Element.get( String/HTMLElement/Element el ) : Element Element
<static> Static method to retrieve Element objects. Uses simple caching to consistently return the same object....
  addClass( String/Array className ) : Ext.Element Element
Adds one or more CSS classes to the element. Duplicate classes are automatically filtered out.
  addClassOnClick( String className ) : Ext.Element Element
Sets up event handlers to add and remove a css class when the mouse is down and then up on this element (a click effect)
  addClassOnFocus( String className ) : Ext.Element Element
Sets up event handlers to add and remove a css class when this element has the focus
  addClassOnOver( String className, [Boolean preventFlicker] ) : Ext.Element Element
Sets up event handlers to add and remove a css class when the mouse is over this element
  addKeyListener( Number/Array/Object/String key, Function fn, [Object scope] ) : Ext.KeyMap Element
Convenience method for constructing a KeyMap
  addKeyMap( Object config ) : Ext.KeyMap Element
Creates a KeyMap for this element
  addListener( String eventName, Function fn, [Object scope], [Object options] ) : void Element
Appends an event handler
  alignTo( String/HTMLElement/Ext.Element element, String position, [Array offsets], [Boolean/Object animate] ) : Ext.Element Element
Aligns this element with another element relative to the specified anchor points. If the other element is the documen...
  anchorTo( String/HTMLElement/Ext.Element element, String position, [Array offsets], [Boolean/Object animate], [Boolean/Number monitorScroll], Function callback ) : Ext.Element Element
Anchors an element to another element and realigns it when the window is resized.
  animate( Object args, [Float duration], [Function onComplete], [String easing], [String animType] ) : Ext.Element Element
Perform animation on this element.
  appendChild( String/HTMLElement/Array/Element/CompositeElement el ) : Ext.Element Element
Appends the passed element(s) to this element
  appendTo( String/HTMLElement/Element el ) : Ext.Element Element
Appends this element to the passed element
  applyStyles( String/Object/Function styles ) : Ext.Element Element
More flexible version of setStyle for setting style properties.
  autoHeight( [Boolean animate], [Float duration], [Function onComplete], [String easing] ) : Ext.Element Element
Measures the element's content height and updates height to match. Note: this function uses setTimeout so the new hei...
  beginMeasure() : Ext.Element Element
Temporarily enables offsets (width,height,x,y) for an element with display:none, use endMeasure() when done.
  blur() : Ext.Element Element
Tries to blur the element. Any exceptions are caught and ignored.
  boxWrap( [String class] ) : Ext.Element Element
Wraps the specified element with a special markup/CSS block that renders by default as a gray container with a gradie...
  center( [String/HTMLElement/Ext.Element centerIn] ) : void Element
Centers the Element in either the viewport, or another Element.
  child( String selector, [Boolean returnDom] ) : HTMLElement/Ext.Element Element
Selects a single child at any depth below this element based on the passed CSS selector (the selector should not cont...
  clean( [Boolean forceReclean] ) : void Element
Removes worthless text nodes
  clearOpacity() : Ext.Element Element
Clears any opacity settings from this element. Required in some cases for IE.
  clearPositioning( [String value] ) : Ext.Element Element
Clear positioning back to the default when the document was loaded
  clip() : Ext.Element Element
Store the current overflow setting and clip overflow on the element - use unclip to remove
  contains( HTMLElement/String el ) : Boolean Element
Returns true if this element is an ancestor of the passed element
  createChild( Object config, [HTMLElement insertBefore], [Boolean returnDom] ) : Ext.Element Element
Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child e...
  createProxy( String/Object config, [String/HTMLElement renderTo], [Boolean matchBox] ) : Ext.Element Element
Creates a proxy element of this element
  createShim() : Ext.Element Element
Creates an iframe shim for this element to keep selects and other windowed objects from showing through.
  down( String selector, [Boolean returnDom] ) : HTMLElement/Ext.Element Element
Selects a single *direct* child based on the passed CSS selector (the selector should not contain an id).
  enableDisplayMode( [String display] ) : Ext.Element Element
Convenience method for setVisibilityMode(Element.DISPLAY)
  endMeasure() : Ext.Element Element
Restores displays to before beginMeasure was called
  findParent( String selector, [Number/String/HTMLElement/Element maxDepth], [Boolean returnEl] ) : HTMLElement 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:fi...
  findParentNode( String selector, [Number/String/HTMLElement/Element maxDepth], [Boolean returnEl] ) : HTMLElement Element
Looks at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child)
  fitToParent( [Boolean monitorResize], [String/HTMLElment/Element targetParent] ) : Ext.Element Element
Sizes this element to its parent element's dimensions performing neccessary box adjustments.
  focus() : Ext.Element Element
Tries to focus the element. Any exceptions are caught and ignored.
  getAlignToXY( String/HTMLElement/Ext.Element element, String position, [Array offsets] ) : Array Element
Gets the x,y coordinates to align this element with another element. See alignTo for more info on the supported posit...
  getAnchorXY( [String anchor], [Object size], [Boolean local] ) : Array Element
Gets the x,y coordinates specified by the anchor position on the element.
  getAttributeNS( String namespace, String name ) : String Element
Returns the value of a namespaced attribute from the element's underlying DOM node.
  getBorderWidth( String side ) : Number Element
Gets the width of the border(s) for the specified side(s)
  getBottom( Boolean local ) : Number Element
Gets the bottom Y coordinate of the element (element Y position + element height)
  getBox( [Boolean contentBox], [Boolean local] ) : Object Element
Return a box {x, y, width, height} that can be used to set another elements size/location to match this element.
  getCenterXY() : Array Element
Calculates the x, y to center this element on the screen
  getColor( String attr, String defaultValue, [String prefix] ) : void Element
Return the CSS color for the specified CSS attribute. rgb, 3 digit (like #fff) and valid values are convert to standa...
  getComputedHeight() : Number Element
Returns either the offsetHeight or the height of this element based on CSS height adjusted by padding or borders when...
  getComputedWidth() : Number Element
Returns either the offsetWidth or the width of this element based on CSS width adjusted by padding or borders when ne...
  getFrameWidth( String sides ) : Number Element
Returns the sum width of the padding and borders for the passed "sides". See getBorderWidth() for more informat...
  getHeight( [Boolean contentHeight] ) : Number Element
Returns the offset height of the element
  getLeft( Boolean local ) : Number Element
Gets the left X coordinate
  getMargins( [String sides] ) : Object/Number Element
Returns an object with properties top, left, right and bottom representing the margins of this element unless sides i...
  getNextSibling() : HTMLElement Element
Gets the next sibling, skipping text nodes
  getPadding( String side ) : Number Element
Gets the width of the padding(s) for the specified side(s)
  getPositioning() : Object Element
Gets an object with all CSS positioning properties. Useful along with setPostioning to get snapshot before performing...
  getPrevSibling() : HTMLElement Element
Gets the previous sibling, skipping text nodes
  getRegion() : Region Element
Returns the region of the given element. The element must be part of the DOM tree to have a region (display:none or e...
  getRight( Boolean local ) : Number Element
Gets the right X coordinate of the element (element X position + element width)
  getScroll() : Object Element
Returns the current scroll position of the element.
  getSize( [Boolean contentSize] ) : Object Element
Returns the size of the element.
  getStyle( String property ) : String Element
Normalizes currentStyle and computedStyle. This is not YUI getStyle, it is an optimised version.
  getStyles( String style1, String style2, String etc. ) : Object Element
Returns an object with properties matching the styles requested. For example, el.getStyles('color', 'font-size', 'wid...
  getTop( Boolean local ) : Number Element
Gets the top Y coordinate
  getUpdateManager() : Ext.UpdateManager Element
Gets this element's UpdateManager
  getValue( Boolean asNumber ) : String/Number Element
Returns the value of the "value" attribute
  getViewSize() : Object Element
Returns the width and height of the viewport.
  getWidth( [Boolean contentWidth] ) : Number Element
Returns the offset width of the element
  getX() : Number Element
Gets the current X position of the element based on page coordinates. Element must be part of the DOM tree to have p...
  getXY() : Array Element
Gets the current position of the element based on page coordinates. Element must be part of the DOM tree to have pag...
  getY() : Number Element
Gets the current Y position of the element based on page coordinates. Element must be part of the DOM tree to have p...
  hasClass( String className ) : Boolean Element
Checks if the specified CSS class exists on this element's DOM node.
  hide( [Boolean/Object animate] ) : Ext.Element Element
Hide this element - Uses display mode to determine whether to use "display" or "visibility". See setVisible.
  initDD( String group, Object config, Object overrides ) : Ext.dd.DD Element
Initializes a Ext.dd.DD drag drop object for this element.
  initDDProxy( String group, Object config, Object overrides ) : Ext.dd.DDProxy Element
Initializes a Ext.dd.DDProxy object for this element.
  initDDTarget( String group, Object config, Object overrides ) : Ext.dd.DDTarget Element
Initializes a Ext.dd.DDTarget object for this element.
  insertAfter( String/HTMLElement/Element el ) : Ext.Element Element
Inserts this element after the passed element in the DOM
  insertBefore( String/HTMLElement/Element el ) : Ext.Element Element
Inserts this element before the passed element in the DOM
  insertFirst( String/HTMLElement/Element/Object el ) : Ext.Element Element
Inserts (or creates) an element (or DomHelper config) as the first child of the this element
  insertHtml( String where, String html, Boolean returnEl ) : HTMLElement/Ext.Element Element
Inserts an html fragment into this element
  insertSibling( String/HTMLElement/Element/Object el, [String where], [Boolean returnDom] ) : Ext.Element Element
Inserts (or creates) the passed element (or DomHelper config) as a sibling of this element
  is( String selector ) : Boolean Element
Returns true if this element matches the passed simple selector (e.g. div.some-class or span:first-child)
  isBorderBox() : Boolean Element
Tests various css rules/browsers to determine if this element uses a border box
  isDisplayed() : Boolean Element
Returns true if display is not "none"
  isMasked() : Boolean Element
Returns true if this element is masked
  isScrollable() : Boolean Element
Returns true if this element is scrollable.
  isVisible( [Boolean deep] ) : Boolean Element
Checks whether the element is currently visible using both visibility and display properties.
  load( String/Function url, [String/Object params], [Function callback], [Boolean discardUrl] ) : Ext.Element Element
Direct access to the UpdateManager update() method (takes the same parameters).
  mask( [String msg], [String msgCls] ) : Element Element
Puts a mask over this element to disable user interaction. Requires core.css. This method can only be applied to elem...
  move( String direction, Number distance, [Boolean/Object animate] ) : Ext.Element Element
Move this element relative to its current position.
  moveTo( Number x, Number y, [Boolean/Object animate] ) : Ext.Element Element
Sets the position of the element in page coordinates, regardless of how the element is positioned. The element must b...
  position( [String pos], [Number zIndex], [Number x], [Number y] ) : void Element
Initializes positioning on this element. If a desired position is not passed, it will make the the element positioned...
  query( String selector ) : Array Element
Selects child nodes based on the passed CSS selector (the selector should not contain an id).
  radioClass( String/Array className ) : Ext.Element Element
Adds one or more CSS classes to this element and removes the same class(es) from all siblings.
  remove() : void Element
Removes this element from the DOM and deletes it from the cache
  removeAllListeners() : Ext.Element Element
Removes all previous added listeners from this element
  removeClass( String/Array className ) : Ext.Element Element
Removes one or more CSS classes from the element.
  removeListener( String eventName, Function fn ) : Ext.Element Element
Removes an event handler from this element
  repaint() : Ext.Element Element
Forces the browser to repaint this element
  replace( String/HTMLElement/Element el ) : Ext.Element Element
Replaces the passed element with this element
  replaceClass( String oldClassName, String newClassName ) : Ext.Element Element
Replaces a CSS class on the element with another. If the old name does not exist, the new name will simply be added.
  scroll( String direction, Number distance, [Boolean/Object animate] ) : Boolean Element
Scrolls this element the specified direction. Does bounds checking to make sure the scroll is within this element's s...
  scrollIntoView( [String/HTMLElement/Element container], [Boolean hscroll] ) : Ext.Element Element
Scrolls this element into view within the passed container.
  scrollTo( String side, Number value, [Boolean/Object animate] ) : Element Element
Scrolls this element the specified scroll point. It does NOT do bounds checking so if you scroll to a weird value it ...
  select( String selector, [Boolean unique] ) : CompositeElement/CompositeElementLite Element
Creates a Ext.CompositeElement for child nodes based on the passed CSS selector (the selector should not contain an id).
  set( Object o, [Boolean useSet] ) : Ext.Element Element
Sets the passed attributes as attributes of this element (a style attribute can be a string, object or function)
  setBottom( String bottom ) : Ext.Element Element
Sets the element's CSS bottom style.
  setBounds( Number x, Number y, Number width, Number height, [Boolean/Object animate] ) : Ext.Element Element
Sets the element's position and size in one shot. If animation is true then width, height, x and y will be animated c...
  setBox( Object box, [Boolean adjust], [Boolean/Object animate] ) : Ext.Element Element
Sets the element's box. Use getBox() on another element to get a box obj. If animate is true then width, height, x an...
  setDisplayed( Boolean value ) : Ext.Element Element
Sets the CSS display property. Uses originalDisplay if the specified value is a boolean true.
  setHeight( Number height, [Boolean/Object animate] ) : Ext.Element Element
Set the height of the element
  setLeft( String left ) : Ext.Element Element
Sets the element's left position directly using CSS style (instead of setX).
  setLeftTop() : Ext.Element Element
Quick set left and top adding default units
  setLocation( Number x, Number y, [Boolean/Object animate] ) : Ext.Element Element
Sets the position of the element in page coordinates, regardless of how the element is positioned. The element must b...
  setOpacity( Float opacity, [Boolean/Object animate] ) : Ext.Element Element
Set the opacity of the element
  setPositioning( Object posCfg ) : Ext.Element Element
Set positioning with an object returned by getPositioning().
  setRegion( Ext.lib.Region region, [Boolean/Object animate] ) : Ext.Element Element
Sets the element's position and size the the specified region. If animation is true then width, height, x and y will ...
  setRight( String right ) : Ext.Element Element
Sets the element's CSS right style.
  setSize( Number width, Number height, [Boolean/Object animate] ) : Ext.Element Element
Set the size of the element. If animation is true, both width an height will be animated concurrently.
  setStyle( String/Object property, [String value] ) : Ext.Element Element
Wrapper for setting style properties, also takes single object parameter of multiple styles.
  setTop( String top ) : Ext.Element Element
Sets the element's top position directly using CSS style (instead of setY).
  setVisibilityMode( visMode Element.VISIBILITY ) : Ext.Element Element
Sets the element's visibility mode. When setVisible() is called it will use this to determine whether to set the visi...
  setVisible( Boolean visible, [Boolean/Object animate] ) : Ext.Element Element
Sets the visibility of the element (see details). If the visibilityMode is set to Element.DISPLAY, it will use the di...
  setWidth( Number width, [Boolean/Object animate] ) : Ext.Element Element
Set the width of the element
  setX( Number The, [Boolean/Object animate] ) : Ext.Element Element
Sets the X position of the element based on page coordinates. Element must be part of the DOM tree to have page coor...
  setXY( Array pos, [Boolean/Object animate] ) : Ext.Element Element
Sets the position of the element in page coordinates, regardless of how the element is positioned. The element must b...
  setY( Number The, [Boolean/Object animate] ) : Ext.Element Element
Sets the Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coor...
  show( [Boolean/Object animate] ) : Ext.Element Element
Show this element - Uses display mode to determine whether to use "display" or "visibility". See setVisible.
  swallowEvent( String eventName, [Boolean preventDefault] ) : Ext.Element Element
Stops the specified event from bubbling and optionally prevents the default action
  toggle( [Boolean/Object animate] ) : Ext.Element Element
Toggles the element's visibility or display, depending on visibility mode.
  toggleClass( String className ) : Ext.Element Element
Toggles the specified CSS class on this element (removes it if it already exists, otherwise adds it).
  translatePoints( Number/Array x, Number y, Object An ) : void Element
Translates the passed page coordinates into left/top css values for this element
  unclip() : Ext.Element Element
Return clipping (overflow) to original clipping before clip() was called
  unmask() : void Element
Removes a previously applied mask. If removeEl is true the mask overlay is destroyed, otherwise it is cached for reuse.
  unselectable() : Ext.Element Element
Disables text selection for this element (normalized across browsers)
  up( String selector, [Number/String/HTMLElement/Element maxDepth] ) : Ext.Element Element
Walks up the dom looking for a parent node that matches the passed simple selector (e.g. div.some-class or span:first...
  update( String html, [Boolean loadScripts], Function callback ) : Ext.Element Element
Update the innerHTML of this element, optionally searching for and processing scripts
  wrap( [Object config], [Boolean returnDom] ) : /HTMLElementElement Element
Creates and wraps this element with another element

Public Events

This class has no public events.

Property Details

Element.DISPLAY

public Number Element.DISPLAY
<static> Visibility mode constant - Use display to hide element
This property is defined by Element.

Element.VISIBILITY

public Number Element.VISIBILITY
<static> Visibility mode constant - Use visibility to hide element
This property is defined by Element.

defaultUnit

public String defaultUnit
The default unit to append to CSS values where a unit isn't provided (defaults to px).
This property is defined by Element.

dom

public HTMLElement dom
The DOM element
This property is defined by Element.

id

public String id
The DOM element ID
This property is defined by Element.

originalDisplay

public String originalDisplay
The element's default display mode (defaults to "")
This property is defined by Element.

Constructor Details

Element

public function Element( String/HTMLElement element, [Boolean forceNew] )
Create a new Element directly.
Parameters:
  • element : String/HTMLElement
  • forceNew : Boolean
    (optional) By default the constructor checks to see if there is already an instance of this element in the cache and if there is it returns the same instance. This will skip that check (useful for extending this class).

Method Details

Element.fly

public function Element.fly( String/HTMLElement el, [String named] )
<static> Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element - the dom node can be overwritten by other code.
Parameters:
  • el : String/HTMLElement
    The dom node or id
  • named : String
    (optional) Allows for creation of named reusable flyweights to prevent conflicts (e.g. internally Ext uses "_internal")
Returns:
  • Element
    The shared Element object
This method is defined by Element.

Element.get

public function Element.get( String/HTMLElement/Element el )
<static> Static method to retrieve Element objects. Uses simple caching to consistently return the same object. Automatically fixes if an object was recreated with the same id via AJAX or DOM.
Parameters:
  • el : String/HTMLElement/Element
    The id of the node, a DOM Node or an existing Element.
Returns:
  • Element
    The Element object
This method is defined by Element.

addClass

public function addClass( String/Array className )
Adds one or more CSS classes to the element. Duplicate classes are automatically filtered out.
Parameters:
  • className : String/Array
    The CSS class to add, or an array of classes
Returns:
  • Ext.Element
    this
This method is defined by Element.

addClassOnClick

public function addClassOnClick( String className )
Sets up event handlers to add and remove a css class when the mouse is down and then up on this element (a click effect)
Parameters:
  • className : String
Returns:
  • Ext.Element
    this
This method is defined by Element.

addClassOnFocus

public function addClassOnFocus( String className )
Sets up event handlers to add and remove a css class when this element has the focus
Parameters:
  • className : String
Returns:
  • Ext.Element
    this
This method is defined by Element.

addClassOnOver

public function addClassOnOver( String className, [Boolean preventFlicker] )
Sets up event handlers to add and remove a css class when the mouse is over this element
Parameters:
  • className : String
  • preventFlicker : Boolean
    (optional) If set to true, it prevents flickering by filtering mouseout events for children elements
Returns:
  • Ext.Element
    this
This method is defined by Element.

addKeyListener

public function addKeyListener( Number/Array/Object/String key, Function fn, [Object scope] )
Convenience method for constructing a KeyMap
Parameters:
  • key : Number/Array/Object/String
    Either a string with the keys to listen for, the numeric key code, array of key codes or an object with the following options: {key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)}
  • fn : Function
    The function to call
  • scope : Object
    (optional) The scope of the function
Returns:
  • Ext.KeyMap
    The KeyMap created
This method is defined by Element.

addKeyMap

public function addKeyMap( Object config )
Creates a KeyMap for this element
Parameters:
  • config : Object
    The KeyMap config. See Ext.KeyMap for more details
Returns:
  • Ext.KeyMap
    The KeyMap created
This method is defined by Element.

addListener

public function addListener( String eventName, Function fn, [Object scope], [Object options] )
Appends an event handler
Parameters:
  • eventName : String
    The type of event to append
  • fn : Function
    The method the event invokes
  • scope : Object
    (optional) The scope (this object) of the fn
  • options : Object
    (optional)An object with standard Ext.EventManager.addListener options
Returns:
  • void
This method is defined by Element.

alignTo

public function alignTo( String/HTMLElement/Ext.Element element, String position, [Array offsets], [Boolean/Object animate] )
Aligns this element with another element relative to the specified anchor points. If the other element is the document it aligns it to the viewport. The position parameter is optional, and can be specified in any one of the following formats:
  • Blank: Defaults to aligning the element's top-left corner to the target's bottom-left corner ("tl-bl").
  • One anchor (deprecated): The passed anchor position is used as the target element's anchor point. The element being aligned will position its top-left corner (tl) to that point. This method has been deprecated in favor of the newer two anchor syntax below.
  • Two anchors: If two values from the table below are passed separated by a dash, the first value is used as the element's anchor point, and the second value is used as the target's anchor point.
In addition to the anchor points, the position parameter also supports the "?" character. If "?" is passed at the end of the position string, the element will attempt to align as specified, but the position will be adjusted to constrain to the viewport if necessary. Note that the element being aligned might be swapped to align to a different position than that specified in order to enforce the viewport constraints. Following are all of the supported anchor positions: 
Value  Description
-----  -----------------------------
tl     The top left corner (default)
t      The center of the top edge
tr     The top right corner
l      The center of the left edge
c      In the center of the element
r      The center of the right edge
bl     The bottom left corner
b      The center of the bottom edge
br     The bottom right corner
Example Usage: 
// align el to other-el using the default positioning ("tl-bl", non-constrained)
el.alignTo("other-el");

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

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

// align the center of el with the bottom left corner of other-el and
// adjust the x position by -6 pixels (and the y position by 0)
el.alignTo("other-el", "c-bl", [-6, 0]);
Parameters:
  • element : String/HTMLElement/Ext.Element
    The element to align to.
  • position : String
    The position to align to.
  • offsets : Array
    (optional) Offset the positioning by [x, y]
  • animate : Boolean/Object
    (optional) true for the default animation or a standard Element animation config object
Returns:
  • Ext.Element
    this
This method is defined by Element.

anchorTo

public function anchorTo( String/HTMLElement/Ext.Element element, String position, [Array offsets], [Boolean/Object animate], [Boolean/Number monitorScroll], Function callback )
Anchors an element to another element and realigns it when the window is resized.
Parameters:
  • element : String/HTMLElement/Ext.Element
    The element to align to.
  • position : String
    The position to align to.
  • offsets : Array
    (optional) Offset the positioning by [x, y]
  • animate : Boolean/Object
    (optional) True for the default animation or a standard Element animation config object
  • monitorScroll : Boolean/Number
    (optional) True to monitor body scroll and reposition. If this parameter is a number, it is used as the buffer delay (defaults to 50ms).
  • callback : Function
    The function to call after the animation finishes
Returns:
  • Ext.Element
    this
This method is defined by Element.

animate

public function animate( Object args, [Float duration], [Function onComplete], [String easing], [String animType] )
Perform animation on this element.
Parameters:
  • args : Object
    The YUI animation control args
  • duration : Float
    (optional) How long the animation lasts in seconds (defaults to .35)
  • onComplete : Function
    (optional) Function to call when animation completes
  • easing : String
    (optional) Easing method to use (defaults to 'easeOut')
  • animType : String
    (optional) 'run' is the default. Can also be 'color', 'motion', or 'scroll'
Returns:
  • Ext.Element
    this
This method is defined by Element.

appendChild

public function appendChild( String/HTMLElement/Array/Element/CompositeElement el )
Appends the passed element(s) to this element
Parameters:
  • el : String/HTMLElement/Array/Element/CompositeElement
Returns:
  • Ext.Element
    this
This method is defined by Element.

appendTo

public function appendTo( String/HTMLElement/Element el )
Appends this element to the passed element
Parameters:
  • el : String/HTMLElement/Element
    The new parent element
Returns:
  • Ext.Element
    this
This method is defined by Element.

applyStyles

public function applyStyles( String/Object/Function styles )
More flexible version of setStyle for setting style properties.
Parameters:
  • styles : String/Object/Function
    A style specification string, e.g. "width:100px", or object in the form {width:"100px"}, or a function which returns such a specification.
Returns:
  • Ext.Element
    this
This method is defined by Element.

autoHeight

public function autoHeight( [Boolean animate], [Float duration], [Function onComplete], [String easing] )
Measures the element's content height and updates height to match. Note: this function uses setTimeout so the new height may not be available immediately.
Parameters:
  • animate : Boolean
    (optional) Animate the transition (defaults to false)
  • duration : Float
    (optional) Length of the animation in seconds (defaults to .35)
  • onComplete : Function
    (optional) Function to call when animation completes
  • easing : String
    (optional) Easing method to use (defaults to easeOut)
Returns:
  • Ext.Element
    this
This method is defined by Element.

beginMeasure

public function beginMeasure()
Temporarily enables offsets (width,height,x,y) for an element with display:none, use endMeasure() when done.
Parameters:
  • None.
Returns:
  • Ext.Element
    this
This method is defined by Element.

blur

public function blur()
Tries to blur the element. Any exceptions are caught and ignored.
Parameters:
  • None.
Returns:
  • Ext.Element
    this
This method is defined by Element.

boxWrap

public function boxWrap( [String class] )
Wraps the specified element with a special markup/CSS block that renders by default as a gray container with a gradient background, rounded corners and a 4-way shadow.
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
    this
This method is defined by Element.

center

public function center( [String/HTMLElement/Ext.Element centerIn] )
Centers the Element in either the viewport, or another Element.
Parameters:
  • centerIn : String/HTMLElement/Ext.Element
    (optional) The element in which to center the element.
Returns:
  • void
This method is defined by Element.

child

public function child( String selector, [Boolean returnDom] )
Selects a single child at any depth below this element based on the passed CSS selector (the selector should not contain an id).
Parameters:
  • selector : String
    The CSS selector
  • returnDom : Boolean
    (optional) True to return the DOM node instead of Ext.Element (defaults to false)
Returns:
  • HTMLElement/Ext.Element
    The child Ext.Element (or DOM node if returnDom = true)
This method is defined by Element.

clean

public function clean( [Boolean forceReclean] )
Removes worthless text nodes
Parameters:
  • forceReclean : Boolean
    (optional) By default the element keeps track if it has been cleaned already so you can call this over and over. However, if you update the element and need to force a reclean, you can pass true.
Returns:
  • void
This method is defined by Element.

clearOpacity

public function clearOpacity()
Clears any opacity settings from this element. Required in some cases for IE.
Parameters:
  • None.
Returns:
  • Ext.Element
    this
This method is defined by Element.

clearPositioning

public function clearPositioning( [String value] )
Clear positioning back to the default when the document was loaded
Parameters:
  • value : String
    (optional) The value to use for the left,right,top,bottom, defaults to '' (empty string). You could use 'auto'.
Returns:
  • Ext.Element
    this
This method is defined by Element.

clip

public function clip()
Store the current overflow setting and clip overflow on the element - use unclip to remove
Parameters:
  • None.
Returns:
  • Ext.Element
    this
This method is defined by Element.

contains

public function contains( HTMLElement/String el )
Returns true if this element is an ancestor of the passed element
Parameters:
  • el : HTMLElement/String
    The element to check
Returns:
  • Boolean
    True if this element is an ancestor of el, else false
This method is defined by Element.

createChild

public function createChild( Object config, [HTMLElement insertBefore], [Boolean returnDom] )
Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child element.
Parameters:
  • config : Object
    DomHelper element config object. If no tag is specified (e.g., {tag:'input'}) then a div will be automatically generated with the specified attributes.
  • insertBefore : HTMLElement
    (optional) a child element of this element
  • returnDom : Boolean
    (optional) true to return the dom node instead of creating an Element
Returns:
  • Ext.Element
    The new child element
This method is defined by Element.

createProxy

public function createProxy( String/Object config, [String/HTMLElement renderTo], [Boolean matchBox] )
Creates a proxy element of this element
Parameters:
  • config : String/Object
    The class name of the proxy element or a DomHelper config object
  • renderTo : String/HTMLElement
    (optional) The element or element id to render the proxy to (defaults to document.body)
  • matchBox : Boolean
    (optional) True to align and size the proxy to this element now (defaults to false)
Returns:
  • Ext.Element
    The new proxy element
This method is defined by Element.

createShim

public function createShim()
Creates an iframe shim for this element to keep selects and other windowed objects from showing through.
Parameters:
  • None.
Returns:
  • Ext.Element
    The new shim element
This method is defined by Element.

down

public function down( String selector, [Boolean returnDom] )
Selects a single *direct* child based on the passed CSS selector (the selector should not contain an id).
Parameters:
  • selector : String
    The CSS selector
  • returnDom : Boolean
    (optional) True to return the DOM node instead of Ext.Element (defaults to false)
Returns:
  • HTMLElement/Ext.Element
    The child Ext.Element (or DOM node if returnDom = true)
This method is defined by Element.

enableDisplayMode

public function enableDisplayMode( [String display] )
Convenience method for setVisibilityMode(Element.DISPLAY)
Parameters:
  • display : String
    (optional) What to set display to when visible
Returns:
  • Ext.Element
    this
This method is defined by Element.

endMeasure

public function endMeasure()
Restores displays to before beginMeasure was called
Parameters:
  • None.
Returns:
  • Ext.Element
    this
This method is defined by Element.

findParent

public function findParent( String selector, [Number/String/HTMLElement/Element maxDepth], [Boolean returnEl] )
Looks at this node and then at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child)
Parameters:
  • selector : String
    The simple selector to test
  • maxDepth : Number/String/HTMLElement/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)
This method is defined by Element.

findParentNode

public function findParentNode( String selector, [Number/String/HTMLElement/Element maxDepth], [Boolean returnEl] )
Looks at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child)
Parameters:
  • selector : String
    The simple selector to test
  • maxDepth : Number/String/HTMLElement/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)
This method is defined by Element.

fitToParent

public function fitToParent( [Boolean monitorResize], [String/HTMLElment/Element targetParent] )
Sizes this element to its parent element's dimensions performing neccessary box adjustments.
Parameters:
  • monitorResize : Boolean
    (optional) If true maintains the fit when the browser window is resized.
  • targetParent : String/HTMLElment/Element
    (optional) The target parent, default to the parentNode.
Returns:
  • Ext.Element
    this
This method is defined by Element.

focus

public function focus()
Tries to focus the element. Any exceptions are caught and ignored.
Parameters:
  • None.
Returns:
  • Ext.Element
    this
This method is defined by Element.

getAlignToXY

public function getAlignToXY( String/HTMLElement/Ext.Element element, String position, [Array offsets] )
Gets the x,y coordinates to align this element with another element. See alignTo for more info on the supported position values.
Parameters:
  • element : String/HTMLElement/Ext.Element
    The element to align to.
  • position : String
    The position to align to.
  • offsets : Array
    (optional) Offset the positioning by [x, y]
Returns:
  • Array
    [x, y]
This method is defined by Element.

getAnchorXY

public function getAnchorXY( [String anchor], [Object size], [Boolean local] )
Gets the x,y coordinates specified by the anchor position on the element.
Parameters:
  • anchor : String
    (optional) The specified anchor position (defaults to "c"). See alignTo for details on supported anchor positions.
  • 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)
  • local : Boolean
    (optional) True to get the local (element top/left-relative) anchor position instead of page coordinates
Returns:
  • Array
    [x, y] An array containing the element's x and y coordinates
This method is defined by Element.

getAttributeNS

public function getAttributeNS( String namespace, String name )
Returns the value of a namespaced attribute from the element's underlying DOM node.
Parameters:
  • namespace : String
    The namespace in which to look for the attribute
  • name : String
    The attribute name
Returns:
  • String
    The attribute value
This method is defined by Element.

getBorderWidth

public function getBorderWidth( String side )
Gets the width of the border(s) for the specified side(s)
Parameters:
  • side : String
    Can be t, l, r, b or any combination of those to add multiple values. For example, passing lr would get the border (l)eft width + the border (r)ight width.
Returns:
  • Number
    The width of the sides passed added together
This method is defined by Element.

getBottom

public function getBottom( Boolean local )
Gets the bottom Y coordinate of the element (element Y position + element height)
Parameters:
  • local : Boolean
    True to get the local css position instead of page coordinate
Returns:
  • Number
This method is defined by Element.

getBox

public function getBox( [Boolean contentBox], [Boolean local] )
Return a box {x, y, width, height} that can be used to set another elements size/location to match this element.
Parameters:
  • contentBox : Boolean
    (optional) If true a box for the content of the element is returned.
  • local : Boolean
    (optional) If true the element's left and top are returned instead of page x/y.
Returns:
  • Object
    box An object in the format {x, y, width, height}
This method is defined by Element.

getCenterXY

public function getCenterXY()
Calculates the x, y to center this element on the screen
Parameters:
  • None.
Returns:
  • Array
    The x, y values [x, y]
This method is defined by Element.

getColor

public function getColor( String attr, String defaultValue, [String prefix] )
Return the CSS color for the specified CSS attribute. rgb, 3 digit (like #fff) and valid values are convert to standard 6 digit hex color.
Parameters:
  • attr : String
    The css attribute
  • defaultValue : String
    The default value to use when a valid color isn't found
  • prefix : String
    (optional) defaults to #. Use an empty string when working with YUI color anims.
Returns:
  • void
This method is defined by Element.

getComputedHeight

public function getComputedHeight()
Returns either the offsetHeight or the height of this element based on CSS height adjusted by padding or b