Yahoo! UI Library

overlay 3.3.0pr1

Yahoo! UI Library > overlay > Overlay

Class Overlay - extends Widget - uses WidgetStdMod , WidgetPosition , WidgetStack , WidgetPositionAlign , WidgetPositionConstrain

A basic Overlay Widget, which can be positioned based on Page XY co-ordinates and is stackable (z-index support). It also provides alignment and centering support and uses a standard module format for it's content, with header, body and footer section support.

Constructor

Overlay

Parameters:: object <Object> The user configuration for the instance.

Properties inherited from Plugin.Host:


                                    
                                        
                                        PluginHost

Properties inherited from Widget:


                                    
                                        
                                        _UI_ATTRS,
                                        
                                    
                                        
                                        BOUNDING_TEMPLATE,
                                        
                                    
                                        
                                        CONTENT_TEMPLATE,
                                        
                                    
                                        
                                        DEF_PARENT_NODE,
                                        
                                    
                                        
                                        DEF_UNIT,
                                        
                                    
                                        
                                        UI_EVENTS

Properties inherited from WidgetStack:

Properties inherited from Attribute:

Properties inherited from WidgetPositionAlign:

Properties inherited from Base:


                                    
                                        
                                        name

Properties inherited from WidgetStdMod:

Properties inherited from WidgetPosition:

Properties inherited from WidgetPositionConstrain:

Methods inherited from Plugin.Host:


                                                                                    
                                            _destroyPlugins,
                                            
                                                                                    
                                            _initPlugins,
                                            
                                                                                    
                                            hasPlugin,
                                            
                                                                                    
                                            plug,
                                            
                                                                                    
                                            unplug

Methods inherited from Widget:


                                                                                    
                                            _applyParsedConfig,
                                            
                                                                                    
                                            _applyParser,
                                            
                                                                                    
                                            _bindAttrUI,
                                            
                                                                                    
                                            _bindDOM,
                                            
                                                                                    
                                            _bindUI,
                                            
                                                                                    
                                            _createUIEvent,
                                            
                                                                                    
                                            _defaultCB,
                                            
                                                                                    
                                            _defRenderFn,
                                            
                                                                                    
                                            _getHtmlParser,
                                            
                                                                                    
                                            _getSrcNode,
                                            
                                                                                    
                                            _getStrings,
                                            
                                                                                    
                                            _getUIEventNode,
                                            
                                                                                    
                                            _guid,
                                            
                                                                                    
                                            _initUIEvent,
                                            
                                                                                    
                                            _isUIEvent,
                                            
                                                                                    
                                            _onDocFocus,
                                            
                                                                                    
                                            _onDocMouseDown,
                                            
                                                                                    
                                            _removeLoadingClassNames,
                                            
                                                                                    
                                            _renderBox,
                                            
                                                                                    
                                            _renderBoxClassNames,
                                            
                                                                                    
                                            _renderUI,
                                            
                                                                                    
                                            _setAttrUI,
                                            
                                                                                    
                                            _setBB,
                                            
                                                                                    
                                            _setBox,
                                            
                                                                                    
                                            _setCB,
                                            
                                                                                    
                                            _setStrings,
                                            
                                                                                    
                                            _strSetter,
                                            
                                                                                    
                                            _syncAttrUI,
                                            
                                                                                    
                                            _syncUI,
                                            
                                                                                    
                                            _uiSetDim,
                                            
                                                                                    
                                            _uiSetDisabled,
                                            
                                                                                    
                                            _uiSetFocused,
                                            
                                                                                    
                                            _uiSetHeight,
                                            
                                                                                    
                                            _uiSetTabIndex,
                                            
                                                                                    
                                            _uiSetVisible,
                                            
                                                                                    
                                            _uiSetWidth,
                                            
                                                                                    
                                            _uiSizeCB,
                                            
                                                                                    
                                            _unbindDOM,
                                            
                                                                                    
                                            _unbindUI,
                                            
                                                                                    
                                            _validTabIndex,
                                            
                                                                                    
                                            bindUI,
                                            
                                                                                    
                                            blur,
                                            
                                                                                    
                                            destructor,
                                            
                                                                                    
                                            disable,
                                            
                                                                                    
                                            enable,
                                            
                                                                                    
                                            focus,
                                            
                                                                                    
                                            getClassName,
                                            
                                                                                    
                                            getDefaultLocale,
                                            
                                                                                    
                                            getSkinName,
                                            
                                                                                    
                                            getString,
                                            
                                                                                    
                                            getStrings,
                                            
                                                                                    
                                            hide,
                                            
                                                                                    
                                            initializer,
                                            
                                                                                    
                                            render,
                                            
                                                                                    
                                            renderer,
                                            
                                                                                    
                                            renderUI,
                                            
                                                                                    
                                            show,
                                            
                                                                                    
                                            syncUI,
                                            
                                                                                    
                                            toString

