API: container YAHOO.widget.OverlayManager (YUI Library)

Class YAHOO.widget.OverlayManager

OverlayManager is used for maintaining the focus status of multiple Overlays.* @namespace YAHOO.widget

Constructor

YAHOO.widget.OverlayManager

Parameters:: overlays <Array> Optional. A collection of Overlays to register with the manager.; userConfig <Object> The object literal representing the user configuration of the OverlayManager

Properties

activeOverlay `- private YAHOO.widget.Overlay`

The currently activated Overlay

cfg `- YAHOO.util.Config`

The OverlayManager's Config object used for monitoring configuration properties.

contructor `- Function`

The class's constructor function

overlays `- YAHOO.widget.Overlay[]`

The array of Overlays that are currently registered

YAHOO.widget.OverlayManager.CSS_FOCUSED `- static final String`

The CSS class representing a focused Overlay

Methods

blurAll

Removes focus from all registered Overlays in the manager

Returns: void

compareZIndexDesc


                                         private 
                                        
                                        
                                        Number
                                            compareZIndexDesc
                                           (
                                            )

Used for sorting the manager's Overlays by z-index.

Returns: Number: 0, 1, or -1, depending on where the Overlay should fall in the stacking order.

find


                                        
                                        
                                        
                                        YAHOO.widget.Overlay
                                            find
                                           (
                                                
                                                        
                                                         overlay
                                                    
                                                

                                                
                                            )

Attempts to locate an Overlay by instance or ID.

Parameters:: overlay <YAHOO.widget.Overlay> An Overlay to locate within the manager; overlay <String> An Overlay id to locate within the manager

Returns: YAHOO.widget.Overlay: The requested Overlay, if found, or null if it cannot be located.

focus

Focuses the specified Overlay

Parameters:: overlay <YAHOO.widget.Overlay> The Overlay to focus; overlay <String> The id of the Overlay to focus

Returns: void

getActive


                                        
                                        
                                        
                                        YAHOO.widget.Overlay
                                            getActive
                                           (
                                            )

Returns the currently focused Overlay

Returns: YAHOO.widget.Overlay: The currently focused Overlay

hideAll

Hides all Overlays in the manager.

Returns: void

init

Initializes the OverlayManager

Parameters:: overlays <YAHOO.widget.Overlay[]> Optional. A collection of Overlays to register with the manager.; userConfig <Object> The object literal representing the user configuration of the OverlayManager

Returns: void

initDefaultConfig


                                        
                                        
                                        
                                        void
                                            initDefaultConfig
                                           (
                                            )

Initializes the default configuration of the OverlayManager

Returns: void

register

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 <YAHOO.widget.Overlay> An Overlay to register with the manager.; overlay <YAHOO.widget.Overlay[]> An array of Overlays to register with the manager.

Returns: Boolean: True if any Overlays are registered.

remove

Removes the specified Overlay from the manager

Parameters:: overlay <YAHOO.widget.Overlay> The Overlay to remove; overlay <String> The id of the Overlay to remove

Returns: void

showAll

Shows all Overlays in the manager.

Returns: void

toString

Returns a string representation of the object.

Returns: String: The string representation of the OverlayManager

Configuration Attributes

focusevent `- String`

The default DOM event that should be used to focus an Overlay

Default Value: "mousedown"

overlays `- YAHOO.widget.Overlay[]`

The collection of registered Overlays in use by the OverlayManager

Default Value: null

Yahoo! UI Library

Container

Class YAHOO.widget.OverlayManager

activeOverlay - private YAHOO.widget.Overlay

cfg - YAHOO.util.Config

contructor - Function

overlays - YAHOO.widget.Overlay[]

YAHOO.widget.OverlayManager.CSS_FOCUSED - static final String

focusevent - String

overlays - YAHOO.widget.Overlay[]

Modules

Classes

Files

Properties

Methods

Configuration Attributes

square

line

black

north

more

knew

rail

knew

control

lay

differ

wing

dance

fresh

must

opposite

these

up

wall

final

both

use

red

reach

found

system

solve

south

try

dictionary

and

stay

offer

push

clear

clothe

nothing

process

wear

gone

what

name

divide

test

force

kept

metal

enough

clock

clothe

captain

speech

clock

road

supply

probable

experience

paint

subtract

view

hot

dollar

want

swing dancing upskirt

activeOverlay `- private YAHOO.widget.Overlay`

cfg `- YAHOO.util.Config`

contructor `- Function`

overlays `- YAHOO.widget.Overlay[]`

YAHOO.widget.OverlayManager.CSS_FOCUSED `- static final String`

focusevent `- String`

overlays `- YAHOO.widget.Overlay[]`