Class YAHOO.ext.Actor

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

Provides support for syncing and chaining of Element Yahoo! UI based animation and some common effects. Actors support "self-play" without an Animator.

Note: Along with the animation methods defined below, this class inherits and captures all of the "set" or animation methods of YAHOO.ext.Element. "get" methods are not captured and execute immediately.

Usage:

var actor = new YAHOO.ext.Actor('myElementId');
actor.startCapture(true);
actor.moveTo(100, 100, true);
actor.squish();
actor.play();


// or to start capturing immediately, with no Animator (the null second param)


var actor = new YAHOO.ext.Actor('myElementId', null, true);
actor.moveTo(100, 100, true);
actor.squish();
actor.play();

Public Properties

Property		Defined By
	DISPLAY<static> : Number	Element
	<static> Visibility mode constant - Use display to hide element	Element
	VISIBILITY<static> : Number	Element
	<static> Visibility mode constant - Use visibility to hide element	Element
	autoBoxAdjust : Object	Element
	true to automatically adjust width and height settings for box-model issues (default to true)	Element
	autoDisplayMode : Object	Element
	true to automatically detect display mode and use display instead of visibility with show()/hide() (defaults to false...	Element
	capturing : Object	Actor
	Whether this actor is currently capturing	Actor
	defaultUnit : String	Element
	The default unit to append to CSS values where a unit isn't provided (Defaults to px).	Element
	dom : HTMLElement	Element
	The DOM element	Element
	id : String	Element
	The DOM element ID	Element
	originalDisplay : String	Element
	The element's default display mode	Element

Public Methods

Method		Defined By
	Actor(`String/HTMLElement el`, [`YAHOO.ext.Animator animator`], [`Boolean selfCapture`])	Actor
	Create new Actor.	Actor
	addAsyncCall(`Function fcn`, `Number callbackIndex`, [`Array args`], [`Object scope`]) : void	Actor
	Capture an async function call.	Actor
	addCall(`Function fcn`, [`Array args`], [`Object scope`]) : void	Actor
	Capture a function call.	Actor
	addClass() : void	Actor
	Capturing override - See YAHOO.ext.Element.addClass for method details.	Actor
	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	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...	Element
	addKeyListener(`Number/Array/Object/String key`, `Function fn`, [`Object scope`]) : YAHOO.ext.KeyMap	Element
	Convenience method for constructing a KeyMap	Element
	addKeyMap(`Object config`) : YAHOO.ext.KeyMap	Element
	Creates a KeyMap for this element	Element
	addListener(`String eventName`, `Function handler`, [`Object scope`], [`boolean override`]) : YAHOO.ext.Element	Element
	Appends an event handler to this element	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.	Element
	alignTo() : void	Actor
	Capturing and animation syncing override - See YAHOO.ext.Element.alignTo for method details.	Actor
	animate() : void	Actor
	Capturing and animation syncing override - See YAHOO.ext.Element.animate for method details.	Actor
	appear([`Float duration`]) : void	Actor
	Fade an element in	Actor
	appendChild(`String/HTMLElement/Array/Element/CompositeElement el`) : YAHOO.ext.Element	Element
	Appends the passed element(s) to this element	Element
	appendTo(`String/HTMLElement/Element el`) : YAHOO.ext.Element	Element
	Appends this element to the passed element	Element
	applyStyles(`String/Object/Function styles`) : YAHOO.ext.Element	Element
	More flexible version of setStyle for setting style properties.	Element
	autoHeight() : void	Actor
	Capturing and animation syncing override - See YAHOO.ext.Element.autoHeight for method details.	Actor
	beginMeasure() : YAHOO.ext.Element	Element
	Temporarily enables offsets (width,height,x,y) for an element with display:none, use endMeasure() when done.	Element
	blindHide(`String anchor`, [`Float duration`], [`Function easing`]) : void	Actor
	Hide the element using a "blinds" effect	Actor
	blindShow(`String anchor`, [`Number newSize`], [`Float duration`], [`Function easing`]) : void	Actor
	Show the element using a "blinds" effect	Actor
	blur() : YAHOO.ext.Element	Element
	Tries to blur the element. Any exceptions are caught.	Element
	bounce() : void	Actor
	Bounce this element from up and down	Actor
	bufferedListener(`String eventName`, `Function handler`, [`Object scope`], [`Number millis`]) : Function	Element
	Appends an event handler to this element that is buffered. If the event is triggered more than once in the specified ...	Element
	capture(`YAHOO.ext.Actor.Action action`) : void	Actor
	Captures an action for this actor. Generally called internally but can be called directly.	Actor
	center([`String/HTMLElement/YAHOO.ext.Element centerIn`]) : void	Element
	Centers the Element in either the viewport, or another Element.	Element
	clear() : void	Actor
	Clears any calls that have been self captured.	Actor
	clearOpacity() : void	Actor
	Capturing override - See YAHOO.ext.Element.clearOpacity for method details.	Actor
	clearPositioning() : void	Actor
	Capturing override - See YAHOO.ext.Element.clearPositioning for method details.	Actor
	clip() : void	Actor
	Capturing override - See YAHOO.ext.Element.clip for method details.	Actor
	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...	Element
	createProxy(`String/Object config`, [`String/HTMLElement renderTo`], [`Boolean matchBox`]) : YAHOO.ext.Element	Element
	Creates a proxy element of this element	Element
	createShim() : YAHOO.ext.Element	Element
	Creates an iframe shim for this element to keep selects and other windowed objects from showing through.	Element
	dropOut([`Float duration`]) : void	Actor
	Fade the element as it is falling from it's current position	Actor
	enableDisplayMode() : void	Actor
	Capturing override - See YAHOO.ext.Element.enableDisplayMode for method details.	Actor
	endMeasure() : YAHOO.ext.Element	Element
	Restores displays to before beginMeasure was called	Element
	fade([`Float duration`]) : void	Actor
	Fade an element out	Actor
	fitToParent([`Boolean monitorResize`]) : YAHOO.ext.Element	Element
	Sizes this element to it's parent element's dimensions performing neccessary box adjustments.	Element
	focus() : void	Actor
	Capturing override - See YAHOO.ext.Element.focus for method details.	Actor
	frame([`Number color`], [`Number count`], [`Float duration`]) : void	Actor
	Show a ripple of exploding, attenuating borders to draw attention to an Element.	Actor
	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....	Element
	getBorderWidth(`String side`) : Number	Element
	Gets the width of the border(s) for the specified side(s)	Element
	getBottom(`Boolean local`) : Number	Element
	Gets the bottom Y coordinate of the element (element Y position + element height)	Element
	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.	Element
	getCenterXY(`Boolean offsetScroll`) : Array	Element
	Calculates the x, y to center this element on the screen	Element
	getChildrenByClassName(`String className`, [`String tagName`]) : Array	Element
	Gets an array of child YAHOO.ext.Element objects by class name and optional tagName	Element
	getChildrenByTagName(`String tagName`) : Array	Element
	Gets an array of child YAHOO.ext.Element objects by tag name	Element
	getHeight([`Boolean contentHeight`]) : Number	Element
	Returns the offset height of the element	Element
	getLeft(`Boolean local`) : Number	Element
	Gets the left X coordinate	Element
	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...	Element
	getNextSibling() : HTMLElement	Element
	Gets the next sibling, skipping text nodes	Element
	getPadding(`String side`) : Number	Element
	Gets the width of the padding(s) for the specified side(s)	Element
	getPositioning() : Object	Element
	Gets an object with all CSS positioning properties. Useful along with setPostioning to get snapshot before performin...	Element
	getPrevSibling() : HTMLElement	Element
	Gets the previous sibling, skipping text nodes	Element
	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...	Element
	getRight(`Boolean local`) : Number	Element
	Gets the right X coordinate of the element (element X position + element width)	Element
	getSize([`Boolean contentSize`]) : Object	Element
	Returns the size of the element	Element
	getStyle(`String property`) : String	Element
	Normalizes currentStyle and ComputedStyle.	Element
	getTop(`Boolean local`) : Number	Element
	Gets the top Y coordinate	Element
	getUpdateManager() : YAHOO.ext.UpdateManager	Element
	Gets this elements UpdateManager	Element
	getWidth([`Boolean contentWidth`]) : Number	Element
	Returns the offset width of the element	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...	Element
	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...	Element
	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...	Element
	hasClass(`String className`) : Boolean	Element
	Checks if a CSS class is in use by the element.	Element
	hide() : void	Actor
	Capturing and animation syncing override - See YAHOO.ext.Element.hide for method details.	Actor
	highlight([`String color`], [`String fromColor`], [`Float duration`], [`String attribute`]) : void	Actor
	Highlight the element using a background color (or passed attribute) animation	Actor
	initDD(`String group`, `Object config`, `Object overrides`) : YAHOO.util.DD	Element
	Initializes a YAHOO.util.DD object for this element.	Element
	initDDProxy(`String group`, `Object config`, `Object overrides`) : YAHOO.util.DDProxy	Element
	Initializes a YAHOO.util.DDProxy object for this element.	Element
	initDDTarget(`String group`, `Object config`, `Object overrides`) : YAHOO.util.DDTarget	Element
	Initializes a YAHOO.util.DDTarget object for this element.	Element
	insertAfter(`String/HTMLElement/Element el`) : YAHOO.ext.Element	Element
	Inserts this element after the passed element in the DOM	Element
	insertBefore(`String/HTMLElement/Element el`) : YAHOO.ext.Element	Element
	Inserts this element before the passed element in the DOM	Element
	insertHtml(`String where`, `String html`) : YAHOO.ext.Element	Element
	Inserts an html fragment into this element	Element
	isBorderBox() : Boolean	Element
	Tests various css rules/browsers to determine if this element uses a border box	Element
	isDisplayed() : Boolean	Element
	Returns true if display is not "none"	Element
	isVisible([`Boolean deep`]) : Boolean	Element
	Checks whether the element is currently visible using both visibility and display properties.	Element
	load() : void	Actor
	Capturing and animation syncing override - See YAHOO.ext.Element.load for method details.	Actor
	mon(`String eventName`, `Function fn`, [`Object scope`], [`boolean override`]) : Function	Element
	Append a managed listener (shorthanded for addManagedListener)	Element
	move() : void	Actor
	Capturing and animation syncing override - See YAHOO.ext.Element.move for method details.	Actor
	moveIn(`String anchor`, [`Array to`], [`Float duration`], [`Function easing`]) : void	Actor
	Show the element in a way that it appears as if it is flying onto the screen	Actor
	moveOut(`String anchor`, [`Float duration`], [`Function easing`]) : void	Actor
	Hide the element in a way that it appears as if it is flying off the screen	Actor
	moveTo() : void	Actor
	Capturing and animation syncing override - See YAHOO.ext.Element.moveTo for method details.	Actor
	on(`String eventName`, `Function handler`, [`Object scope`], [`boolean override`]) : YAHOO.ext.Element	Element
	Appends an event handler to this element (Same as addListener)	Element
	pause(`Number seconds`) : void	Actor
	Capture a pause (in seconds).	Actor
	play([`Function oncomplete`]) : void	Actor
	Starts playback of self captured calls.	Actor
	pulsate([`Number count`], [`Float duration`]) : void	Actor
	Fade the element in and out the specified amount of times	Actor
	radioClass(`String className`) : YAHOO.ext.Element	Element
	Adds the passed className to this element and removes the class from all siblings	Element
	remove() : void	Actor
	Capturing override - See YAHOO.ext.Element.remove for method details.	Actor
	removeAllListeners() : YAHOO.ext.Element	Element
	Removes all previous added listeners from this element	Element
	removeClass() : void	Actor
	Capturing override - See YAHOO.ext.Element.removeClass for method details.	Actor
	removeListener(`String sType`, `Function fn`, `Object scope`) : YAHOO.ext.Element	Element
	Removes an event handler from this element	Element
	repaint() : YAHOO.ext.Element	Element
	Forces the browser to repaint this element	Element
	replace(`String/HTMLElement/Element el`) : YAHOO.ext.Element	Element
	Replaces the passed element with this element	Element
	replaceClass() : void	Actor
	Capturing override - See YAHOO.ext.Element.replaceClass for method details.	Actor
	scrollIntoView([`String/HTMLElement/Element container`]) : YAHOO.ext.Element	Element
	Scrolls this element into view within the passed container.	Element
	select(`String selector`, `Boolean unique`) : CompositeElement/CompositeElementLite	Element
	Selects child nodes based on the passed CSS selector (the selector should not contain an id)	Element
	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.	Element
	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)	Element
	setAbsolutePositioned() : void	Actor
	Capturing override - See YAHOO.ext.Element.setAbsolutePositioned for method details.	Actor
	setBottom(`String bottom`) : YAHOO.ext.Element	Element
	Set the element's css bottom style	Element
	setBounds() : void	Actor
	Capturing and animation syncing override - See YAHOO.ext.Element.setBounds for method details.	Actor
	setBox() : void	Actor
	Capturing and animation syncing override - See YAHOO.ext.Element.setBox for method details.	Actor
	setDisplayed(`Boolean value`) : YAHOO.ext.Element	Element
	Sets the css display. Uses originalDisplay if value is a boolean true.	Element
	setHeight() : void	Actor
	Capturing and animation syncing override - See YAHOO.ext.Element.setHeight for method details.	Actor
	setLeft() : void	Actor
	Capturing override - See YAHOO.ext.Element.setLeft for method details.	Actor
	setLeftTop() : YAHOO.ext.Element	Element
	Quick set left and top adding default units	Element
	setLocation() : void	Actor
	Capturing and animation syncing override - See YAHOO.ext.Element.setLocation for method details.	Actor
	setOpacity() : void	Actor
	Capturing and animation syncing override - See YAHOO.ext.Element.setOpacity for method details.	Actor
	setPositioning() : void	Actor
	Capturing override - See YAHOO.ext.Element.setPositioning for method details.	Actor
	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 ...	Element
	setRelativePositioned() : void	Actor
	Capturing override - See YAHOO.ext.Element.setRelativePositioned for method details.	Actor
	setRight(`String right`) : YAHOO.ext.Element	Element
	Set the element's css right style	Element
	setSize() : void	Actor
	Capturing and animation syncing override - See YAHOO.ext.Element.setSize for method details.	Actor
	setStyle() : void	Actor
	Capturing override - See YAHOO.ext.Element.setStyle for method details.	Actor
	setTop() : void	Actor
	Capturing override - See YAHOO.ext.Element.setTop for method details.	Actor
	setVisibilityMode() : void	Actor
	Capturing override - See YAHOO.ext.Element.setVisibilityMode for method details.	Actor
	setVisible() : void	Actor
	Capturing and animation syncing override - See YAHOO.ext.Element.setVisible for method details.	Actor
	setWidth() : void	Actor
	Capturing and animation syncing override - See YAHOO.ext.Element.setWidth for method details.	Actor
	setX() : void	Actor
	Capturing override - See YAHOO.ext.Element.setX for method details.	Actor
	setXY() : void	Actor
	Capturing and animation syncing override - See YAHOO.ext.Element.setXY for method details.	Actor
	setY() : void	Actor
	Capturing override - See YAHOO.ext.Element.setY for method details.	Actor
	shake() : void	Actor
	Shake this element from side to side	Actor
	show() : void	Actor
	Capturing and animation syncing override - See YAHOO.ext.Element.show for method details.	Actor
	slideHide(`String anchor`, [`Float duration`], [`Function easing`]) : void	Actor
	Hide the element using a "slide in" effect - In order for this effect to work the element MUST have a child element c...	Actor
	slideShow(`String anchor`, [`Number newSize`], [`Float duration`], [`Function easing`]) : void	Actor
	Show the element using a "slide in" effect - In order for this effect to work the element MUST have a child element c...	Actor
	squish([`Float duration`]) : void	Actor
	Hide the element by "squishing" it into the corner	Actor
	startCapture() : void	Actor
	Start self capturing calls on this Actor. All subsequent calls are captured and executed when play() is called.	Actor
	stopCapture() : void	Actor
	Stop self capturing calls on this Actor.	Actor
	swallowEvent(`String eventName`, [`Boolean preventDefault`]) : YAHOO.ext.Element	Element
	Stops the specified event from bubbling and optionally prevent's the default action	Element
	switchOff([`Float duration`]) : void	Actor
	Blink the element as if it was clicked and then collapse on it's center	Actor
	toggle() : void	Actor
	Capturing and animation syncing override - See YAHOO.ext.Element.toggle for method details.	Actor
	toggleClass(`String className`) : YAHOO.ext.Element	Element
	Toggles (adds or removes) the passed class.	Element
	unclip() : void	Actor
	Capturing override - See YAHOO.ext.Element.unclip for method details.	Actor
	unselectable() : YAHOO.ext.Element	Element
	Disables text selection for this element (normalized across browsers)	Element
	update() : void	Actor
	Capturing override - See YAHOO.ext.Element.update for method details.	Actor
	wrap([`Object config`]) : Element	Element
	Creates and wraps this element with another element	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.