Methods inherited from WidgetStack:


                                                                                    
                                            _addShimResizeHandlers,
                                            
                                                                                    
                                            _afterShimChange,
                                            
                                                                                    
                                            _afterZIndexChange,
                                            
                                                                                    
                                            _bindUIStack,
                                            
                                                                                    
                                            _destroyShim,
                                            
                                                                                    
                                            _detachStackHandles,
                                            
                                                                                    
                                            _getShimTemplate,
                                            
                                                                                    
                                            _renderShim,
                                            
                                                                                    
                                            _renderShimDeferred,
                                            
                                                                                    
                                            _renderUIStack,
                                            
                                                                                    
                                            _setZIndex,
                                            
                                                                                    
                                            _syncUIStack,
                                            
                                                                                    
                                            _uiSetShim,
                                            
                                                                                    
                                            _uiSetZIndex,
                                            
                                                                                    
                                            sizeShim

Methods inherited from Attribute:


                                                                                    
                                            _addAttrs,
                                            
                                                                                    
                                            _addLazyAttr,
                                            
                                                                                    
                                            _defAttrChangeFn,
                                            
                                                                                    
                                            _fireAttrChange,
                                            
                                                                                    
                                            _getAttr,
                                            
                                                                                    
                                            _getAttrCfg,
                                            
                                                                                    
                                            _getAttrInitVal,
                                            
                                                                                    
                                            _getAttrs,
                                            
                                                                                    
                                            _getStateVal,
                                            
                                                                                    
                                            _isLazyAttr,
                                            
                                                                                    
                                            _normAttrVals,
                                            
                                                                                    
                                            _protectAttrs,
                                            
                                                                                    
                                            _set,
                                            
                                                                                    
                                            _setAttr,
                                            
                                                                                    
                                            _setAttrs,
                                            
                                                                                    
                                            _setAttrVal,
                                            
                                                                                    
                                            _setStateVal,
                                            
                                                                                    
                                            addAttr,
                                            
                                                                                    
                                            addAttrs,
                                            
                                                                                    
                                            attrAdded,
                                            
                                                                                    
                                            get,
                                            
                                                                                    
                                            getAttrs,
                                            
                                                                                    
                                            modifyAttr,
                                            
                                                                                    
                                            removeAttr,
                                            
                                                                                    
                                            reset,
                                            
                                                                                    
                                            set,
                                            
                                                                                    
                                            setAttrs

Methods inherited from WidgetPositionAlign:


                                                                                    
                                            _afterAlignChange,
                                            
                                                                                    
                                            _bindUIStack,
                                            
                                                                                    
                                            _doAlign,
                                            
                                                                                    
                                            _setAlignCenter,
                                            
                                                                                    
                                            _syncUIPosAlign,
                                            
                                                                                    
                                            _uiSetAlign,
                                            
                                                                                    
                                            align,
                                            
                                                                                    
                                            centered

Methods inherited from EventTarget:


                                                                                    
                                            _getType,
                                            
                                                                                    
                                            _monitor,
                                            
                                                                                    
                                            _parseType,
                                            
                                                                                    
                                            addTarget,
                                            
                                                                                    
                                            after,
                                            
                                                                                    
                                            before,
                                            
                                                                                    
                                            bubble,
                                            
                                                                                    
                                            detach,
                                            
                                                                                    
                                            detachAll,
                                            
                                                                                    
                                            fire,
                                            
                                                                                    
                                            getEvent,
                                            
                                                                                    
                                            getTargets,
                                            
                                                                                    
                                            on,
                                            
                                                                                    
                                            once,
                                            
                                                                                    
                                            publish,
                                            
                                                                                    
                                            removeTarget,
                                            
                                                                                    
                                            subscribe,
                                            
                                                                                    
                                            unsubscribe,
                                            
                                                                                    
                                            unsubscribeAll

Methods inherited from Base:


                                                                                    
                                            _aggregateAttrs,
                                            
                                                                                    
                                            _defDestroyFn,
                                            
                                                                                    
                                            _defInitFn,
                                            
                                                                                    
                                            _destroyHierarchy,
                                            
                                                                                    
                                            _filterAttrCfs,
                                            
                                                                                    
                                            _getAttrCfgs,
                                            
                                                                                    
                                            _getClasses,
                                            
                                                                                    
                                            _initHierarchy,
                                            
                                                                                    
                                            _initHierarchyData,
                                            
                                                                                    
                                            _preInitEventCfg,
                                            
                                                                                    
                                            destroy,
                                            
                                                                                    
                                            init,
                                            
                                                                                    
                                            toString

Methods inherited from WidgetStdMod:


                                                                                    
                                            _addNodeHTML,
                                            
                                                                                    
                                            _addNodeRef,
                                            
                                                                                    
                                            _afterBodyChange,
                                            
                                                                                    
                                            _afterFillHeightChange,
                                            
                                                                                    
                                            _afterFooterChange,
                                            
                                                                                    
                                            _afterHeaderChange,
                                            
                                                                                    
                                            _applyStdModParsedConfig,
                                            
                                                                                    
                                            _bindUIStdMod,
                                            
                                                                                    
                                            _eraseStdMod,
                                            
                                                                                    
                                            _fillHeight,
                                            
                                                                                    
                                            _findStdModSection,
                                            
                                                                                    
                                            _getPreciseHeight,
                                            
                                                                                    
                                            _getStdModContent,
                                            
                                                                                    
                                            _getStdModTemplate,
                                            
                                                                                    
                                            _insertStdModSection,
                                            
                                                                                    
                                            _parseStdModHTML,
                                            
                                                                                    
                                            _renderStdMod,
                                            
                                                                                    
                                            _renderUIStdMod,
                                            
                                                                                    
                                            _syncUIStdMod,
                                            
                                                                                    
                                            _uiSetFillHeight,
                                            
                                                                                    
                                            _uiSetStdMod,
                                            
                                                                                    
                                            _validateFillHeight,
                                            
                                                                                    
                                            fillHeight,
                                            
                                                                                    
                                            getStdModNode,
                                            
                                                                                    
                                            setStdModContent

