Classes

Files

Class YAHOO.widget.ContainerEffect

Object
   |
   +--YAHOO.widget.ContainerEffect
class YAHOO.widget.ContainerEffect
Quick Links:  Field Summary | Constructor Summary | Method Summary | Method Details

Field Summary [top]

Object animClass
The animation class to use for animating the overlay 
Object attrIn
The animation attributes to use when transitioning into view 
Object attrOut
The animation attributes to use when transitioning out of view 
Object overlay
The overlay to animate 
Object targetElement
The target element to be animated 

Constructor Summary [top]

YAHOO.widget.ContainerEffect
Copyright (c) 2006, Yahoo! 

Method Summary [top]

void animateIn ()
Triggers the in-animation. 
void animateOut ()
Triggers the out-animation. 
void handleCompleteAnimateIn (type, args, obj)
The default onComplete handler for the in-animation. 
void handleCompleteAnimateOut (type, args, obj)
The default onComplete handler for the out-animation. 
void handleStartAnimateIn (type, args, obj)
The default onStart handler for the in-animation. 
void handleStartAnimateOut (type, args, obj)
The default onStart handler for the out-animation. 
void handleTweenAnimateIn (type, args, obj)
The default onTween handler for the in-animation. 
void handleTweenAnimateOut (type, args, obj)
The default onTween handler for the out-animation. 
void init ()
Initializes the animation classes and events. 
string toString ()
Returns a string representation of the object. 
ContainerEffect FADE (overlay, dur)
A pre-configured ContainerEffect instance that can be used for fading an overlay in and out. 
ContainerEffect SLIDE (overlay, dur)
A pre-configured ContainerEffect instance that can be used for sliding an overlay in and out. 

Field Detail [top]

animClass

Object   animClass
The animation class to use for animating the overlay

attrIn

Object   attrIn
The animation attributes to use when transitioning into view

attrOut

Object   attrOut
The animation attributes to use when transitioning out of view

overlay

Object   overlay
The overlay to animate

targetElement

Object   targetElement
The target element to be animated

Constructor Detail [top]

YAHOO.widget.ContainerEffect

YAHOO.widget.ContainerEffect ()
Copyright (c) 2006, Yahoo! Inc. All rights reserved. Code licensed under the BSD License: http://developer.yahoo.net/yui/license.txt
Parameters:
overlay - The Overlay that the animation should be associated with
attrIn - The object literal representing the animation arguments to be used for the animate-in transition. The arguments for this literal are: attributes(object, see YAHOO.util.Anim for description), duration(float), and method(i.e. YAHOO.util.Easing.easeIn).
attrOut - The object literal representing the animation arguments to be used for the animate-out transition. The arguments for this literal are: attributes(object, see YAHOO.util.Anim for description), duration(float), and method(i.e. YAHOO.util.Easing.easeIn).
targetElement - Optional. The target element that should be animated during the transition. Defaults to overlay.element.
Optional - . The animation class to instantiate. Defaults to YAHOO.util.Anim. Other options include YAHOO.util.Motion.
HASH(0x1d7c2f0)

Method Detail [top]

animateIn

void animateIn ()
Triggers the in-animation. HASH(0x1d04cb8)

animateOut

void animateOut ()
Triggers the out-animation. HASH(0x1d0515c)

handleCompleteAnimateIn

void handleCompleteAnimateIn (type, args, obj)
The default onComplete handler for the in-animation. HASH(0x1cbdb5c)

handleCompleteAnimateOut

void handleCompleteAnimateOut (type, args, obj)
The default onComplete handler for the out-animation. HASH(0x1d239b0)

handleStartAnimateIn

void handleStartAnimateIn (type, args, obj)
The default onStart handler for the in-animation. HASH(0x1d23b24)

handleStartAnimateOut

void handleStartAnimateOut (type, args, obj)
The default onStart handler for the out-animation. HASH(0x1d23df4)

handleTweenAnimateIn

void handleTweenAnimateIn (type, args, obj)
The default onTween handler for the in-animation. HASH(0x1dcdba4)

handleTweenAnimateOut

void handleTweenAnimateOut (type, args, obj)
The default onTween handler for the out-animation. HASH(0x1dcddfc)

init

void init ()
Initializes the animation classes and events. HASH(0x1cbdc1c)

toString

string toString ()
Returns a string representation of the object. HASH(0x1d473f0)

FADE

ContainerEffect FADE (overlay, dur)
A pre-configured ContainerEffect instance that can be used for fading an overlay in and out.
Parameters:
The - Overlay object to animate
The - duration of the animation
HASH(0x1d47534)

SLIDE

ContainerEffect SLIDE (overlay, dur)
A pre-configured ContainerEffect instance that can be used for sliding an overlay in and out.
Parameters:
The - Overlay object to animate
The - duration of the animation
HASH(0x1cbdcac)