Print Friendly

# Class YAHOO.ext.Element

Package: | YAHOO.ext
Class: | Element
Extends: | Object
Subclasses: | Actor
Defined In: | Element.js

Wraps around a DOM element and provides convenient access to Yahoo UI library functionality (and more).
Usage:

    var el = YAHOO.ext.Element.get('myElementId');
    // or the shorter
    var el = getEl('myElementId');

Using YAHOO.ext.Element.get() instead of calling the constructor directly ensures you get the same object each call instead of constructing a new one.
For working with collections of Elements, see YAHOO.ext.CompositeElement

## Public Properties

Property | Defined By
--- | ---
| DISPLAY<static> : Number | Element
<static> Visibility mode constant - Use display to hide element
| VISIBILITY<static> : Number | Element
<static> Visibility mode constant - Use visibility to hide element
| autoBoxAdjust : Object | Element
true to automatically adjust width and height settings for box-model issues (default to true)
| autoDisplayMode : Object | Element
true to automatically detect display mode and use display instead of visibility with show()/hide() (defaults to false...
| 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

## Public Methods

Method | Defined By
--- | ---
| Element(`String/HTMLElement element`, [`Boolean forceNew`]) | Element
Create a new Element directly.
| addClass(`String className`) : YAHOO.ext.Element | Element
Add a CSS class to the element.
| addClassOnOver(`String className`) : YAHOO.ext.Element | Element
Sets up event handlers to add and remove a css class when the mouse is over this element
| addHandler(`String eventName`, `Boolean stopPropagation`, `Function handler`, [`Object scope`], [`boolean override`]) : YAHOO.ext.Element | Element
Appends an event handler to this element. The difference between this function and addListener is this function preve...
| addListener(`String eventName`, `Function handler`, [`Object scope`], [`boolean override`]) : YAHOO.ext.Element | Element
Appends an event handler to this element
| addManagedListener(`String eventName`, `Function fn`, [`Object scope`], [`boolean override`]) : Function | Element
Append a managed listener - See YAHOO.ext.EventObject for more details. Use mon() for a shorter version.
| alignTo(`String/HTMLElement/YAHOO.ext.Element element`, `String position`, [`Array offsets`], [`Boolean animate`], [`Float duration`], [`Function onComplete`], [`Function easing`]) : YAHOO.ext.Element | Element
Align this element with another element.
| animate(`Object args`, [`Float duration`], [`Function onComplete`], [`Function easing`], [`Function animType`]) : YAHOO.ext.Element | Element
Perform Yahoo UI animation on this element.
| appendChild(`String/HTMLElement/Array/Element/CompositeElement el`) : YAHOO.ext.Element | Element
Appends the passed element(s) to this element
| appendTo(`String/HTMLElement/Element el`) : YAHOO.ext.Element | Element
Appends this element to the passed element
| applyStyles(`String/Object/Function styles`) : YAHOO.ext.Element | Element
More flexible version of setStyle for setting style properties.
| autoHeight([`Boolean animate`], [`Float duration`], [`Function onComplete`], [`Function easing`]) : YAHOO.ext.Element | Element
Measures the elements content height and updates height to match. Note, this function uses setTimeout and the new he...
| beginMeasure() : YAHOO.ext.Element | Element
Temporarily enables offsets (width,height,x,y) for an element with display:none, use endMeasure() when done.
| center([`String/HTMLElement/YAHOO.ext.Element centerIn`]) : void | Element
Centers the Element in either the viewport, or another Element.
| clearOpacity() : YAHOO.ext.Element | Element
Clears any opacity settings from this element. Required in some cases for IE.
| clearPositioning() : YAHOO.ext.Element | Element
Clear positioning back to the default when the document was loaded
| clip() : YAHOO.ext.Element | Element
Store the current overflow setting and clip overflow on the element - use unclip to remove
| createChild(`Object config`, [`HTMLElement insertBefore`]) : YAHOO.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`]) : YAHOO.ext.Element | Element
Creates a proxy element of this element
| createShim() : YAHOO.ext.Element | Element
Creates an iframe shim for this element to keep selects and other windowed objects from showing through.
| enableDisplayMode([`String display`]) : YAHOO.ext.Element | Element
Convenience method for setVisibilityMode(Element.DISPLAY)
| endMeasure() : YAHOO.ext.Element | Element
Restores displays to before beginMeasure was called
| fitToParent([`Boolean monitorResize`]) : YAHOO.ext.Element | Element
Sizes this element to it's parent element's dimensions performing neccessary box adjustments.
| focus() : YAHOO.ext.Element | Element
Tries to focus the element. Any exceptions are caught.
| get<static>(`String/HTMLElement/Element el`, [`Boolean autoGenerateId`]) : Element | Element
<static> Static method to retreive Element objects. Uses simple caching to consistently return the same object....
| 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(`Boolean offsetScroll`) : Array | Element
Calculates the x, y to center this element on the screen
| getChildrenByClassName(`String className`, [`String tagName`]) : Array | Element
Gets an array of child YAHOO.ext.Element objects by class name and optional tagName
| getChildrenByTagName(`String tagName`) : Array | Element
Gets an array of child YAHOO.ext.Element objects by tag name
| 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 performin...
| 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)
| getSize([`Boolean contentSize`]) : Object | Element
Returns the size of the element
| getStyle(`String property`) : String | Element
Normalizes currentStyle and ComputedStyle.
| getTop(`Boolean local`) : Number | Element
Gets the top Y coordinate
| getUpdateManager() : YAHOO.ext.UpdateManager | Element
Gets this elements UpdateManager
| getWidth([`Boolean contentWidth`]) : Number | Element
Returns the offset width of the element
| getX() : void | 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() : void | Element
Gets the current position of the element based on page coordinates. Element must be part of the DOM tree to have pag...
| getY() : void | 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 a CSS class is in use by the element.
| hide([`Boolean animate`], [`Float duration`], [`Function onComplete`], [`Function easing`]) : YAHOO.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`) : YAHOO.util.DD | Element
Initializes a YAHOO.util.DD object for this element.
| initDDProxy(`String group`, `Object config`, `Object overrides`) : YAHOO.util.DDProxy | Element
Initializes a YAHOO.util.DDProxy object for this element.
| initDDTarget(`String group`, `Object config`, `Object overrides`) : YAHOO.util.DDTarget | Element
Initializes a YAHOO.util.DDTarget object for this element.
| insertAfter(`String/HTMLElement/Element el`) : YAHOO.ext.Element | Element
Inserts this element after the passed element in the DOM
| insertBefore(`String/HTMLElement/Element el`) : YAHOO.ext.Element | Element
Inserts this element before the passed element in the DOM
| insertHtml(`String where`, `String html`) : YAHOO.ext.Element | Element
Inserts an html fragment into this element
| 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"
| 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`]) : YAHOO.ext.Element | Element
Direct access to the UpdateManager update() method (takes the same parameters).
| mon(`String eventName`, `Function fn`, [`Object scope`], [`boolean override`]) : Function | Element
Append a managed listener (shorthanded for addManagedListener)
| move(`String direction`, `Number distance`, [`Boolean animate`], [`Float duration`], [`Function onComplete`], [`Function easing`]) : YAHOO.ext.Element | Element
Move this element relative to it's current position.
| moveTo(`Number x`, `Number y`, [`Boolean animate`], [`float duration`], [`Function onComplete`], [`Function easing`]) : YAHOO.ext.Element | Element
Set the position of the element in page coordinates, regardless of how the element is positioned. The element must be...
| on(`String eventName`, `Function handler`, [`Object scope`], [`boolean override`]) : YAHOO.ext.Element | Element
Appends an event handler to this element (Same as addListener)
| radioClass(`String className`) : YAHOO.ext.Element | Element
Adds the passed className to this element and removes the class from all siblings
| remove() : void | Element
Removes this element from the DOM and deletes it from the cache
| removeAllListeners() : YAHOO.ext.Element | Element
Removes all previous added listeners from this element
| removeClass(`String className`) : YAHOO.ext.Element | Element
Removes a CSS class from the element.
| removeListener(`String sType`, `Function fn`, `Object scope`) : YAHOO.ext.Element | Element
Removes an event handler from this element
| repaint() : YAHOO.ext.Element | Element
Forces the browser to repaint this element
| replace(`String/HTMLElement/Element el`) : YAHOO.ext.Element | Element
Replaces the passed element with this element
| replaceClass(`String oldClassName`, `String newClassName`) : YAHOO.ext.Element | Element
Replaces a CSS class on the element with another.
| scrollIntoView([`String/HTMLElement/Element container`]) : YAHOO.ext.Element | Element
Scrolls this element into view within the passed container.
| select(`String selector`, `Boolean unique`) : CompositeElement/CompositeElementLite | Element
Selects child nodes based on the passed CSS selector (the selector should not contain an id)
| select<static>(`String/Array selector`, [`Boolean unique`]) : CompositeElementLite/CompositeElement | Element
<static> Selects elements based on the passed CSS selector to enable working on them as 1.
| set(`Object o`) : YAHOO.ext.Element | Element
Sets the passed attributes as attributes of this element (a style attribute can be a string, object or function)
| setAbsolutePositioned([`Number zIndex`]) : YAHOO.ext.Element | Element
Set the element as absolute positioned with the specified z-index
| setBottom(`String bottom`) : YAHOO.ext.Element | Element
Set the element's css bottom style
| setBounds(`Number x`, `Number y`, `Number width`, `Number height`, [`Boolean animate`], [`float duration`], [`Function onComplete`], [`Function easing`]) : YAHOO.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 animate`], [`float duration`], [`Function onComplete`], [`Function easing`]) : YAHOO.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`) : YAHOO.ext.Element | Element
Sets the css display. Uses originalDisplay if value is a boolean true.
| setHeight(`Number height`, [`Boolean animate`], [`float duration`], [`Function onComplete`], [`Function easing`]) : YAHOO.ext.Element | Element
Set the height of the element
| setLeft(`String left`) : YAHOO.ext.Element | Element
Set the element's left position directly using CSS style (instead of setX())
| setLeftTop() : YAHOO.ext.Element | Element
Quick set left and top adding default units
| setLocation(`Number x`, `Number y`, [`Boolean animate`], [`float duration`], [`Function onComplete`], [`Function easing`]) : YAHOO.ext.Element | Element
Set the position of the element in page coordinates, regardless of how the element is positioned. The element must be...
| setOpacity(`Float opacity`, [`Boolean animate`], [`Float duration`], [`Function onComplete`], [`Function easing`]) : YAHOO.ext.Element | Element
Set the opacity of the element
| setPositioning(`Object posCfg`) : YAHOO.ext.Element | Element
Set positioning with an object returned by getPositioning().
| setRegion(`YAHOO.util.Region region`, [`Boolean animate`], [`float duration`], [`Function onComplete`], [`Function easing`]) : YAHOO.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 ...
| setRelativePositioned([`Number zIndex`]) : YAHOO.ext.Element | Element
Set the element as relative positioned with the specified z-index
| setRight(`String right`) : YAHOO.ext.Element | Element
Set the element's css right style
| setSize(`Number width`, `Number height`, [`Boolean animate`], [`float duration`], [`Function onComplete`], [`Function easing`]) : YAHOO.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 val`]) : YAHOO.ext.Element | Element
Wrapper for setting style properties, also takes single object parameter of multiple styles
| setTop(`String top`) : YAHOO.ext.Element | Element
Set the element's top position directly using CSS style (instead of setY())
| setVisibilityMode(`visMode Element.VISIBILITY`) : YAHOO.ext.Element | Element
Sets the elements visibility mode. When setVisible() is called it will use this to determine whether to set the visib...
| setVisible(`Boolean visible`, [`Boolean animate`], [`Float duration`], [`Function onComplete`], [`Function easing`]) : YAHOO.ext.Element | Element
Sets the visibility of the element (see details). If the visibilityMode is set to Element.DISPLAY, it will use the d...
| setWidth(`Number width`, [`Boolean animate`], [`float duration`], [`Function onComplete`], [`Function easing`]) : YAHOO.ext.Element | Element
Set the width of the element
| setX(`Number The`, [`Boolean animate`], [`float duration`], [`Function onComplete`], [`Function easing`]) : YAHOO.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 animate`], [`float duration`], [`Function onComplete`], [`Function easing`]) : YAHOO.ext.Element | Element
Set the position of the element in page coordinates, regardless of how the element is positioned. The element must be...
| setY(`Number The`, [`Boolean animate`], [`float duration`], [`Function onComplete`], [`Function easing`]) : YAHOO.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 animate`], [`Float duration`], [`Function onComplete`], [`Function easing`]) : YAHOO.ext.Element | Element
Show this element - Uses display mode to determine whether to use "display" or "visibility". See setVisible.
| swallowEvent(`String eventName`, [`Boolean preventDefault`]) : YAHOO.ext.Element | Element
Stops the specified event from bubbling and optionally prevent's the default action
| toggle([`Boolean animate`], [`float duration`], [`Function onComplete`], [`Function easing`]) : YAHOO.ext.Element | Element
Toggles the elements visibility or display, depending on visibility mode.
| toggleClass(`String className`) : YAHOO.ext.Element | Element
Toggles (adds or removes) the passed class.
| unclip() : YAHOO.ext.Element | Element
Return clipping (overflow) to original clipping before clip() was called
| unselectable() : YAHOO.ext.Element | Element
Disables text selection for this element (normalized across browsers)
| update(`String html`, [`Boolean loadScripts`], `Function callback`) : YAHOO.ext.Element | Element
Update the innerHTML of this element, optionally searching for and processing scripts
| wrap([`Object config`]) : Element | Element
Creates and wraps this element with another element