capturing

public Object capturing

Whether this actor is currently capturing

This property is defined by Actor.

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

Actor

public function Actor(String/HTMLElement el, [YAHOO.ext.Animator animator], [Boolean selfCapture])

Create new Actor.

Parameters:

el : String/HTMLElement
The dom element or element id
animator : YAHOO.ext.Animator
(optional) The Animator that will capture this Actor's actions
selfCapture : Boolean
(optional) Whether this actor should capture it's own actions to support self playback without an animator (defaults to false)

Method Details

addAsyncCall

public function addAsyncCall(Function fcn, Number callbackIndex, [Array args], [Object scope])

Capture an async function call.

Parameters:

fcn : Function
The function to call
callbackIndex : Number
The index of the callback parameter on the passed function. A CALLBACK IS REQUIRED.
args : Array
The arguments to call the function with
scope : Object
(optional) The scope of the function

Returns:

void

This method is defined by Actor.

addCall

public function addCall(Function fcn, [Array args], [Object scope])

Capture a function call.

Parameters:

fcn : Function
The function to call
args : Array
(optional) The arguments to call the function with
scope : Object
(optional) The scope of the function

Returns:

void

This method is defined by Actor.

addClass

public function addClass()

Capturing override - See YAHOO.ext.Element.addClass for method details.

