Classes

Files

Class YAHOO.widget.Overlay

Object
   |
   +--YAHOO.widget.Module
         |
         +--YAHOO.widget.Overlay
Direct Known Subclasses:
YAHOO.widget.Panel, YAHOO.widget.Tooltip
class YAHOO.widget.Overlay
extends YAHOO.widget.Module
Quick Links:  Field Summary | Constructor Summary | Method Summary | Method Details

Field Summary [top]

YAHOO.util.CustomEvent beforeMoveEvent
CustomEvent fired before the Overlay is moved. 
YAHOO.util.CustomEvent moveEvent
CustomEvent fired after the Overlay is moved. 
Object _initialized
 
string BOTTOM_LEFT
Constant representing the top bottom left corner of an element, used for configuring the context element alignment 
string BOTTOM_RIGHT
Constant representing the bottom right corner of an element, used for configuring the context element alignment 
string CSS_OVERLAY
Constant representing the default CSS class used for an Overlay 
string IFRAME_SRC
The URL of the blank image that will be placed in the iframe 
class superclass
Reference to the Overlay's superclass, Module 
string TOP_LEFT
Constant representing the top left corner of an element, used for configuring the context element alignment 
string TOP_RIGHT
Constant representing the top right corner of an element, used for configuring the context element alignment 
YAHOO.util.CustomEvent windowResizeEvent
A singleton CustomEvent used for reacting to the DOM event for window resize 
YAHOO.util.CustomEvent windowScrollEvent
A singleton CustomEvent used for reacting to the DOM event for window scroll 

Fields inherited from class YAHOO.widget.Module [top]

element, header, body, footer, id, childNodesInDOM, imageRoot, beforeInitEvent, initEvent, appendEvent, beforeRenderEvent, renderEvent, changeHeaderEvent, changeBodyEvent, changeFooterEvent, changeContentEvent, destroyEvent, beforeShowEvent, showEvent, beforeHideEvent, hideEvent

Constructor Summary [top]

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

Method Summary [top]