## Public Events

This class has no public events.

## Property Details

### DISPLAY<static>

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

### VISIBILITY<static>

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

### autoBoxAdjust

`public Object autoBoxAdjust`
true to automatically adjust width and height settings for box-model issues (default to true)
This property is defined by Element.

### autoDisplayMode

`public Object autoDisplayMode`
true to automatically detect display mode and use display instead of visibility with show()/hide() (defaults to false). To enable this globally:

    YAHOO.ext.Element.prototype.autoDisplayMode = true;

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

### addClass

`public function addClass(`String className`)`
Add a CSS class to the element.
Parameters:

- `className` : String
  The CSS class to add

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### addClassOnOver

`public function addClassOnOver(`String className`)`
Sets up event handlers to add and remove a css class when the mouse is over this element
Parameters:

- `className` : String

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### addHandler

`public function addHandler(`String eventName`, `Boolean stopPropagation`, `Function handler`, [`Object scope`], [`boolean override`])`
Appends an event handler to this element. The difference between this function and addListener is this function prevents the default action, and if set stops propagation (bubbling) as well
Parameters:

- `eventName` : String
  The type of event to listen for
- `stopPropagation` : Boolean
  Whether to also stopPropagation (bubbling)
- `handler` : Function
  The method the event invokes
- `scope` : Object
  (optional) An arbitrary object that will be passed as a parameter to the handler
