Classes

Files

Class YAHOO.widget.OverlayEffect

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

Field Summary [top]

Object animateInCompleteEvent
 
Object animateOutCompleteEvent
 
Object attrIn
 
Object attrOut
 
Object beforeAnimateInEvent
 
Object beforeAnimateOutEvent
 
Object overlay
 
Object targetElement
 

Constructor Summary [top]

YAHOO.widget.OverlayEffect
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 (animClass)
Initializes the animation classes and events. 
OverlayEffect FADE (overlay, dur)
A pre-configured OverlayEffect instance that can be used for fading an overlay in and out. 
OverlayEffect SLIDE (overlay, dur)
A pre-configured OverlayEffect instance that can be used for sliding an overlay in and out. 

Field Detail [top]

animateInCompleteEvent

Object   animateInCompleteEvent

animateOutCompleteEvent

Object   animateOutCompleteEvent

attrIn

Object   attrIn

attrOut

Object   attrOut

beforeAnimateInEvent

Object   beforeAnimateInEvent

beforeAnimateOutEvent

Object   beforeAnimateOutEvent

overlay

Object   overlay

targetElement

Object   targetElement

Constructor Detail [top]

YAHOO.widget.OverlayEffect

YAHOO.widget.OverlayEffect ()
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.
HASH(0x1cbafdc)

Method Detail [top]

animateIn

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

animateOut

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

handleCompleteAnimateIn

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

handleCompleteAnimateOut

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

handleStartAnimateIn

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

handleStartAnimateOut

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

handleTweenAnimateIn

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

handleTweenAnimateOut

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

init

void init (animClass)
Initializes the animation classes and events.
Parameters:
Optional - . The animation class to instantiate. Defaults to YAHOO.util.Anim. Other options include YAHOO.util.Motion.
HASH(0x1db2188)

FADE

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

SLIDE

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