void align (<string> elementAlign, <string> contextAlign)
Aligns the Overlay to its context element using the specified corner points (represented by the constants TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, and BOTTOM_RIGHT. 
void center ()
Centers the container in the viewport. 
void configConstrainToViewport (type, args, obj)
The default event handler fired when the "constraintoviewport" property is changed. 
void configContext (type, args, obj)
The default event handler fired when the "context" property is changed. 
void configFixedCenter (type, args, obj)
The default event handler fired when the "fixedcenter" property is changed. 
void configHeight (type, args, obj)
The default event handler fired when the "height" property is changed. 
void configIframe (type, args, obj)
The default event handler fired when the "iframe" property is changed. 
void configVisible (type, args, obj)
The default event handler fired when the "visible" property is changed. 
void configWidth (type, args, obj)
The default event handler fired when the "width" property is changed. 
void configX (type, args, obj)
The default event handler fired when the "x" property is changed. 
void configXY (type, args, obj)
The default event handler fired when the "xy" property is changed. 
void configY (type, args, obj)
The default event handler fired when the "y" property is changed. 
void configzIndex (type, args, obj)
The default event handler fired when the "zIndex" property is changed. 
void doCenterOnDOMEvent ()
Center event handler used for centering on scroll/resize, but only if the Overlay is visible 
void enforceConstraints (type, args, obj)
The default event handler executed when the moveEvent is fired, if the "constraintoviewport" is set to true. 
void hideMacGeckoScrollbars ()
Adds a special CSS class to the Overlay when Mac/Gecko is in use, to work around a Gecko bug where scrollbars cannot be hidden. 
void init (<string> <Element> el, <object> userConfig)
The Module class's initialization method, which is executed for Module and all of its subclasses. 
void initDefaultConfig ()
Initializes the class's configurable properties which can be changed using the Overlay's Config object (cfg). 
void initEvents ()
Initializes the custom events for Overlay which are fired automatically at appropriate times by the Overlay class. 
void moveTo (<int> x, <int> y)
Moves the Overlay to the specified position. 
void onDomResize (e, obj)
Event handler fired when the resize monitor element is resized. 
void showMacGeckoScrollbars ()
Removes a special CSS class from the Overlay when Mac/Gecko is in use, to work around a Gecko bug where scrollbars cannot be hidden. 
void syncPosition ()
Synchronizes the Panel's "xy", "x", and "y" properties with the Panel's position in the DOM. 
Function windowResizeHandler (e)
The DOM event handler used to fire the CustomEvent for window resize 
Function windowScrollHandler (e)
The DOM event handler used to fire the CustomEvent for window scroll 

Methods inherited from class YAHOO.widget.Module

platform, browser, isSecure, initResizeMonitor, setHeader, appendToHeader, setBody, appendToBody, setFooter, appendToFooter, render, destroy, show, hide, configMonitorResize

Field Detail [top]

beforeMoveEvent

YAHOO.util.CustomEvent   beforeMoveEvent
CustomEvent fired before the Overlay is moved. args: x,y that the Overlay will be moved to

moveEvent

YAHOO.util.CustomEvent   moveEvent
CustomEvent fired after the Overlay is moved. args: x,y that the Overlay was moved to

_initialized

Object   _initialized

BOTTOM_LEFT

string   BOTTOM_LEFT
Constant representing the top bottom left corner of an element, used for configuring the context element alignment

BOTTOM_RIGHT

string   BOTTOM_RIGHT
Constant representing the bottom right corner of an element, used for configuring the context element alignment

CSS_OVERLAY

string   CSS_OVERLAY
Constant representing the default CSS class used for an Overlay

IFRAME_SRC

string   IFRAME_SRC
The URL of the blank image that will be placed in the iframe

superclass

class   superclass
Reference to the Overlay's superclass, Module

TOP_LEFT

string   TOP_LEFT
Constant representing the top left corner of an element, used for configuring the context element alignment

TOP_RIGHT

string   TOP_RIGHT
Constant representing the top right corner of an element, used for configuring the context element alignment

windowResizeEvent

YAHOO.util.CustomEvent   windowResizeEvent
A singleton CustomEvent used for reacting to the DOM event for window resize

windowScrollEvent

YAHOO.util.CustomEvent   windowScrollEvent
A singleton CustomEvent used for reacting to the DOM event for window scroll

Constructor Detail [top]

YAHOO.widget.Overlay

YAHOO.widget.Overlay ()
Copyright (c) 2006, Yahoo! Inc. All rights reserved. Code licensed under the BSD License: http://developer.yahoo.net/yui/license.txt
Parameters:
el - The element ID representing the Overlay OR
el - The element representing the Overlay
userConfig - The configuration object literal containing the configuration that should be set for this Overlay. See configuration documentation for more details.
HASH(0x1d8480c)

Method Detail [top]

align

void align (<string> elementAlign, <string> contextAlign)
Aligns the Overlay to its context element using the specified corner points (represented by the constants TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, and BOTTOM_RIGHT.
Parameters:
elementAlign - The string representing the corner of the Overlay that should be aligned to the context element
contextAlign - The corner of the context element that the elementAlign corner should stick to.
HASH(0x1d84158)

center

void center ()
Centers the container in the viewport. HASH(0x1d842cc)

configConstrainToViewport

void configConstrainToViewport (type, args, obj)
The default event handler fired when the "constraintoviewport" property is changed. HASH(0x1d842f0)

configContext

void configContext (type, args, obj)
The default event handler fired when the "context" property is changed. HASH(0x1db4714)

configFixedCenter

void configFixedCenter (type, args, obj)
The default event handler fired when the "fixedcenter" property is changed. HASH(0x1db4834)

configHeight

void configHeight (type, args, obj)
The default event handler fired when the "height" property is changed. HASH(0x1db4954)

configIframe

void configIframe (type, args, obj)
The default event handler fired when the "iframe" property is changed. HASH(0x1db4a74)

configVisible

void configVisible (type, args, obj)
The default event handler fired when the "visible" property is changed. This method is responsible for firing showEvent and hideEvent. HASH(0x1db4b94)

configWidth

void configWidth (type, args, obj)
The default event handler fired when the "width" property is changed. HASH(0x1db4cb4)

configX

void configX (type, args, obj)
The default event handler fired when the "x" property is changed. HASH(0x1db4dd4)

configXY

void configXY (type, args, obj)
The default event handler fired when the "xy" property is changed. HASH(0x1db4ef4)

configY

void configY (type, args, obj)
The default event handler fired when the "y" property is changed. HASH(0x1dcd540)

configzIndex

void configzIndex (type, args, obj)
The default event handler fired when the "zIndex" property is changed. HASH(0x1dcd660)

doCenterOnDOMEvent

void doCenterOnDOMEvent ()
Center event handler used for centering on scroll/resize, but only if the Overlay is visible HASH(0x1dcd780)

enforceConstraints

void enforceConstraints (type, args, obj)
The default event handler executed when the moveEvent is fired, if the "constraintoviewport" is set to true. HASH(0x1dcd8a0)

hideMacGeckoScrollbars

void hideMacGeckoScrollbars ()
Adds a special CSS class to the Overlay when Mac/Gecko is in use, to work around a Gecko bug where scrollbars cannot be hidden. See https://bugzilla.mozilla.org/show_bug.cgi?id=187435 HASH(0x1dcd9c0)

init

void init (<string> <Element> el, <object> userConfig)
The Module class's initialization method, which is executed for Module and all of its subclasses. This method is automatically called by the constructor, and sets up all DOM references for pre-existing markup, and creates required markup if it is not already present.
Parameters:
el - The element ID representing the Module OR
el - The element representing the Module
userConfig - The configuration object literal containing the configuration that should be set for this module. See configuration documentation for more details.
HASH(0x1dcdad4)

initDefaultConfig

void initDefaultConfig ()
Initializes the class's configurable properties which can be changed using the Overlay's Config object (cfg). HASH(0x1dcdc6c)

initEvents

void initEvents ()
Initializes the custom events for Overlay which are fired automatically at appropriate times by the Overlay class. HASH(0x1dcdd8c)

moveTo

void moveTo (<int> x, <int> y)
Moves the Overlay to the specified position. This function is identical to calling this.cfg.setProperty("xy", [x,y]);
Parameters:
x - The Overlay's new x position
y - The Overlay's new y position
HASH(0x1dcdea0)

onDomResize

void onDomResize (e, obj)
Event handler fired when the resize monitor element is resized. HASH(0x1dce014)

showMacGeckoScrollbars

void showMacGeckoScrollbars ()
Removes a special CSS class from the Overlay when Mac/Gecko is in use, to work around a Gecko bug where scrollbars cannot be hidden. See https://bugzilla.mozilla.org/show_bug.cgi?id=187435 HASH(0x1dce134)

syncPosition

void syncPosition ()
Synchronizes the Panel's "xy", "x", and "y" properties with the Panel's position in the DOM. This is primarily used to update position information during drag & drop. HASH(0x1dce254)

windowResizeHandler

Function windowResizeHandler (e)
The DOM event handler used to fire the CustomEvent for window resize HASH(0x1dce374)

windowScrollHandler

Function windowScrollHandler (e)
The DOM event handler used to fire the CustomEvent for window scroll HASH(0x1dce494)