- `override` : boolean
  (optional) If true, the obj passed in becomes the execution scope of the listener

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### addListener

`public function addListener(`String eventName`, `Function handler`, [`Object scope`], [`boolean override`])`
Appends an event handler to this element
Parameters:

- `eventName` : String
  The type of event to listen for
- `handler` : Function
  The method the event invokes
- `scope` : Object
  (optional) An arbitrary object that will be passed as a parameter to the handler
- `override` : boolean
  (optional) If true, the obj passed in becomes the execution scope of the listener

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### addManagedListener

`public function addManagedListener(`String eventName`, `Function fn`, [`Object scope`], [`boolean override`])`
Append a managed listener - See YAHOO.ext.EventObject for more details. Use mon() for a shorter version.
Parameters:

- `eventName` : String
  The type of event to listen for
- `fn` : Function
  The method the event invokes
- `scope` : Object
  (optional) An arbitrary object that will be passed as a parameter to the handler
- `override` : boolean
  (optional) If true, the obj passed in becomes the execution scope of the listener

Returns:

- `Function`
  The EventManager wrapped function that can be used to remove the listener

This method is defined by Element.

### alignTo

`public function alignTo(`String/HTMLElement/YAHOO.ext.Element element`, `String position`, [`Array offsets`], [`Boolean animate`], [`Float duration`], [`Function onComplete`], [`Function easing`])`
Align this element with another element.
Parameters:

- `element` : String/HTMLElement/YAHOO.ext.Element
  The element to align to.
- `position` : String
  The position to align to. Possible values are 'tl' - top left, 'tr' - top right, 'bl' - bottom left, and 'br' - bottom right.
- `offsets` : Array
  (optional) Offset the positioning by [x, y]
- `animate` : Boolean
  (optional) Animate the movement (Default is false)
- `duration` : Float
  (optional) How long the animation lasts. (Defaults to .35 seconds)
- `onComplete` : Function
  (optional) Function to call when animation completes.
