Class YAHOO.ext.Actor

Object
   |
   +--YAHOO.ext.Element
         |
         +--YAHOO.ext.Actor
class YAHOO.ext.Actor
extends YAHOO.ext.Element


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

Defined in Actor.js

Requires:

Nested Class Summary
<static class> YAHOO.ext.Actor.Action
<static class> YAHOO.ext.Actor.AsyncAction
<static class> YAHOO.ext.Actor.PauseAction
 
Field Summary
 Function addClass
  Capturing override - See YAHOO.ext.Element.addClass() for method details.
 Function alignTo
  Capturing and animation syncing override - See YAHOO.ext.Element.alignTo() for method details.
 Object capturing
  Whether this actor is currently capturing
 Function clearOpacity
  Capturing override - See YAHOO.ext.Element.clearOpacity() for method details.
 Function clearPositioning
  Capturing override - See YAHOO.ext.Element.clearPositioning() for method details.
 Function clip
  Capturing override - See YAHOO.ext.Element.clip() for method details.
 Object el
  
 Function enableDisplayMode
  Capturing override - See YAHOO.ext.Element.enableDisplayMode() for method details.
 Function focus
  Capturing override - See YAHOO.ext.Element.focus() for method details.
 Function hide
  Capturing and animation syncing override - See YAHOO.ext.Element.hide() for method details.
 Function move
  Capturing and animation syncing override - See YAHOO.ext.Element.move() for method details.
 Function moveTo
  Capturing and animation syncing override - See YAHOO.ext.Element.moveTo() for method details.
 Object onCapture
  
 Object playlist
  
 Function removeClass
  Capturing override - See YAHOO.ext.Element.removeClass() for method details.
 Function replaceClass
  Capturing override - See YAHOO.ext.Element.replaceClass() for method details.
 Function setAbsolutePositioned
  Capturing override - See YAHOO.ext.Element.setAbsolutePositioned() for method details.
 Function setBounds
  Capturing and animation syncing override - See YAHOO.ext.Element.setBounds() for method details.
 Function setHeight
  Capturing and animation syncing override - See YAHOO.ext.Element.setHeight() for method details.
 Function setLeft
  Capturing override - See YAHOO.ext.Element.setLeft() for method details.
 Function setLocation
  Capturing and animation syncing override - See YAHOO.ext.Element.setLocation() for method details.
 Function setOpacity
  Capturing and animation syncing override - See YAHOO.ext.Element.setHeight() for method details.
 Function setPositioning
  Capturing override - See YAHOO.ext.Element.setPositioning() for method details.
 Function setRelativePositioned
  Capturing override - See YAHOO.ext.Element.setRelativePositioned() for method details.
 Function setSize
  Capturing and animation syncing override - See YAHOO.ext.Element.setSize() for method details.
 Function setStyle
  Capturing override - See YAHOO.ext.Element.setStyle() for method details.
 Function setTop
  Capturing override - See YAHOO.ext.Element.setTop() for method details.
 Function setVisibilityMode
  Capturing override - See YAHOO.ext.Element.setVisibilityMode() for method details.
 Function setVisible
  Capturing and animation syncing override - See YAHOO.ext.Element.setVisible() for method details.
 Function setWidth
  Capturing and animation syncing override - See YAHOO.ext.Element.setWidth() for method details.
 Function setX
  Capturing override - See YAHOO.ext.Element.setX() for method details.
 Function setXY
  Capturing and animation syncing override - See YAHOO.ext.Element.setXY() for method details.
 Function setY
  Capturing override - See YAHOO.ext.Element.setY() for method details.
 Function show
  Capturing and animation syncing override - See YAHOO.ext.Element.show() for method details.
 Function toggle
  Capturing and animation syncing override - See YAHOO.ext.Element.toggle() for method details.
 Function unclip
  Capturing override - See YAHOO.ext.Element.unclip() for method details.
 Function update
  Capturing override - See YAHOO.ext.Element.clearOpacity() for method details.
   
Fields inherited from class YAHOO.ext.Element
id, defaultUnit, onVisibilityChanged, onMoved, onResized, autoBoxAdjust
 