Parameters:

None.

Returns:

void

This method is defined by Actor.

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.

addKeyListener

public function addKeyListener(Number/Array/Object/String key, Function fn, [Object scope])

Convenience method for constructing a KeyMap

Parameters:

key : Number/Array/Object/String
Either a string with the keys to listen for, the numeric key code, array of key codes or an object with the following options: {key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)}
fn : Function
The function to call
scope : Object
(optional) The scope of the function

Returns:

YAHOO.ext.KeyMap
The KeyMap created

This method is defined by Element.

addKeyMap

public function addKeyMap(Object config)

Creates a KeyMap for this element

Parameters:

config : Object
The KeyMap config. See YAHOO.ext.KeyMap for more details

Returns:

YAHOO.ext.KeyMap
The KeyMap created

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

Capturing and animation syncing override - See YAHOO.ext.Element.alignTo for method details.

Parameters:

None.

Returns:

void

This method is defined by Actor.

animate

public function animate()

Capturing and animation syncing override - See YAHOO.ext.Element.animate for method details.

Parameters:

None.

Returns:

void

This method is defined by Actor.

appear

public function appear([Float duration])

Fade an element in

Parameters:

duration : Float
(optional) How long the effect lasts (in seconds)

Returns:

void

This method is defined by Actor.

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