- `easing` : Function
  (optional) YAHOO.util.Easing method to use.

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### animate

`public function animate(`Object args`, [`Float duration`], [`Function onComplete`], [`Function easing`], [`Function animType`])`
Perform Yahoo UI animation on this element.
Parameters:

- `args` : Object
  The YUI animation control args
- `duration` : Float
  (optional) How long the animation lasts. (Defaults to .35 seconds)
- `onComplete` : Function
  (optional) Function to call when animation completes.
- `easing` : Function
  (optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeBoth)
- `animType` : Function
  (optional) YAHOO.util.Anim subclass to use. For example: YAHOO.util.Motion

Returns:

- `YAHOO.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:

- `YAHOO.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:

- `YAHOO.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 eg "width:100px", or object in the form {width:"100px"}, or a function which returns such a specification.

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### autoHeight

`public function autoHeight([`Boolean animate`], [`Float duration`], [`Function onComplete`], [`Function easing`])`
Measures the elements content height and updates height to match. Note, this function uses setTimeout and the new height may not be available immediately.
Parameters:

- `animate` : Boolean
  (optional) Animate the transition (Default is false)
- `duration` : Float
  (optional) Length of the animation. (Defaults to .35 seconds)
- `onComplete` : Function
  (optional) Function to call when animation completes.
- `easing` : Function
  (optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeOut for hiding or YAHOO.util.Easing.easeIn for showing)

Returns:

- `YAHOO.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:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### center

`public function center([`String/HTMLElement/YAHOO.ext.Element centerIn`])`
Centers the Element in either the viewport, or another Element.
Parameters:

- `centerIn` : String/HTMLElement/YAHOO.ext.Element
  (optional) The element in which to center the element.

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:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### clearPositioning

`public function clearPositioning()`
Clear positioning back to the default when the document was loaded
Parameters:

- None.

Returns:

- `YAHOO.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:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### createChild

`public function createChild(`Object config`, [`HTMLElement insertBefore`])`
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
- `insertBefore` : HTMLElement
  (optional) a child element of this element

Returns:

- `YAHOO.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:

- `YAHOO.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:

- `YAHOO.ext.Element`
  The new shim element

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:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### endMeasure

`public function endMeasure()`
Restores displays to before beginMeasure was called
Parameters:

- None.

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### fitToParent

`public function fitToParent([`Boolean monitorResize`])`
Sizes this element to it's parent element's dimensions performing neccessary box adjustments.
Parameters:

- `monitorResize` : Boolean
  (optional) If true maintains the fit when the browser window is resized.

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### focus

`public function focus()`
Tries to focus the element. Any exceptions are caught.
Parameters:

- None.

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### get<static>

`public function get<static>(`String/HTMLElement/Element el`, [`Boolean autoGenerateId`])`
<static> Static method to retreive 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 element or the element to wrap (must have an id). If you pass in an element, it is returned
- `autoGenerateId` : Boolean
  (optional) Set this flag to true if you are passing an element without an id (like document.body). It will auto generate an id if one isn't present.

Returns:

- `Element`
  The element object

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`

This method is defined by Element.

### getCenterXY

`public function getCenterXY(`Boolean offsetScroll`)`
Calculates the x, y to center this element on the screen
Parameters:

- `offsetScroll` : Boolean
  True to offset the documents current scroll position

Returns:

- `Array`
  The x, y values [x, y]

This method is defined by Element.

### getChildrenByClassName

`public function getChildrenByClassName(`String className`, [`String tagName`])`
Gets an array of child YAHOO.ext.Element objects by class name and optional tagName
Parameters:

- `className` : String
- `tagName` : String
  (optional)

Returns:

- `Array`
  The children

This method is defined by Element.

### getChildrenByTagName

`public function getChildrenByTagName(`String tagName`)`
Gets an array of child YAHOO.ext.Element objects by tag name
Parameters:

- `tagName` : String

Returns:

- `Array`
  The children

This method is defined by Element.

### getHeight

`public function getHeight([`Boolean contentHeight`])`
Returns the offset height of the element
Parameters:

- `contentHeight` : Boolean
  (optional) true to get the height minus borders and padding

Returns:

- `Number`
  The element's height

This method is defined by Element.

### getLeft

`public function getLeft(`Boolean local`)`
Gets the left X coordinate
Parameters:

- `local` : Boolean
  True to get the local css position instead of page coordinate

Returns:

- `Number`

This method is defined by Element.

### getMargins

`public function getMargins([`String sides`])`
Returns an object with properties top, left, right and bottom representing the margins of this element unless sides is passed, then it returns the calculated width of the sides (see getPadding)
Parameters:

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

Returns:

- `Object/Number`

This method is defined by Element.

### getNextSibling

`public function getNextSibling()`
Gets the next sibling, skipping text nodes
Parameters:

- None.

Returns:

- `HTMLElement`
  The next sibling or null

This method is defined by Element.

### getPadding

`public function getPadding(`String side`)`
Gets the width of the padding(s) for the specified side(s)
Parameters:

- `side` : String
  Can be t, l, r, b or any combination of those to add multiple values. For example, passing lr would get the padding (l)eft + the padding (r)ight.

Returns:

- `Number`
  The padding of the sides passed added together

This method is defined by Element.

### getPositioning

`public function getPositioning()`
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:

- None.

Returns:

- `Object`

This method is defined by Element.

### getPrevSibling

`public function getPrevSibling()`
Gets the previous sibling, skipping text nodes
Parameters:

- None.

Returns:

- `HTMLElement`
  The previous sibling or null

This method is defined by Element.

### getRegion

`public function getRegion()`
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:

- None.

Returns:

- `Region`
  A YAHOO.util.Region containing "top, left, bottom, right" member data.

