Classes

Files

Class YAHOO.widget.OverlayManager

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

Field Summary [top]

Array overlays
The array of Overlays that are currently registered 
string CSS_FOCUSED
The CSS class representing a focused Overlay 

Constructor Summary [top]

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

Method Summary [top]

void blurAll ()
Removes focus from all registered Overlays in the manager 
Object compareZIndexDesc (o1, o2)
Used for sorting the manager's Overlays by z-index. 
Overlay find (<Overlay> <string> overlay)
Attempts to locate an Overlay by instance or ID. 
void focus (overlay)
Focuses the specified Overlay 
Overlay getActive ()
Returns the currently focused Overlay 
void hideAll ()
Hides all Overlays in the manager. 
void init (<object> userConfig)
Initializes the OverlayManager 
void initDefaultConfig ()
Initializes the default configuration of the OverlayManager 
boolean register (<Overlay> overlay)
Registers an Overlay or an array of Overlays with the manager. 
void remove (overlay)
Removes the specified Overlay from the manager 
void showAll ()
Shows all Overlays in the manager. 

Field Detail [top]

overlays

Array   overlays
The array of Overlays that are currently registered

CSS_FOCUSED

string   CSS_FOCUSED
The CSS class representing a focused Overlay

Constructor Detail [top]

YAHOO.widget.OverlayManager

YAHOO.widget.OverlayManager ()
Copyright (c) 2006, Yahoo! Inc. All rights reserved. Code licensed under the BSD License: http://developer.yahoo.net/yui/license.txt
Parameters:
overlays - Optional. A collection of Overlays to register with the manager.
userConfig - The object literal representing the user configuration of the OverlayManager
HASH(0x1db3c04)

Method Detail [top]

blurAll

void blurAll ()
Removes focus from all registered Overlays in the manager HASH(0x1d78748)

compareZIndexDesc

Object compareZIndexDesc (o1, o2)
Used for sorting the manager's Overlays by z-index. HASH(0x1d78c7c)

find

Overlay find (<Overlay> <string> overlay)
Attempts to locate an Overlay by instance or ID.
Parameters:
overlay - An Overlay to locate within the manager
overlay - An Overlay id to locate within the manager
Returns:
The requested Overlay, if found, or null if it cannot be located.
HASH(0x1d78d60)

focus

void focus (overlay)
Focuses the specified Overlay
Parameters:
The - Overlay to focus
The - id of the Overlay to focus
HASH(0x1d78f94)

getActive

Overlay getActive ()
Returns the currently focused Overlay
Returns:
The currently focused Overlay
HASH(0x1d84248)

hideAll

void hideAll ()
Hides all Overlays in the manager. HASH(0x1d848b4)

init

void init (<object> userConfig)
Initializes the OverlayManager
Parameters:
userConfig - The object literal representing the user configuration of the OverlayManager
overlays - Optional. A collection of Overlays to register with the manager.
HASH(0x1db4744)

initDefaultConfig

void initDefaultConfig ()
Initializes the default configuration of the OverlayManager HASH(0x1db4a2c)

register

boolean register (<Overlay> overlay)
Registers an Overlay or an array of Overlays with the manager. Upon registration, the Overlay receives functions for focus and blur, along with CustomEvents for each.
Parameters:
overlay - An Overlay to register with the manager.
Overlay - []} overlay An array of Overlays to register with the manager.
Returns:
True if any Overlays are registered.
HASH(0x1db4b04)

remove

void remove (overlay)
Removes the specified Overlay from the manager
Parameters:
The - Overlay to remove
The - id of the Overlay to remove
HASH(0x1db4d68)

showAll

void showAll ()
Shows all Overlays in the manager. HASH(0x1db4f84)