Package: | Ext |
Defined In: | Element.style.js |
Class: | Element |
Subclasses: | Layer |
Extends: | Object |
Encapsulates a DOM element, adding simple DOM manipulation facilities, normalizing for browser differences.
All instances of this class inherit the methods of Ext.Fx making visual effects easily available to all DOM elements.
Note that the events documented in this class are not Ext events, they encapsulate browser events. To access the underlying browser event, see Ext.EventObject.browserEvent. Some older browsers may not support the full range of events. Which events are supported is beyond the control of ExtJs.
Usage:// by id
var el = Ext.get("my-div");
// by DOM element reference
var el = Ext.get(myDivElement);
AnimationsWhen an element is manipulated, by default there is no animation.
var el = Ext.get("my-div");
// no animation
el.setWidth(100);
Many of the functions for manipulating an element have an optional "animate" parameter. This parameter can be specified as boolean (true) for default animation effects.
// default animation
el.setWidth(100, true);
To configure the effects, an object literal with animation options to use as the Element animation configuration object can also be specified. Note that the supported Element animation configuration options are a subset of the Ext.Fx animation options specific to Fx effects. The supported Element animation configuration options are:
Option Default Description --------- -------- --------------------------------------------- duration .35 The duration of the animation in seconds easing easeOut The easing method callback none A function to execute when the anim completes scope this The scope (this) of the callback function
// Element animation options object
var opt = {
duration: 1,
easing: 'elasticIn',
callback: this.foo,
scope: this
};
// animation with some options set
el.setWidth(100, opt);
The Element animation object being used for the animation will be set on the options object as "anim", which allows you to stop or manipulate the animation. Here is an example:
// using the "anim" property to get the Anim object
if(opt.anim.isAnimated()){
opt.anim.stop();
}
Also see the animate method for another animation technique.
Composite (Collections of) Elements
For working with collections of Elements, see Ext.CompositeElement
Property | Defined By | |
---|---|---|
DISPLAY : Number Visibility mode constant for use with setVisibilityMode. Use display to hide element | Element | |
VISIBILITY : Number Visibility mode constant for use with setVisibilityMode. Use visibility to hide element | Element | |
autoBoxAdjust : Object true to automatically adjust width and height settings for box-model issues (default to true) | Element | |
defaultUnit : String The default unit to append to CSS values where a unit isn't provided (defaults to px). | Element | |
dom : HTMLElement The DOM element | Element | |
id : String The DOM element ID | Element | |
originalDisplay : String The element's default display mode (defaults to "") | Element |
Method | Defined By | |
---|---|---|
Element( String/HTMLElement element , [Boolean forceNew ] )
Create a new Element directly. Create a new Element directly. Parameters:
| Element | |
addClass( String/Array className )
:
Ext.ElementAdds one or more CSS classes to the element. Duplicate classes are automatically filtered out. Adds one or more CSS classes to the element. Duplicate classes are automatically filtered out. Parameters:
| Element | |
addClassOnClick( String className )
:
Ext.ElementSets up event handlers to add and remove a css class when the mouse is down and then up on this element (a click effe... Sets up event handlers to add and remove a css class when the mouse is down and then up on this element (a click effect) Parameters:
| Element | |
addClassOnFocus( String className )
:
Ext.ElementSets up event handlers to add and remove a css class when this element has the focus Sets up event handlers to add and remove a css class when this element has the focus Parameters:
| Element | |
addClassOnOver( String className )
:
Ext.ElementSets up event handlers to add and remove a css class when the mouse is over this element Sets up event handlers to add and remove a css class when the mouse is over this element Parameters:
| Element | |
addKeyListener( Number/Array/Object/String key , Function fn , [Object scope ] )
:
Ext.KeyMapConvenience method for constructing a KeyMap Convenience method for constructing a KeyMap Parameters:
| Element | |
addKeyMap( Object config )
:
Ext.KeyMapCreates a KeyMap for this element Creates a KeyMap for this element Parameters:
| Element | |
addListener( String eventName , Function fn , [Object scope ], [Object options ] )
:
Ext.ElementAppends an event handler to this element. The shorthand version on is equivalent. Appends an event handler to this element. The shorthand version on is equivalent. Parameters:
| Element | |
alignTo( Mixed element , String position , [Array offsets ], [Boolean/Object animate ] )
:
Ext.ElementAligns this element with another element relative to the specified anchor points. If the other element is the
documen... Aligns this element with another element relative to the specified anchor points. If the other element is the
document it aligns it to the viewport.
The position parameter is optional, and can be specified in any one of the following formats:
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 cornerExample Usage:
Parameters:
| Element | |
anchorTo( Mixed element , String position , [Array offsets ], [Boolean/Object animate ], [Boolean/Number monitorScroll ], Function callback )
:
Ext.ElementAnchors an element to another element and realigns it when the window is resized. Anchors an element to another element and realigns it when the window is resized. Parameters:
| Element | |
animate( Object args , [Float duration ], [Function onComplete ], [String easing ], [String animType ] )
:
Ext.ElementPerform custom animation on this element.
<ul class="mdetail-params">
Animation Properties
The Animation Control Obje... Perform custom animation on this element.
The Animation Control Object enables gradual transitions for any member of an element's style object that takes a numeric value including but not limited to these properties: Each Animation Property is a config object with optional properties: * do not specify both to and by for an animation property The supported animation types: Parameters:
| Element | |
appendChild( String/HTMLElement/Array/Element/CompositeElement el )
:
Ext.ElementAppends the passed element(s) to this element Appends the passed element(s) to this element Parameters:
| Element | |
appendTo( Mixed el )
:
Ext.ElementAppends this element to the passed element Appends this element to the passed element Parameters:
| Element | |
applyStyles( String/Object/Function styles )
:
Ext.ElementMore flexible version of setStyle for setting style properties. More flexible version of setStyle for setting style properties. Parameters:
| Element | |
autoHeight( [Boolean animate ], [Float duration ], [Function onComplete ], [String easing ] )
:
Ext.ElementMeasures the element's content height and updates height to match. Note: this function uses setTimeout so
the new hei... 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:
| Element | |
blur()
:
Ext.Element Tries to blur the element. Any exceptions are caught and ignored. Tries to blur the element. Any exceptions are caught and ignored. Parameters:
| Element | |
boxWrap( [String class ] )
:
Ext.ElementWraps the specified element with a special 9 element markup/CSS block that renders by default as
a gray container wit... Wraps the specified element with a special 9 element markup/CSS block that renders by default as a gray container with a gradient background, rounded corners and a 4-way shadow. This special markup is used throughout Ext when box wrapping elements (Ext.Button, Ext.Panel when frame=true, Ext.Window). The markup is of this form:
Example usage:
Parameters:
| Element | |
center( [Mixed centerIn ] )
:
voidCenters the Element in either the viewport, or another Element. Centers the Element in either the viewport, or another Element. Parameters:
| Element | |
child( String selector , [Boolean returnDom ] )
:
HTMLElement/Ext.ElementSelects a single child at any depth below this element based on the passed CSS selector (the selector should not cont... Selects a single child at any depth below this element based on the passed CSS selector (the selector should not contain an id). Parameters:
| Element | |
clean( [Boolean forceReclean ] )
:
voidRemoves worthless text nodes Removes worthless text nodes Parameters:
| Element | |
clearOpacity()
:
Ext.Element Clears any opacity settings from this element. Required in some cases for IE. Clears any opacity settings from this element. Required in some cases for IE. Parameters:
| Element | |
clearPositioning( [String value ] )
:
Ext.ElementClear positioning back to the default when the document was loaded Clear positioning back to the default when the document was loaded Parameters:
| Element | |
clip()
:
Ext.Element Store the current overflow setting and clip overflow on the element - use unclip to remove Store the current overflow setting and clip overflow on the element - use unclip to remove Parameters:
| Element | |
contains( HTMLElement/String el )
:
BooleanReturns true if this element is an ancestor of the passed element Returns true if this element is an ancestor of the passed element Parameters:
| Element | |
createChild( Object config , [HTMLElement insertBefore ], [Boolean returnDom ] )
:
Ext.ElementCreates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child e... Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child element. Parameters:
| Element | |
createProxy( String/Object config , [String/HTMLElement renderTo ], [Boolean matchBox ] )
:
Ext.ElementCreates a proxy element of this element Creates a proxy element of this element Parameters:
| Element | |
createShim()
:
Ext.Element Creates an iframe shim for this element to keep selects and other windowed objects from
showing through. Creates an iframe shim for this element to keep selects and other windowed objects from
showing through. Parameters:
| Element | |
down( String selector , [Boolean returnDom ] )
:
HTMLElement/Ext.ElementSelects a single *direct* child based on the passed CSS selector (the selector should not contain an id). Selects a single *direct* child based on the passed CSS selector (the selector should not contain an id). Parameters:
| Element | |
enableDisplayMode( [String display ] )
:
Ext.ElementConvenience method for setVisibilityMode(Element.DISPLAY) Convenience method for setVisibilityMode(Element.DISPLAY) Parameters:
| Element | |
findParent( String selector , [Number/Mixed maxDepth ], [Boolean returnEl ] )
:
HTMLElementLooks at this node and then at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:fi... Looks at this node and then at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child) Parameters:
| Element | |
findParentNode( String selector , [Number/Mixed maxDepth ], [Boolean returnEl ] )
:
HTMLElementLooks at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child) Looks at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child) Parameters:
| Element | |
first( [String selector ], [Boolean returnDom ] )
:
Ext.Element/HTMLElementGets the first child, skipping text nodes Gets the first child, skipping text nodes Parameters:
| Element | |
fly( String/HTMLElement el , [String named ] )
:
ElementGets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to t... Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element - the dom node can be overwritten by other code. Shorthand of Ext.Element.fly Use this to make one-time references to DOM elements which are not going to be accessed again either by application code, or by Ext's classes. If accessing an element which will be processed regularly, then Ext.get will be more appropriate to take advantage of the caching provided by the Ext.Element class. Parameters:
| Element | |
focus( [Number defer ] )
:
Ext.ElementTries to focus the element. Any exceptions are caught and ignored. Tries to focus the element. Any exceptions are caught and ignored. Parameters:
| Element | |
get( Mixed el )
:
Element<static> Retrieves Ext.Element objects.
This method does not retrieve Components. This method
retrieves Ext.Element objects wh... <static> Retrieves Ext.Element objects.
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.ComponentMgr.get. Uses simple caching to consistently return the same object. Automatically fixes if an object was recreated with the same id via AJAX or DOM. Parameters:
| Element | |
getAlignToXY( Mixed element , String position , [Array offsets ] )
:
ArrayGets the x,y coordinates to align this element with another element. See alignTo for more info on the
supported posit... Gets the x,y coordinates to align this element with another element. See alignTo for more info on the
supported position values. Parameters:
| Element | |
getAnchorXY( [String anchor ], [Boolean local ], [Object size ] )
:
ArrayGets the x,y coordinates specified by the anchor position on the element. Gets the x,y coordinates specified by the anchor position on the element. Parameters:
| Element | |
getAttribute( String name , [String namespace ] )
:
StringReturns the value of an attribute from the element's underlying DOM node. Returns the value of an attribute from the element's underlying DOM node. Parameters:
| Element | |
getAttributeNS( String namespace , String name )
:
StringReturns the value of a namespaced attribute from the element's underlying DOM node. Returns the value of a namespaced attribute from the element's underlying DOM node. Parameters:
| Element | |
getBorderWidth( String side )
:
NumberGets the width of the border(s) for the specified side(s) Gets the width of the border(s) for the specified side(s) Parameters:
| Element | |
getBottom( Boolean local )
:
NumberGets the bottom Y coordinate of the element (element Y position + element height) Gets the bottom Y coordinate of the element (element Y position + element height) Parameters:
| Element | |
getBox( [Boolean contentBox ], [Boolean local ] )
:
ObjectReturn an object defining the area of this Element which can be passed to setBox to
set another Element's size/locati... Return an object defining the area of this Element which can be passed to setBox to
set another Element's size/location to match this element. Parameters:
| Element | |
getCenterXY()
:
Array Calculates the x, y to center this element on the screen Calculates the x, y to center this element on the screen Parameters:
| Element | |
getColor( String attr , String defaultValue , [String prefix ] )
:
voidReturn the CSS color for the specified CSS attribute. rgb, 3 digit (like #fff) and valid values
are convert to standa... Return the CSS color for the specified CSS attribute. rgb, 3 digit (like #fff) and valid values
are convert to standard 6 digit hex color. Parameters:
| Element | |
getComputedHeight()
:
Number Returns either the offsetHeight or the height of this element based on CSS height adjusted by padding or borders
when... Returns either the offsetHeight or the height of this element based on CSS height adjusted by padding or borders
when needed to simulate offsetHeight when offsets aren't available. This may not work on display:none elements
if a height has not been set using CSS. Parameters:
| Element | |
getComputedWidth()
:
Number Returns either the offsetWidth or the width of this element based on CSS width adjusted by padding or borders
when ne... Returns either the offsetWidth or the width of this element based on CSS width adjusted by padding or borders
when needed to simulate offsetWidth when offsets aren't available. This may not work on display:none elements
if a width has not been set using CSS. Parameters:
| Element | |
getFrameWidth( String sides )
:
NumberReturns the sum width of the padding and borders for the passed "sides". See getBorderWidth()
for more infor... Returns the sum width of the padding and borders for the passed "sides". See getBorderWidth()
for more information about the sides. Parameters:
| Element | |
getHeight( [Boolean contentHeight ] )
:
NumberReturns the offset height of the element Returns the offset height of the element Parameters:
| Element | |
getLeft( Boolean local )
:
NumberGets the left X coordinate Gets the left X coordinate Parameters:
| Element | |
getMargins( [String sides ] )
:
Object/NumberReturns an object with properties top, left, right and bottom representing the margins of this element unless sides i... Returns an object with properties top, left, right and bottom representing the margins of this element unless sides is passed,
then it returns the calculated width of the sides (see getPadding) Parameters:
| Element | |
getOffsetsTo( Mixed element )
:
ArrayReturns the offsets of this element from the passed element. Both element must be part of the DOM tree and not have d... Returns the offsets of this element from the passed element. Both element must be part of the DOM tree and not have display:none to have page coordinates. Parameters:
| Element | |
getPadding( String side )
:
NumberGets the width of the padding(s) for the specified side(s) Gets the width of the padding(s) for the specified side(s) Parameters:
| Element | |
getPositioning()
:
Object Gets an object with all CSS positioning properties. Useful along with setPostioning to get
snapshot before performing... Gets an object with all CSS positioning properties. Useful along with setPostioning to get
snapshot before performing an update and then restoring the element. Parameters:
| Element | |
getRegion()
:
Region Returns the region of the given element.
The element must be part of the DOM tree to have a region (display:none or e... Returns the region of the given element.
The element must be part of the DOM tree to have a region (display:none or elements not appended return false). Parameters:
| Element | |
getRight( Boolean local )
:
NumberGets the right X coordinate of the element (element X position + element width) Gets the right X coordinate of the element (element X position + element width) Parameters:
| Element | |
getScroll()
:
Object Returns the current scroll position of the element. Returns the current scroll position of the element. Parameters:
| Element | |
getSize( [Boolean contentSize ] )
:
ObjectReturns the size of the element. Returns the size of the element. Parameters:
| Element | |
getStyle( String property )
:
StringNormalizes currentStyle and computedStyle. Normalizes currentStyle and computedStyle. Parameters:
| Element | |
getStyleSize()
:
void Returns the dimensions of the element available to lay content out in.
getStyleSize utilizes prefers style sizing if ... Returns the dimensions of the element available to lay content out in. getStyleSize utilizes prefers style sizing if present, otherwise it chooses the larger of offsetHeight/clientHeight and offsetWidth/clientWidth. To obtain the size excluding scrollbars, use getViewSize Sizing of the document body is handled at the adapter level which handles special cases for IE and strict modes, etc. Parameters:
| Element | |
getStyles( String style1 , String style2 , String etc. )
:
ObjectReturns an object with properties matching the styles requested.
For example, el.getStyles('color', 'font-size', 'wid... Returns an object with properties matching the styles requested.
For example, el.getStyles('color', 'font-size', 'width') might return
{'color': '#FFFFFF', 'font-size': '13px', 'width': '100px'}. Parameters:
| Element | |
getTextWidth( String text , [Number min ], [Number max ] )
:
NumberReturns the width in pixels of the passed text, or the width of the text in this Element. Returns the width in pixels of the passed text, or the width of the text in this Element. Parameters:
| Element | |
getTop( Boolean local )
:
NumberGets the top Y coordinate Gets the top Y coordinate Parameters:
| Element | |
getUpdater()
:
Ext.Updater Gets this element's Updater Gets this element's Updater Parameters:
| Element | |
getValue( Boolean asNumber )
:
String/NumberReturns the value of the "value" attribute Returns the value of the "value" attribute Parameters:
| Element | |
getViewSize()
:
void Returns the dimensions of the element available to lay content out in.
If the element (or any ancestor element) has C... Returns the dimensions of the element available to lay content out in.
If the element (or any ancestor element) has CSS style
getViewSize utilizes clientHeight/clientWidth which excludes sizing of scrollbars.
To obtain the size including scrollbars, use getStyleSize
Sizing of the document body is handled at the adapter level which handles special cases for IE and strict modes, etc.Parameters:
| Element | |
getWidth( [Boolean contentWidth ] )
:
NumberReturns the offset width of the element Returns the offset width of the element Parameters:
| Element | |
getX()
:
Number Gets the current X position of the element based on page coordinates. Element must be part of the DOM tree to have p... Gets the current X position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false). Parameters:
| Element | |
getXY()
:
Array Gets the current position of the element based on page coordinates. Element must be part of the DOM tree to have pag... Gets the current position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false). Parameters:
| Element | |
getY()
:
Number Gets the current Y position of the element based on page coordinates. Element must be part of the DOM tree to have p... Gets the current Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false). Parameters:
| Element | |
hasClass( String className )
:
BooleanChecks if the specified CSS class exists on this element's DOM node. Checks if the specified CSS class exists on this element's DOM node. Parameters:
| Element | |
hide( [Boolean/Object animate ] )
:
Ext.ElementHide this element - Uses display mode to determine whether to use "display" or "visibility". See setVisible. Hide this element - Uses display mode to determine whether to use "display" or "visibility". See setVisible. Parameters:
| Element | |
hover( Function overFn , Function outFn , [Object scope ], [Object options ] )
:
Ext.ElementSets up event handlers to call the passed functions when the mouse is moved into and out of the Element. Sets up event handlers to call the passed functions when the mouse is moved into and out of the Element. Parameters:
| Element | |
initDD( String group , Object config , Object overrides )
:
Ext.dd.DDInitializes a Ext.dd.DD drag drop object for this element. Initializes a Ext.dd.DD drag drop object for this element. Parameters:
| Element | |
initDDProxy( String group , Object config , Object overrides )
:
Ext.dd.DDProxyInitializes a Ext.dd.DDProxy object for this element. Initializes a Ext.dd.DDProxy object for this element. Parameters:
| Element | |
initDDTarget( String group , Object config , Object overrides )
:
Ext.dd.DDTargetInitializes a Ext.dd.DDTarget object for this element. Initializes a Ext.dd.DDTarget object for this element. Parameters:
| Element | |
insertAfter( Mixed el )
:
Ext.ElementInserts this element after the passed element in the DOM Inserts this element after the passed element in the DOM Parameters:
| Element | |
insertBefore( Mixed el )
:
Ext.ElementInserts this element before the passed element in the DOM Inserts this element before the passed element in the DOM Parameters:
| Element | |
insertFirst( Mixed/Object el )
:
Ext.ElementInserts (or creates) an element (or DomHelper config) as the first child of this element Inserts (or creates) an element (or DomHelper config) as the first child of this element Parameters:
| Element | |
insertHtml( String where , String html , [Boolean returnEl ] )
:
HTMLElement/Ext.ElementInserts an html fragment into this element Inserts an html fragment into this element Parameters:
| Element | |
insertSibling( Mixed/Object/Array el , [String where ], [Boolean returnDom ] )
:
Ext.ElementInserts (or creates) the passed element (or DomHelper config) as a sibling of this element Inserts (or creates) the passed element (or DomHelper config) as a sibling of this element Parameters:
| Element | |
is( String selector )
:
BooleanReturns true if this element matches the passed simple selector (e.g. div.some-class or span:first-child) Returns true if this element matches the passed simple selector (e.g. div.some-class or span:first-child) Parameters:
| Element | |
isBorderBox()
:
Boolean Tests various css rules/browsers to determine if this element uses a border box Tests various css rules/browsers to determine if this element uses a border box Parameters:
| Element | |
isDisplayed()
:
Boolean Returns true if display is not "none" Returns true if display is not "none" Parameters:
| Element | |
isMasked()
:
Boolean Returns true if this element is masked Returns true if this element is masked Parameters:
| Element | |
isScrollable()
:
Boolean Returns true if this element is scrollable. Returns true if this element is scrollable. Parameters:
| Element | |
isVisible( [Boolean deep ] )
:
BooleanChecks whether the element is currently visible using both visibility and display properties. Checks whether the element is currently visible using both visibility and display properties. Parameters:
| Element | |
last( [String selector ], [Boolean returnDom ] )
:
Ext.Element/HTMLElementGets the last child, skipping text nodes Gets the last child, skipping text nodes Parameters:
| Element | |
load()
:
Ext.Element Direct access to the Updater Ext.Updater.update method. The method takes the same object
parameter as Ext.Updater.upd... Direct access to the Updater Ext.Updater.update method. The method takes the same object
parameter as Ext.Updater.update Parameters:
| Element | |
mask( [String msg ], [String msgCls ] )
:
ElementPuts a mask over this element to disable user interaction. Requires core.css.
This method can only be applied to elem... Puts a mask over this element to disable user interaction. Requires core.css.
This method can only be applied to elements which accept child nodes. Parameters:
| Element | |
move( String direction , Number distance , [Boolean/Object animate ] )
:
Ext.ElementMove this element relative to its current position. Move this element relative to its current position. Parameters:
| Element | |
moveTo( Number x , Number y , [Boolean/Object animate ] )
:
Ext.ElementSets the position of the element in page coordinates, regardless of how the element is positioned.
The element must b... Sets the position of the element in page coordinates, regardless of how the element is positioned.
The element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false). Parameters:
| Element | |
next( [String selector ], [Boolean returnDom ] )
:
Ext.Element/HTMLElementGets the next sibling, skipping text nodes Gets the next sibling, skipping text nodes Parameters:
| Element | |
on( String eventName , Function fn , [Object scope ], [Object options ] )
:
voidAppends an event handler (shorthand for addListener). Appends an event handler (shorthand for addListener). Parameters:
| Element | |
parent( [String selector ], [Boolean returnDom ] )
:
Ext.Element/HTMLElementGets the parent node for this element, optionally chaining up trying to match a selector Gets the parent node for this element, optionally chaining up trying to match a selector Parameters:
| Element | |
position( [String pos ], [Number zIndex ], [Number x ], [Number y ] )
:
voidInitializes positioning on this element. If a desired position is not passed, it will make the
the element positioned... Initializes positioning on this element. If a desired position is not passed, it will make the
the element positioned relative IF it is not already positioned. Parameters:
| Element | |
prev( [String selector ], [Boolean returnDom ] )
:
Ext.Element/HTMLElementGets the previous sibling, skipping text nodes Gets the previous sibling, skipping text nodes Parameters:
| Element | |
purgeAllListeners()
:
Ext.Element Recursively removes all previous added listeners from this element and its children Recursively removes all previous added listeners from this element and its children Parameters:
| Element | |
query( String selector )
:
ArraySelects child nodes based on the passed CSS selector (the selector should not contain an id). Selects child nodes based on the passed CSS selector (the selector should not contain an id). Parameters:
| Element | |
radioClass( String/Array className )
:
Ext.ElementAdds one or more CSS classes to this element and removes the same class(es) from all siblings. Adds one or more CSS classes to this element and removes the same class(es) from all siblings. Parameters:
| Element | |
relayEvent( String eventName , Object object )
:
voidCreate an event handler on this element such that when the event fires and is handled by this element,
it will be rel... Create an event handler on this element such that when the event fires and is handled by this element,
it will be relayed to another object (i.e., fired again as if it originated from that object instead). Parameters:
| Element | |
remove()
:
void Removes this element's dom reference. Note that event and cache removal is handled at Ext.removeNode Removes this element's dom reference. Note that event and cache removal is handled at Ext.removeNode Parameters:
| Element | |
removeAllListeners()
:
Ext.Element Removes all previous added listeners from this element Removes all previous added listeners from this element Parameters:
| Element | |
removeAnchor()
:
Ext.Element Remove any anchor to this element. See anchorTo. Remove any anchor to this element. See anchorTo. Parameters:
| Element | |
removeClass( String/Array className )
:
Ext.ElementRemoves one or more CSS classes from the element. Removes one or more CSS classes from the element. Parameters:
| Element | |
removeListener( String eventName , Function fn , Object scope )
:
Ext.ElementRemoves an event handler from this element. The shorthand version un is equivalent.
Note: if a scope was explicitly ... Removes an event handler from this element. The shorthand version un is equivalent.
Note: if a scope was explicitly specified when adding the
listener, the same scope must be specified here.
Example:
Parameters:
| Element | |
repaint()
:
Ext.Element Forces the browser to repaint this element Forces the browser to repaint this element Parameters:
| Element | |
replace( Mixed el )
:
Ext.ElementReplaces the passed element with this element Replaces the passed element with this element Parameters:
| Element | |
replaceClass( String oldClassName , String newClassName )
:
Ext.ElementReplaces a CSS class on the element with another. If the old name does not exist, the new name will simply be added. Replaces a CSS class on the element with another. If the old name does not exist, the new name will simply be added. Parameters:
| Element | |
replaceWith( Mixed/Object el )
:
Ext.ElementReplaces this element with the passed element Replaces this element with the passed element Parameters:
| Element | |
scroll( String direction , Number distance , [Boolean/Object animate ] )
:
BooleanScrolls this element the specified direction. Does bounds checking to make sure the scroll is
within this element's s... Scrolls this element the specified direction. Does bounds checking to make sure the scroll is
within this element's scrollable range. Parameters:
| Element | |
scrollIntoView( [Mixed container ], [Boolean hscroll ] )
:
Ext.ElementScrolls this element into view within the passed container. Scrolls this element into view within the passed container. Parameters:
| Element | |
scrollTo( String side , Number value , [Boolean/Object animate ] )
:
ElementScrolls this element the specified scroll point. It does NOT do bounds checking so if you scroll to a weird value it ... Scrolls this element the specified scroll point. It does NOT do bounds checking so if you scroll to a weird value it will try to do it. For auto bounds checking, use scroll(). Parameters:
| Element | |
select( String/Array selector , [Boolean unique ], [HTMLElement/String root ] )
:
CompositeElementLite/CompositeElementSelects elements based on the passed CSS selector to enable Element methods
to be applied to many related elements in... 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. Parameters:
| Element | |
set( Object o , [Boolean useSet ] )
:
Ext.ElementSets the passed attributes as attributes of this element (a style attribute can be a string, object or function) Sets the passed attributes as attributes of this element (a style attribute can be a string, object or function) Parameters:
| Element | |
setBottom( String bottom )
:
Ext.ElementSets the element's CSS bottom style. Sets the element's CSS bottom style. Parameters:
| Element | |
setBounds( Number x , Number y , Mixed width , Mixed height , [Boolean/Object animate ] )
:
Ext.ElementSets the element's position and size in one shot. If animation is true then width, height, x and y will be animated c... Sets the element's position and size in one shot. If animation is true then width, height, x and y will be animated concurrently. Parameters:
| Element | |
setBox( Object box , [Boolean adjust ], [Boolean/Object animate ] )
:
Ext.ElementSets the element's box. Use getBox() on another element to get a box obj. If animate is true then width, height, x an... Sets the element's box. Use getBox() on another element to get a box obj. If animate is true then width, height, x and y will be animated concurrently. Parameters:
| Element | |
setDisplayed( Mixed value )
:
Ext.ElementSets the CSS display property. Uses originalDisplay if the specified value is a boolean true. Sets the CSS display property. Uses originalDisplay if the specified value is a boolean true. Parameters:
| Element | |
setHeight( Mixed height , [Boolean/Object animate ] )
:
Ext.ElementSet the height of this Element.
// change the height to 200px and animate with default configuration
Ext.fly('element... Set the height of this Element.
Parameters:
| Element | |
setLeft( String left )
:
Ext.ElementSets the element's left position directly using CSS style (instead of setX). Sets the element's left position directly using CSS style (instead of setX). Parameters:
| Element | |
setLeftTop( String left , String top )
:
Ext.ElementQuick set left and top adding default units Quick set left and top adding default units Parameters:
| Element | |
setLocation( Number x , Number y , [Boolean/Object animate ] )
:
Ext.ElementSets the position of the element in page coordinates, regardless of how the element is positioned.
The element must b... Sets the position of the element in page coordinates, regardless of how the element is positioned.
The element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false). Parameters:
| Element | |
setOpacity( Float opacity , [Boolean/Object animate ] )
:
Ext.ElementSet the opacity of the element Set the opacity of the element Parameters:
| Element | |
setPositioning( Object posCfg )
:
Ext.ElementSet positioning with an object returned by getPositioning(). Set positioning with an object returned by getPositioning(). Parameters:
| Element | |
setRegion( Ext.lib.Region region , [Boolean/Object animate ] )
:
Ext.ElementSets the element's position and size the specified region. If animation is true then width, height, x and y will be a... Sets the element's position and size the specified region. If animation is true then width, height, x and y will be animated concurrently. Parameters:
| Element | |
setRight( String right )
:
Ext.ElementSets the element's CSS right style. Sets the element's CSS right style. Parameters:
| Element | |
setSize( Mixed width , Mixed height , [Boolean/Object animate ] )
:
Ext.ElementSet the size of this Element. If animation is true, both width and height will be animated concurrently. Set the size of this Element. If animation is true, both width and height will be animated concurrently. Parameters:
| Element | |
setStyle( String/Object property , [String value ] )
:
Ext.ElementWrapper for setting style properties, also takes single object parameter of multiple styles. Wrapper for setting style properties, also takes single object parameter of multiple styles. Parameters:
| Element | |
setTop( String top )
:
Ext.ElementSets the element's top position directly using CSS style (instead of setY). Sets the element's top position directly using CSS style (instead of setY). Parameters:
| Element | |
setVisibilityMode( Number visMode )
:
Ext.ElementSets the element's visibility mode. When setVisible() is called it
will use this to determine whether to set the visi... Sets the element's visibility mode. When setVisible() is called it
will use this to determine whether to set the visibility or the display property. Parameters:
| Element | |
setVisible( Boolean visible , [Boolean/Object animate ] )
:
Ext.ElementSets the visibility of the element (see details). If the visibilityMode is set to Element.DISPLAY, it will use
the di... Sets the visibility of the element (see details). If the visibilityMode is set to Element.DISPLAY, it will use
the display property to hide the element, otherwise it uses visibility. The default is to hide and show using the visibility property. Parameters:
| Element | |
setWidth( Mixed width , [Boolean/Object animate ] )
:
Ext.ElementSet the width of this Element. Set the width of this Element. Parameters:
| Element | |
setX( Number The , [Boolean/Object animate ] )
:
Ext.ElementSets the X position of the element based on page coordinates. Element must be part of the DOM tree to have page coor... Sets the X position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false). Parameters:
| Element | |
setXY( Array pos , [Boolean/Object animate ] )
:
Ext.ElementSets the position of the element in page coordinates, regardless of how the element is positioned.
The element must b... Sets the position of the element in page coordinates, regardless of how the element is positioned.
The element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false). Parameters:
| Element | |
setY( Number The , [Boolean/Object animate ] )
:
Ext.ElementSets the Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coor... Sets the Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false). Parameters:
| Element | |
show( [Boolean/Object animate ] )
:
Ext.ElementShow this element - Uses display mode to determine whether to use "display" or "visibility". See setVisible. Show this element - Uses display mode to determine whether to use "display" or "visibility". See setVisible. Parameters:
| Element | |
swallowEvent( String/Array eventName , [Boolean preventDefault ] )
:
Ext.ElementStops the specified event(s) from bubbling and optionally prevents the default action Stops the specified event(s) from bubbling and optionally prevents the default action Parameters:
| Element | |
toggle( [Boolean/Object animate ] )
:
Ext.ElementToggles the element's visibility or display, depending on visibility mode. Toggles the element's visibility or display, depending on visibility mode. Parameters:
| Element | |
toggleClass( String className )
:
Ext.ElementToggles the specified CSS class on this element (removes it if it already exists, otherwise adds it). Toggles the specified CSS class on this element (removes it if it already exists, otherwise adds it). Parameters:
| Element | |
translatePoints( Number/Array x , [Number y ] )
:
ObjectTranslates the passed page coordinates into left/top css values for this element Translates the passed page coordinates into left/top css values for this element Parameters:
| Element | |
un( String eventName , Function fn , Object scope )
:
Ext.ElementRemoves an event handler from this element (see removeListener for additional notes). Removes an event handler from this element (see removeListener for additional notes). Parameters:
| Element | |
unclip()
:
Ext.Element Return clipping (overflow) to original clipping before clip was called Return clipping (overflow) to original clipping before clip was called Parameters:
| Element | |
unmask()
:
void Removes a previously applied mask. Removes a previously applied mask. Parameters:
| Element | |
unselectable()
:
Ext.Element Disables text selection for this element (normalized across browsers) Disables text selection for this element (normalized across browsers) Parameters:
| Element | |
up( String selector , [Number/Mixed maxDepth ] )
:
Ext.ElementWalks up the dom looking for a parent node that matches the passed simple selector (e.g. div.some-class or span:first... Walks up the dom looking for a parent node that matches the passed simple selector (e.g. div.some-class or span:first-child).
This is a shortcut for findParentNode() that always returns an Ext.Element. Parameters:
| Element | |
update( String html , [Boolean loadScripts ], [Function callback ] )
:
Ext.ElementUpdate the innerHTML of this element, optionally searching for and processing scripts Update the innerHTML of this element, optionally searching for and processing scripts Parameters:
| Element | |
wrap( [Object config ], [Boolean returnDom ] )
:
HTMLElement/ElementCreates and wraps this element with another element Creates and wraps this element with another element Parameters:
| Element |
Event | Defined By | |
---|---|---|
DOMActivate :
( Ext.EventObject e , HtmlElement t , Object o )
Where supported. Fires when an element is activated, for instance, through a mouse click or a keypress. Where supported. Fires when an element is activated, for instance, through a mouse click or a keypress. Listeners will be called with the following arguments:
| Element | |
DOMAttrModified :
( Ext.EventObject e , HtmlElement t , Object o )
Where supported. Fires when an attribute has been modified. Where supported. Fires when an attribute has been modified. Listeners will be called with the following arguments:
| Element | |
DOMCharacterDataModified :
( Ext.EventObject e , HtmlElement t , Object o )
Where supported. Fires when the character data has been modified. Where supported. Fires when the character data has been modified. Listeners will be called with the following arguments:
| Element | |
DOMFocusIn :
( Ext.EventObject e , HtmlElement t , Object o )
Where supported. Similar to HTML focus event, but can be applied to any focusable element. Where supported. Similar to HTML focus event, but can be applied to any focusable element. Listeners will be called with the following arguments:
| Element | |
DOMFocusOut :
( Ext.EventObject e , HtmlElement t , Object o )
Where supported. Similar to HTML blur event, but can be applied to any focusable element. Where supported. Similar to HTML blur event, but can be applied to any focusable element. Listeners will be called with the following arguments:
| Element | |
DOMNodeInserted :
( Ext.EventObject e , HtmlElement t , Object o )
Where supported. Fires when a node has been added as a child of another node. Where supported. Fires when a node has been added as a child of another node. Listeners will be called with the following arguments:
| Element | |
DOMNodeInsertedIntoDocument :
( Ext.EventObject e , HtmlElement t , Object o )
Where supported. Fires when a node is being inserted into a document. Where supported. Fires when a node is being inserted into a document. Listeners will be called with the following arguments:
| Element | |
DOMNodeRemoved :
( Ext.EventObject e , HtmlElement t , Object o )
Where supported. Fires when a descendant node of the element is removed. Where supported. Fires when a descendant node of the element is removed. Listeners will be called with the following arguments:
| Element | |
DOMNodeRemovedFromDocument :
( Ext.EventObject e , HtmlElement t , Object o )
Where supported. Fires when a node is being removed from a document. Where supported. Fires when a node is being removed from a document. Listeners will be called with the following arguments:
| Element | |
DOMSubtreeModified :
( Ext.EventObject e , HtmlElement t , Object o )
Where supported. Fires when the subtree is modified. Where supported. Fires when the subtree is modified. Listeners will be called with the following arguments:
| Element | |
abort :
( Ext.EventObject e , HtmlElement t , Object o )
Fires when an object/image is stopped from loading before completely loaded. Fires when an object/image is stopped from loading before completely loaded. Listeners will be called with the following arguments:
| Element | |
blur :
( Ext.EventObject e , HtmlElement t , Object o )
Fires when an element loses focus either via the pointing device or by tabbing navigation. Fires when an element loses focus either via the pointing device or by tabbing navigation. Listeners will be called with the following arguments:
| Element | |
change :
( Ext.EventObject e , HtmlElement t , Object o )
Fires when a control loses the input focus and its value has been modified since gaining focus. Fires when a control loses the input focus and its value has been modified since gaining focus. Listeners will be called with the following arguments:
| Element | |
click :
( Ext.EventObject e , HtmlElement t , Object o )
Fires when a mouse click is detected within the element. Fires when a mouse click is detected within the element. Listeners will be called with the following arguments:
| Element | |
contextmenu :
( Ext.EventObject e , HtmlElement t , Object o )
Fires when a right click is detected within the element. Fires when a right click is detected within the element. Listeners will be called with the following arguments:
| Element | |
dblclick :
( Ext.EventObject e , HtmlElement t , Object o )
Fires when a mouse double click is detected within the element. Fires when a mouse double click is detected within the element. Listeners will be called with the following arguments:
| Element | |
error :
( Ext.EventObject e , HtmlElement t , Object o )
Fires when an object/image/frame cannot be loaded properly. Fires when an object/image/frame cannot be loaded properly. Listeners will be called with the following arguments:
| Element | |
focus :
( Ext.EventObject e , HtmlElement t , Object o )
Fires when an element receives focus either via the pointing device or by tab navigation. Fires when an element receives focus either via the pointing device or by tab navigation. Listeners will be called with the following arguments:
| Element | |
keydown :
( Ext.EventObject e , HtmlElement t , Object o )
Fires when a keydown is detected within the element. Fires when a keydown is detected within the element. Listeners will be called with the following arguments:
| Element | |
keypress :
( Ext.EventObject e , HtmlElement t , Object o )
Fires when a keypress is detected within the element. Fires when a keypress is detected within the element. Listeners will be called with the following arguments:
| Element | |
keyup :
( Ext.EventObject e , HtmlElement t , Object o )
Fires when a keyup is detected within the element. Fires when a keyup is detected within the element. Listeners will be called with the following arguments:
| Element | |
load :
( Ext.EventObject e , HtmlElement t , Object o )
Fires when the user agent finishes loading all content within the element. Only supported by window, frames, objects ... Fires when the user agent finishes loading all content within the element. Only supported by window, frames, objects and images. Listeners will be called with the following arguments:
| Element | |
mousedown :
( Ext.EventObject e , HtmlElement t , Object o )
Fires when a mousedown is detected within the element. Fires when a mousedown is detected within the element. Listeners will be called with the following arguments:
| Element | |
mouseenter :
( Ext.EventObject e , HtmlElement t , Object o )
Fires when the mouse enters the element. Fires when the mouse enters the element. Listeners will be called with the following arguments:
| Element | |
mouseleave :
( Ext.EventObject e , HtmlElement t , Object o )
Fires when the mouse leaves the element. Fires when the mouse leaves the element. Listeners will be called with the following arguments:
| Element | |
mousemove :
( Ext.EventObject e , HtmlElement t , Object o )
Fires when a mousemove is detected with the element. Fires when a mousemove is detected with the element. Listeners will be called with the following arguments:
| Element | |
mouseout :
( Ext.EventObject e , HtmlElement t , Object o )
Fires when a mouseout is detected with the element. Fires when a mouseout is detected with the element. Listeners will be called with the following arguments:
| Element | |
mouseover :
( Ext.EventObject e , HtmlElement t , Object o )
Fires when a mouseover is detected within the element. Fires when a mouseover is detected within the element. Listeners will be called with the following arguments:
| Element | |
mouseup :
( Ext.EventObject e , HtmlElement t , Object o )
Fires when a mouseup is detected within the element. Fires when a mouseup is detected within the element. Listeners will be called with the following arguments:
| Element | |
reset :
( Ext.EventObject e , HtmlElement t , Object o )
Fires when a form is reset. Fires when a form is reset. Listeners will be called with the following arguments:
| Element | |
resize :
( Ext.EventObject e , HtmlElement t , Object o )
Fires when a document view is resized. Fires when a document view is resized. Listeners will be called with the following arguments:
| Element | |
scroll :
( Ext.EventObject e , HtmlElement t , Object o )
Fires when a document view is scrolled. Fires when a document view is scrolled. Listeners will be called with the following arguments:
| Element | |
select :
( Ext.EventObject e , HtmlElement t , Object o )
Fires when a user selects some text in a text field, including input and textarea. Fires when a user selects some text in a text field, including input and textarea. Listeners will be called with the following arguments:
| Element | |
submit :
( Ext.EventObject e , HtmlElement t , Object o )
Fires when a form is submitted. Fires when a form is submitted. Listeners will be called with the following arguments:
| Element | |
unload :
( Ext.EventObject e , HtmlElement t , Object o )
Fires when the user agent removes all content from a window or frame. For elements, it fires when the target element ... Fires when the user agent removes all content from a window or frame. For elements, it fires when the target element or any of its content has been removed. Listeners will be called with the following arguments:
| Element |