This method is defined by Element.

### getRight

`public function getRight(`Boolean local`)`
Gets the right X coordinate of the element (element X position + element width)
Parameters:

- `local` : Boolean
  True to get the local css position instead of page coordinate

Returns:

- `Number`

This method is defined by Element.

### getSize

`public function getSize([`Boolean contentSize`])`
Returns the size of the element
Parameters:

- `contentSize` : Boolean
  (optional) true to get the width/size minus borders and padding

Returns:

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

This method is defined by Element.

### getStyle

`public function getStyle(`String property`)`
Normalizes currentStyle and ComputedStyle.
Parameters:

- `property` : String
  The style property whose value is returned.

Returns:

- `String`
  The current value of the style property for this element.

This method is defined by Element.

### getTop

`public function getTop(`Boolean local`)`
Gets the top Y coordinate
Parameters:

- `local` : Boolean
  True to get the local css position instead of page coordinate

Returns:

- `Number`

This method is defined by Element.

### getUpdateManager

`public function getUpdateManager()`
Gets this elements UpdateManager
Parameters:

- None.

Returns:

- `YAHOO.ext.UpdateManager`
  The UpdateManager

This method is defined by Element.

### getWidth

`public function getWidth([`Boolean contentWidth`])`
Returns the offset width of the element
Parameters:

- `contentWidth` : Boolean
  (optional) true to get the width minus borders and padding

Returns:

- `Number`
  The element's width

This method is defined by Element.

### getX

`public function getX()`
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). @ return {Number} The X position of the element
Parameters:

- None.

Returns:

- `void`

This method is defined by Element.

### getXY

`public function getXY()`
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). @ return {Array} The XY position of the element
Parameters:

- None.

Returns:

- `void`

This method is defined by Element.

### getY

`public function getY()`
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). @ return {Number} The Y position of the element
Parameters:

- None.

Returns:

- `void`

This method is defined by Element.

### hasClass

`public function hasClass(`String className`)`
Checks if a CSS class is in use by the element.
Parameters:

- `className` : String
  The CSS class to check

Returns:

- `Boolean`
  true or false

This method is defined by Element.

### hide

`public function hide([`Boolean animate`], [`Float duration`], [`Function onComplete`], [`Function easing`])`
Hide this element - Uses display mode to determine whether to use "display" or "visibility". See setVisible.
Parameters:

- `animate` : Boolean
  (optional) Animate (fade) the transition (Default is false)
- `duration` : Float
  (optional) How long the animation lasts. (Defaults to .35 seconds)
- `onComplete` : Function
  (optional) Function to call when animation completes.
- `easing` : Function
  (optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeBoth)

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### initDD

`public function initDD(`String group`, `Object config`, `Object overrides`)`
Initializes a YAHOO.util.DD object for this element.
Parameters:

- `group` : String
  The group the DD object is member of
- `config` : Object
  The DD config object
- `overrides` : Object
  An object containing methods to override/implement on the DD object

Returns:

- `YAHOO.util.DD`
  The DD object

This method is defined by Element.

### initDDProxy

`public function initDDProxy(`String group`, `Object config`, `Object overrides`)`
Initializes a YAHOO.util.DDProxy object for this element.
Parameters:

- `group` : String
  The group the DDProxy object is member of
- `config` : Object
  The DDProxy config object
- `overrides` : Object
  An object containing methods to override/implement on the DDProxy object

Returns:

- `YAHOO.util.DDProxy`
  The DDProxy object

This method is defined by Element.

### initDDTarget

`public function initDDTarget(`String group`, `Object config`, `Object overrides`)`
Initializes a YAHOO.util.DDTarget object for this element.
Parameters:

- `group` : String
  The group the DDTarget object is member of
- `config` : Object
  The DDTarget config object
- `overrides` : Object
  An object containing methods to override/implement on the DDTarget object

Returns:

- `YAHOO.util.DDTarget`
  The DDTarget object

This method is defined by Element.

### insertAfter

`public function insertAfter(`String/HTMLElement/Element el`)`
Inserts this element after the passed element in the DOM
Parameters:

- `el` : String/HTMLElement/Element
  The element to insert after

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### insertBefore

`public function insertBefore(`String/HTMLElement/Element el`)`
Inserts this element before the passed element in the DOM
Parameters:

- `el` : String/HTMLElement/Element
  The element to insert before

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### insertHtml

`public function insertHtml(`String where`, `String html`)`
Inserts an html fragment into this element
Parameters:

- `where` : String
  Where to insert the html in relation to the this element - beforeBegin, afterBegin, beforeEnd, afterEnd.
- `html` : String
  The HTML fragment

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### isBorderBox

`public function isBorderBox()`
Tests various css rules/browsers to determine if this element uses a border box
Parameters:

- None.

Returns:

- `Boolean`

This method is defined by Element.

### isDisplayed

`public function isDisplayed()`
Returns true if display is not "none"
Parameters:

- None.

Returns:

- `Boolean`

This method is defined by Element.

### isVisible

`public function isVisible([`Boolean deep`])`
Checks whether the element is currently visible using both visibility and display properties.
Parameters:

- `deep` : Boolean
  True to walk the dom and see if parent elements are hidden.

Returns:

- `Boolean`
  true if the element is currently visible

This method is defined by Element.

### load

`public function load(`String/Function url`, [`String/Object params`], [`Function callback`], [`Boolean discardUrl`])`
Direct access to the UpdateManager update() method (takes the same parameters).
Parameters:

- `url` : String/Function
  The url for this request or a function to call to get the url
- `params` : String/Object
  (optional) The parameters to pass as either a url encoded string "param1=1&param2=2" or an object {param1: 1, param2: 2}
- `callback` : Function
  (optional) Callback when transaction is complete - called with signature (oElement, bSuccess)