Capturing and animation syncing override - See YAHOO.ext.Element.autoHeight for method details.

Parameters:

None.

Returns:

void

This method is defined by Actor.

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.

blindHide

public function blindHide(String anchor, [Float duration], [Function easing])

Hide the element using a "blinds" effect

Parameters:

anchor : String
The part of the element that it should appear to collapse to. The short/long options are t/top, l/left, b/bottom, r/right.
duration : Float
(optional) How long the effect lasts (in seconds)
easing : Function
(optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeIn)

Returns:

void

This method is defined by Actor.

blindShow

public function blindShow(String anchor, [Number newSize], [Float duration], [Function easing])

Show the element using a "blinds" effect

Parameters:

anchor : String
The part of the element that it should appear to exapand from. The short/long options currently are t/top, l/left
newSize : Number
(optional) The size to animate to. (Default to current size)
duration : Float
(optional) How long the effect lasts (in seconds)
easing : Function
(optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeOut)

Returns:

void

This method is defined by Actor.

blur

public function blur()

Tries to blur the element. Any exceptions are caught.

Parameters:

None.

Returns:

YAHOO.ext.Element
this

This method is defined by Element.

bounce

public function bounce()

Bounce this element from up and down

Parameters:

None.

Returns:

void

This method is defined by Actor.