Methods inherited from WidgetPosition:


                                                                                    
                                            _afterXYChange,
                                            
                                                                                    
                                            _bindUIPosition,
                                            
                                                                                    
                                            _getX,
                                            
                                                                                    
                                            _getY,
                                            
                                                                                    
                                            _renderUIPosition,
                                            
                                                                                    
                                            _setX,
                                            
                                                                                    
                                            _setY,
                                            
                                                                                    
                                            _syncUIPosition,
                                            
                                                                                    
                                            _uiSetXY,
                                            
                                                                                    
                                            _validateXY,
                                            
                                                                                    
                                            move,
                                            
                                                                                    
                                            syncXY

Methods inherited from WidgetPositionConstrain:


                                                                                    
                                            _afterConstrainChange,
                                            
                                                                                    
                                            _bindUIPosConstrained,
                                            
                                                                                    
                                            _constrain,
                                            
                                                                                    
                                            _constrainOnXYChange,
                                            
                                                                                    
                                            _getRegion,
                                            
                                                                                    
                                            _preventOverlap,
                                            
                                                                                    
                                            _setConstrain,
                                            
                                                                                    
                                            constrain,
                                            
                                                                                    
                                            enable or disable constraints listeners,
                                            
                                                                                    
                                            getConstrainedXY

Events inherited from Widget:


                                        
                                        boundingBoxChange,
                                        
                                                                            
                                        contentBoxChange,
                                        
                                                                            
                                        disabledChange,
                                        
                                                                            
                                        focusedChange,
                                        
                                                                            
                                        heightChange,
                                        
                                                                            
                                        idChange,
                                        
                                                                            
                                        localeChange,
                                        
                                                                            
                                        renderChange,
                                        
                                                                            
                                        renderedChange,
                                        
                                                                            
                                        srcNodeChange,
                                        
                                                                            
                                        stringsChange,
                                        
                                                                            
                                        tabIndexChange,
                                        
                                                                            
                                        visibleChange,
                                        
                                                                            
                                        widget:contentUpdate,
                                        
                                                                            
                                        widget:render,
                                        
                                                                            
                                        widthChange,

Events inherited from WidgetStack:


                                        
                                        shimChange,
                                        
                                                                            
                                        zIndexChange,

Events inherited from WidgetPositionAlign:


                                        
                                        alignChange,
                                        
                                                                            
                                        centeredChange,

Events inherited from Base:


                                        
                                        destroy,
                                        
                                                                            
                                        destroyedChange,
                                        
                                                                            
                                        init,
                                        
                                                                            
                                        initializedChange,

Events inherited from WidgetStdMod:


                                        
                                        bodyContentChange,
                                        
                                                                            
                                        fillHeightChange,
                                        
                                                                            
                                        footerContentChange,
                                        
                                                                            
                                        headerContentChange,

Events inherited from WidgetPosition:

Events inherited from WidgetPositionConstrain:


                                        
                                        constrainChange,
                                        
                                                                            
                                        preventOverlapChange,

Configuration attributes inherited from Widget:


                                                                                
                                        boundingBox,
                                        
                                                                                                                        
                                        contentBox,
                                        
                                                                                                                        
                                        disabled,
                                        
                                                                                                                        
                                        focused,
                                        
                                                                                                                        
                                        height,
                                        
                                                                                                                        
                                        id,
                                        
                                                                                                                        
                                        locale
                                        
                                                                                                                        
                                        render
                                        
                                                                                                                        
                                        rendered
                                        
                                                                                                                        
                                        srcNode
                                        
                                                                                                                        
                                        strings
                                        
                                                                                                                        
                                        tabIndex
                                        
                                                                                                                        
                                        visible
                                        
                                                                                                                        
                                        width

Configuration attributes inherited from WidgetStack:

Configuration attributes inherited from WidgetPositionAlign:

Configuration attributes inherited from Base:


                                                                                
                                        destroyed
                                        
                                                                                                                        
                                        initialized

Configuration attributes inherited from WidgetStdMod:


                                                                                
                                        bodyContent,
                                        
                                                                                                                        
                                        fillHeight
                                        
                                                                                                                        
                                        footerContent
                                        
                                                                                                                        
                                        headerContent

Configuration attributes inherited from WidgetPosition:

Configuration attributes inherited from WidgetPositionConstrain:


                                                                                
                                        constrain
                                        
                                                                                                                        
                                        preventOverlap