- `discardUrl` : Boolean
  (optional) By default when you execute an update the defaultUrl is changed to the last used url. If true, it will not store the url.

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### mon

`public function mon(`String eventName`, `Function fn`, [`Object scope`], [`boolean override`])`
Append a managed listener (shorthanded for addManagedListener)
Parameters:

- `eventName` : String
  The type of event to listen for
- `fn` : Function
  The method the event invokes
- `scope` : Object
  (optional) An arbitrary object that will be passed as a parameter to the handler
- `override` : boolean
  (optional) If true, the obj passed in becomes the execution scope of the listener

Returns:

- `Function`
  The EventManager wrapped function that can be used to remove the listener

This method is defined by Element.

### move

`public function move(`String direction`, `Number distance`, [`Boolean animate`], [`Float duration`], [`Function onComplete`], [`Function easing`])`
Move this element relative to it's current position.
Parameters:

- `direction` : String
  Possible values are: 'l','left' - 'r','right' - 't','top','up' - 'b','bottom','down'.
- `distance` : Number
  How far to move the element in pixels
- `animate` : Boolean
  (optional) Animate the movement (Default is false)
- `duration` : Float
  (optional) How long the animation lasts. (Defaults to .35 seconds)
- `onComplete` : Function
  (optional) Function to call when animation completes.
- `easing` : Function
  (optional) YAHOO.util.Easing method to use.

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### moveTo

`public function moveTo(`Number x`, `Number y`, [`Boolean animate`], [`float duration`], [`Function onComplete`], [`Function easing`])`
Set the position of the element in page coordinates, regardless of how the element is positioned. The element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).
Parameters:

- `x` : Number
  X value for new position (coordinates are page-based)
- `y` : Number
  Y value for new position (coordinates are page-based)
- `animate` : Boolean
  (optional) Animate the transition (Default is false)
- `duration` : float
  (optional) How long the animation lasts. (Defaults to .35 seconds)
- `onComplete` : Function
  (optional) Function to call when animation completes.
- `easing` : Function
  (optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeBoth)

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### on

`public function on(`String eventName`, `Function handler`, [`Object scope`], [`boolean override`])`
Appends an event handler to this element (Same as addListener)
Parameters:

- `eventName` : String
  The type of event to listen for
- `handler` : Function
  The method the event invokes
- `scope` : Object
  (optional) An arbitrary object that will be passed as a parameter to the handler
- `override` : boolean
  (optional) If true, the obj passed in becomes the execution scope of the listener

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### radioClass

`public function radioClass(`String className`)`
Adds the passed className to this element and removes the class from all siblings
Parameters:

- `className` : String
  The className to add

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### remove

`public function remove()`
Removes this element from the DOM and deletes it from the cache
Parameters:

- None.

Returns:

- `void`

This method is defined by Element.

### removeAllListeners

`public function removeAllListeners()`
Removes all previous added listeners from this element
Parameters:

- None.

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### removeClass

`public function removeClass(`String className`)`
Removes a CSS class from the element.
Parameters:

- `className` : String
  The CSS class to remove

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### removeListener

`public function removeListener(`String sType`, `Function fn`, `Object scope`)`
Removes an event handler from this element
Parameters:

- `sType` : String
  the type of event to remove
- `fn` : Function
  the method the event invokes
- `scope` : Object

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### repaint

`public function repaint()`
Forces the browser to repaint this element
Parameters:

- None.

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### replace

`public function replace(`String/HTMLElement/Element el`)`
Replaces the passed element with this element
Parameters:

- `el` : String/HTMLElement/Element
  The element to replace

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### replaceClass

`public function replaceClass(`String oldClassName`, `String newClassName`)`
Replaces a CSS class on the element with another.
Parameters:

- `oldClassName` : String
  The CSS class to replace
- `newClassName` : String
  The replacement CSS class

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### scrollIntoView

`public function scrollIntoView([`String/HTMLElement/Element container`])`
Scrolls this element into view within the passed container.
Parameters:

- `container` : String/HTMLElement/Element
  (optional) The container element to scroll (defaults to document.body)

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### select

`public function select(`String selector`, `Boolean unique`)`
Selects child nodes based on the passed CSS selector (the selector should not contain an id)
Parameters:

- `selector` : String
  The CSS selector
- `unique` : Boolean
  true to create a unique YAHOO.ext.Element for each child (defaults to a shared flyweight object)

Returns:

- `CompositeElement/CompositeElementLite`
  The composite element

This method is defined by Element.

### select<static>

`public function select<static>(`String/Array selector`, [`Boolean unique`])`
<static> Selects elements based on the passed CSS selector to enable working on them as 1.
Parameters:

- `selector` : String/Array
  The CSS selector or an array of elements
- `unique` : Boolean
  (optional) true to create a unique YAHOO.ext.Element for each element (defaults to a shared flyweight object)

Returns:

- `CompositeElementLite/CompositeElement`

This method is defined by Element.

### set

`public function set(`Object o`)`
Sets the passed attributes as attributes of this element (a style attribute can be a string, object or function)
Parameters:

- `o` : Object
  The object with the attributes

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### setAbsolutePositioned

`public function setAbsolutePositioned([`Number zIndex`])`
Set the element as absolute positioned with the specified z-index
Parameters:

- `zIndex` : Number
  (optional)

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### setBottom

`public function setBottom(`String bottom`)`
Set the element's css bottom style
Parameters:

- `bottom` : String
  The bottom CSS property value

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### setBounds

`public function setBounds(`Number x`, `Number y`, `Number width`, `Number height`, [`Boolean animate`], [`float duration`], [`Function onComplete`], [`Function easing`])`
Sets the element's position and size in one shot. If animation is true then width, height, x and y will be animated concurrently.
Parameters:

- `x` : Number
  X value for new position (coordinates are page-based)
- `y` : Number
  Y value for new position (coordinates are page-based)
- `width` : Number
  The new width
- `height` : Number
  The new height
- `animate` : Boolean
  (optional) Animate the transition (Default is false)
- `duration` : float
  (optional) How long the animation lasts. (Defaults to .35 seconds)
- `onComplete` : Function
  (optional) Function to call when animation completes.
- `easing` : Function
  (optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeBoth)

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### setBox

`public function setBox(`Object box`, [`Boolean adjust`], [`Boolean animate`], [`float duration`], [`Function onComplete`], [`Function easing`])`
Sets the element's box. Use getBox() on another element to get a box obj. If animate is true then width, height, x and y will be animated concurrently.
Parameters:

- `box` : Object
  The box to fill {x, y, width, height}
- `adjust` : Boolean
  (optional) Whether to adjust for box-model issues automatically
- `animate` : Boolean
  (optional) Animate the transition (Default is false)
- `duration` : float
  (optional) How long the animation lasts. (Defaults to .35 seconds)
- `onComplete` : Function
  (optional) Function to call when animation completes.
- `easing` : Function
  (optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeBoth)

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### setDisplayed

`public function setDisplayed(`Boolean value`)`
Sets the css display. Uses originalDisplay if value is a boolean true.
Parameters:

- `value` : Boolean
  Boolean to display the element using it's default display or a string to set the display directly

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### setHeight

`public function setHeight(`Number height`, [`Boolean animate`], [`float duration`], [`Function onComplete`], [`Function easing`])`
Set the height of the element
Parameters:

- `height` : Number
  The new height
- `animate` : Boolean
  (optional) Animate the transition (Default is false)
- `duration` : float
  (optional) How long the animation lasts. (Defaults to .35 seconds)
- `onComplete` : Function
  (optional) Function to call when animation completes.
- `easing` : Function
  (optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeOut if height is larger or YAHOO.util.Easing.easeIn if it is smaller)

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### setLeft

`public function setLeft(`String left`)`
Set the element's left position directly using CSS style (instead of setX())
Parameters:

- `left` : String
  The left CSS property value

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### setLeftTop

`public function setLeftTop()`
Quick set left and top adding default units
Parameters:

- None.

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### setLocation

`public function setLocation(`Number x`, `Number y`, [`Boolean animate`], [`float duration`], [`Function onComplete`], [`Function easing`])`
Set the position of the element in page coordinates, regardless of how the element is positioned. The element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).
Parameters:

- `x` : Number
  X value for new position (coordinates are page-based)
- `y` : Number
  Y value for new position (coordinates are page-based)
- `animate` : Boolean
  (optional) Animate the transition (Default is false)
- `duration` : float
  (optional) How long the animation lasts. (Defaults to .35 seconds)
- `onComplete` : Function
  (optional) Function to call when animation completes.
- `easing` : Function
  (optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeBoth)

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### setOpacity

`public function setOpacity(`Float opacity`, [`Boolean animate`], [`Float duration`], [`Function onComplete`], [`Function easing`])`
Set the opacity of the element
Parameters:

- `opacity` : Float
  The new opacity. 0 = transparent, .5 = 50% visibile, 1 = fully visible, etc
- `animate` : Boolean
  (optional) Animate (fade) the transition (Default is false)
- `duration` : Float
  (optional) How long the animation lasts. (Defaults to .35 seconds)
- `onComplete` : Function
  (optional) Function to call when animation completes.
- `easing` : Function
  (optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeOut if height is larger or YAHOO.util.Easing.easeIn if it is smaller)

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### setPositioning

`public function setPositioning(`Object posCfg`)`
Set positioning with an object returned by getPositioning().
Parameters:

- `posCfg` : Object

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### setRegion

`public function setRegion(`YAHOO.util.Region region`, [`Boolean animate`], [`float duration`], [`Function onComplete`], [`Function easing`])`
Sets the element's position and size the the specified region. If animation is true then width, height, x and y will be animated concurrently.
Parameters:

- `region` : YAHOO.util.Region
  The region to fill
- `animate` : Boolean
  (optional) Animate the transition (Default is false)
- `duration` : float
  (optional) How long the animation lasts. (Defaults to .35 seconds)
- `onComplete` : Function
  (optional) Function to call when animation completes.
- `easing` : Function
  (optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeBoth)

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### setRelativePositioned

`public function setRelativePositioned([`Number zIndex`])`
Set the element as relative positioned with the specified z-index
Parameters:

- `zIndex` : Number
  (optional)

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### setRight

`public function setRight(`String right`)`
Set the element's css right style
Parameters:

- `right` : String
  The right CSS property value

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### setSize

`public function setSize(`Number width`, `Number height`, [`Boolean animate`], [`float duration`], [`Function onComplete`], [`Function easing`])`
Set the size of the element. If animation is true, both width an height will be animated concurrently.
Parameters:

- `width` : Number
  The new width
- `height` : Number
  The new height
- `animate` : Boolean
  (optional) Animate the transition (Default is false)
- `duration` : float
  (optional) How long the animation lasts. (Defaults to .35 seconds)
- `onComplete` : Function
  (optional) Function to call when animation completes.
- `easing` : Function
  (optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeBoth)

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### setStyle

`public function setStyle(`String/Object property`, [`String val`])`
Wrapper for setting style properties, also takes single object parameter of multiple styles
Parameters:

- `property` : String/Object
  The style property to be set or an object of multiple styles.
- `val` : String
  (optional) The value to apply to the given property or null if an object was passed.

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### setTop

`public function setTop(`String top`)`
Set the element's top position directly using CSS style (instead of setY())
Parameters:

- `top` : String
  The top CSS property value

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### setVisibilityMode

`public function setVisibilityMode(`visMode Element.VISIBILITY`)`
Sets the elements visibility mode. When setVisible() is called it will use this to determine whether to set the visibility or the display property.
Parameters:

- `Element.VISIBILITY` : visMode
  or Element.DISPLAY

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### setVisible

`public function setVisible(`Boolean visible`, [`Boolean animate`], [`Float duration`], [`Function onComplete`], [`Function easing`])`
Sets the visibility of the element (see details). If the visibilityMode is set to Element.DISPLAY, it will use the display property to hide the element, otherwise it uses visibility. The default is to hide and show using the visibility property.
Parameters:

- `visible` : Boolean
  Whether the element is visible
- `animate` : Boolean
  (optional) Fade the element in or out (Default is false)
- `duration` : Float
  (optional) How long the fade effect lasts. (Defaults to .35 seconds)
- `onComplete` : Function
  (optional) Function to call when animation completes.
- `easing` : Function
  (optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeOut for hiding or YAHOO.util.Easing.easeIn for showing)

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### setWidth

`public function setWidth(`Number width`, [`Boolean animate`], [`float duration`], [`Function onComplete`], [`Function easing`])`
Set the width of the element
Parameters:

- `width` : Number
  The new width
- `animate` : Boolean
  (optional) Animate the transition (Default is false)
- `duration` : float
  (optional) How long the animation lasts. (Defaults to .35 seconds)
- `onComplete` : Function
  (optional) Function to call when animation completes.
- `easing` : Function
  (optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeOut if width is larger or YAHOO.util.Easing.easeIn if it is smaller)

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### setX

`public function setX(`Number The`, [`Boolean animate`], [`float duration`], [`Function onComplete`], [`Function easing`])`
Sets the X position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).
Parameters:

- `The` : Number
  X position of the element
- `animate` : Boolean
  (optional) Animate the transition (Default is false)
- `duration` : float
  (optional) How long the animation lasts. (Defaults to .35 seconds)
- `onComplete` : Function
  (optional) Function to call when animation completes.
- `easing` : Function
  (optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeBoth)

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### setXY

`public function setXY(`Array pos`, [`Boolean animate`], [`float duration`], [`Function onComplete`], [`Function easing`])`
Set the position of the element in page coordinates, regardless of how the element is positioned. The element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).
Parameters:

- `pos` : Array
  Contains X & Y [x, y] values for new position (coordinates are page-based)
- `animate` : Boolean
  (optional) Animate the transition (Default is false)
- `duration` : float
  (optional) How long the animation lasts. (Defaults to .35 seconds)
- `onComplete` : Function
  (optional) Function to call when animation completes.
- `easing` : Function
  (optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeBoth)

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### setY

`public function setY(`Number The`, [`Boolean animate`], [`float duration`], [`Function onComplete`], [`Function easing`])`
Sets the Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).
Parameters:

- `The` : Number
  Y position of the element
- `animate` : Boolean
  (optional) Animate the transition (Default is false)
- `duration` : float
  (optional) How long the animation lasts. (Defaults to .35 seconds)
- `onComplete` : Function
  (optional) Function to call when animation completes.
- `easing` : Function
  (optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeBoth)

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### show

`public function show([`Boolean animate`], [`Float duration`], [`Function onComplete`], [`Function easing`])`
Show this element - Uses display mode to determine whether to use "display" or "visibility". See setVisible.
Parameters:

- `animate` : Boolean
  (optional) Animate (fade in) the transition (Default is false)
- `duration` : Float
  (optional) How long the animation lasts. (Defaults to .35 seconds)
- `onComplete` : Function
  (optional) Function to call when animation completes.
- `easing` : Function
  (optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeBoth)

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### swallowEvent

`public function swallowEvent(`String eventName`, [`Boolean preventDefault`])`
Stops the specified event from bubbling and optionally prevent's the default action
Parameters:

- `eventName` : String
- `preventDefault` : Boolean
  (optional) true to prevent the default action too

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### toggle

`public function toggle([`Boolean animate`], [`float duration`], [`Function onComplete`], [`Function easing`])`
Toggles the elements visibility or display, depending on visibility mode.
Parameters:

- `animate` : Boolean
  (optional) Fade the element in or out (Default is false)
- `duration` : float
  (optional) How long the fade effect lasts. (Defaults to .35 seconds)
- `onComplete` : Function
  (optional) Function to call when animation completes.
- `easing` : Function
  (optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeOut for hiding or YAHOO.util.Easing.easeIn for showing)

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### toggleClass

`public function toggleClass(`String className`)`
Toggles (adds or removes) the passed class.
Parameters:

- `className` : String

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### unclip

`public function unclip()`
Return clipping (overflow) to original clipping before clip() was called
Parameters:

- None.

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### unselectable

`public function unselectable()`
Disables text selection for this element (normalized across browsers)
Parameters:

- None.

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### update

`public function update(`String html`, [`Boolean loadScripts`], `Function callback`)`
Update the innerHTML of this element, optionally searching for and processing scripts
Parameters:

- `html` : String
  The new HTML
- `loadScripts` : Boolean
  (optional) true to look for and process scripts
- `callback` : Function
  For async script loading you can be noticed when the update completes

Returns:

- `YAHOO.ext.Element`
  this

This method is defined by Element.

### wrap

`public function wrap([`Object config`])`
Creates and wraps this element with another element
Parameters:

- `config` : Object
  (optional) DomHelper element config object for the wrapper element or null for an empty div

Returns:

- `Element`
  The newly created wrapper element

This method is defined by Element.

Copyright © 2006 Jack Slocum. All rights reserved.