Constructor Summary
YAHOO.ext.Actor (element, <YAHOO.ext.Animator> animator, <Boolean> selfCapture)
  
 
Method Summary * Parameter types in italic indicate optional parameters
 void addAsyncCall(<Function> fcn, <Number> callbackIndex, <Array> args, <Object> scope)
   Capture an async function call.
 void addCall(<Function> fcn, <Array> args, <Object> scope)
   Capture a function call.
 Function animate(args, duration, onComplete, easing, animType)
   Capturing and animation syncing override - See YAHOO.ext.Element.animate() for method details.
 void appear(<Float> duration)
   Fade an element in
 Object blindHide(<String> anchor, <Float> duration, <Function> easing)
   Hide the element using a "blinds" effect
 Object blindShow(<String> anchor, <Number> newSize, <Float> duration, <Function> easing)
   Show the element using a "blinds" effect
 void bounce()
   Bounce this element from up and down
 Object capture(<YAHOO.ext.Actor.Action> action)
   Captures an action for this actor.
 void clear()
   Clears any calls that have been self captured.
 void dropOut(<Float> duration)
   Fade the element as it is falling from it's current position
 void fade(<Float> duration)
   Fade an element out
 void highlight(<String> color, <String> fromColor, <Float> duration, <String> attribute)
   Highlight the element using a background color (or passed attribute) animation
 void moveIn(<String> anchor, <Array> to, <Float> duration, <Function> easing)
   Show the element in a way that it appears as if it is flying onto the screen
 void moveOut(<String> anchor, <Float> duration, <Function> easing)
   Hide the element in a way that it appears as if it is flying off the screen
 void pause(<Number> seconds)
   Capture a pause (in seconds).
 void play(<Function> oncomplete)
   Starts playback of self captured calls.
 void pulsate(<Number> count, <Float> duration)
   Fade the element in and out the specified amount of times
 void shake()
   Shake this element from side to side
 Object slideHide(<String> anchor, <Float> duration, <Function> easing)
   Hide the element using a "slide in" effect - In order for this effect to work the element MUST have a child element container that can be "slid" otherwise a blindHide effect is rendered.
 Object slideShow(<String> anchor, <Number> newSize, <Float> duration, <Function> easing)
   Show the element using a "slide in" effect - In order for this effect to work the element MUST have a child element container that can be "slid" otherwise a blindShow effect is rendered.
 Object squish(<Float> duration)
   Hide the element by "squishing" it into the corner
 void startCapture()
   Start self capturing calls on this Actor.
 void stopCapture()
   Stop self capturing calls on this Actor.
 void switchOff(<Float> duration)
   Blink the element as if it was clicked and then collapse on it's center
 
Methods inherited from class YAHOO.ext.Element
setVisibilityMode, enableDisplayMode, isVisible, setVisible, toggle, focus, addClass, radioClass, removeClass, toggleClass, hasClass, replaceClass, getStyle, setStyle, getX, getY, getXY, setX, setY, setLeft, setTop, setRight, setBottom, setXY, setLocation, moveTo, getRegion, getHeight, getWidth, getSize, setWidth, setHeight, setSize, setBounds, setRegion, addListener, addHandler, on, addManagedListener, mon, removeListener, removeAllListeners, setOpacity, getLeft, getRight, getTop, getBottom, setAbsolutePositioned, setRelativePositioned, clearPositioning, getPositioning, getBorderWidth, getPadding, setPositioning, move, clip, unclip, alignTo, clearOpacity, hide, show, beginMeasure, endMeasure, update, getUpdateManager, getCenterXY, getChildrenByTagName, getChildrenByClassName, isBorderBox, getBox, setBox
 

Field Detail

addClass

Function addClass

alignTo

Function alignTo

capturing

Object capturing

clearOpacity

Function clearOpacity

clearPositioning

Function clearPositioning

clip

Function clip

el

Object el

enableDisplayMode

Function enableDisplayMode

focus

Function focus

hide

Function hide

move

Function move

moveTo

Function moveTo

onCapture

Object onCapture

playlist

Object playlist

removeClass

Function removeClass

replaceClass

Function replaceClass

setAbsolutePositioned

Function setAbsolutePositioned

setBounds

Function setBounds

setHeight

Function setHeight

setLeft

Function setLeft

setLocation

Function setLocation

setOpacity

Function setOpacity

setPositioning

Function setPositioning

setRelativePositioned

Function setRelativePositioned

setSize

Function setSize

setStyle

Function setStyle

setTop

Function setTop

setVisibilityMode

Function setVisibilityMode

setVisible

Function setVisible

setWidth

Function setWidth

setX

Function setX

setXY

Function setXY

setY

Function setY

show

Function show

toggle

Function toggle

unclip

Function unclip

update

Function update
Constructor Detail

YAHOO.ext.Actor

YAHOO.ext.Actor(element, <YAHOO.ext.Animator> animator, <Boolean> selfCapture)
Method Detail

addAsyncCall

void addAsyncCall(<Function> fcn, <Number> callbackIndex, <Array> args, <Object> scope)

addCall

void addCall(<Function> fcn, <Array> args, <Object> scope)

animate

Function animate(args, duration, onComplete, easing, animType)

appear

void appear(<Float> duration)

blindHide

Object blindHide(<String> anchor, <Float> duration, <Function> easing)

blindShow

Object blindShow(<String> anchor, <Number> newSize, <Float> duration, <Function> easing)

bounce

void bounce()

capture

Object capture(<YAHOO.ext.Actor.Action> action)

clear

void clear()

dropOut

void dropOut(<Float> duration)

fade

void fade(<Float> duration)

highlight

void highlight(<String> color, <String> fromColor, <Float> duration, <String> attribute)

moveIn

void moveIn(<String> anchor, <Array> to, <Float> duration, <Function> easing)

moveOut

void moveOut(<String> anchor, <Float> duration, <Function> easing)

pause

void pause(<Number> seconds)

play

void play(<Function> oncomplete)

pulsate

void pulsate(<Number> count, <Float> duration)

shake

void shake()

slideHide

Object slideHide(<String> anchor, <Float> duration, <Function> easing)

slideShow

Object slideShow(<String> anchor, <Number> newSize, <Float> duration, <Function> easing)

squish

Object squish(<Float> duration)

startCapture

void startCapture()

stopCapture

void stopCapture()

switchOff

void switchOff(<Float> duration)
Documentation generated by JSDoc on Sat Oct 14 06:07:10 2006