bufferedListener

public function bufferedListener(String eventName, Function handler, [Object scope], [Number millis])

Appends an event handler to this element that is buffered. If the event is triggered more than once in the specified time-frame, only the last one actually fires.

Parameters:

eventName : String
The type of event to listen for
handler : Function
The method the event invokes
scope : Object
(optional) The scope (this object) for the handler
millis : Number
(optional) The number of milliseconds to buffer (defaults to 250)

Returns:

Function
The wrapped function that was created (can be used to remove the listener)

This method is defined by Element.

capture

public function capture(YAHOO.ext.Actor.Action action)

Captures an action for this actor. Generally called internally but can be called directly.

Parameters:

action : YAHOO.ext.Actor.Action

Returns:

void

This method is defined by Actor.

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.

clear

public function clear()

Clears any calls that have been self captured.

Parameters:

None.

Returns:

void

This method is defined by Actor.

clearOpacity

public function clearOpacity()

Capturing override - See YAHOO.ext.Element.clearOpacity for method details.

Parameters:

None.

Returns:

void

This method is defined by Actor.

clearPositioning

public function clearPositioning()

Capturing override - See YAHOO.ext.Element.clearPositioning for method details.

Parameters:

None.

Returns:

void

This method is defined by Actor.

clip

public function clip()

Capturing override - See YAHOO.ext.Element.clip for method details.

Parameters:

None.

Returns:

void

This method is defined by Actor.

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.

dropOut

public function dropOut([Float duration])

Fade the element as it is falling from it's current position

Parameters:

duration : Float
(optional) How long the effect lasts (in seconds)

Returns:

void

This method is defined by Actor.

enableDisplayMode

public function enableDisplayMode()

Capturing override - See YAHOO.ext.Element.enableDisplayMode for method details.

Parameters:

None.

Returns:

void

This method is defined by Actor.

endMeasure

public function endMeasure()

Restores displays to before beginMeasure was called

Parameters:

None.

Returns:

YAHOO.ext.Element
this

This method is defined by Element.

fade

public function fade([Float duration])

Fade an element out

Parameters:

duration : Float
(optional) How long the effect lasts (in seconds)

Returns:

void

This method is defined by Actor.

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

Capturing override - See YAHOO.ext.Element.focus for method details.

Parameters:

None.

Returns:

void

This method is defined by Actor.

frame

public function frame([Number color], [Number count], [Float duration])

Show a ripple of exploding, attenuating borders to draw attention to an Element.

Parameters:

color : Number
(optional) The color of the border.
count : Number
(optional) How many ripples.
duration : Float
(optional) How long each ripple takes to expire

Returns:

void

This method is defined by Actor.

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.