JavaScript Documentation -

Class YAHOO.widget.Overlay

Object
   |
   +--YAHOO.widget.Overlay

class YAHOO.widget.Overlay

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.
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
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

Constructor Summary [top]


						YAHOO.widget.Overlay

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	`destroy ()` Removes the Overlay element from the DOM and sets all child elements to null.
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 Overlay initialization method, which is executed for Overlay 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.
string	`toString ()` Returns a string representation of the object.
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

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

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

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
							()

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(0x1ce14e4)

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(0x1d1d064)

center


								void 
								center
								()

Centers the container in the viewport. HASH(0x1d1d334)

configConstrainToViewport


								void 
								configConstrainToViewport
								(type, args, obj)

The default event handler fired when the "constraintoviewport" property is changed. HASH(0x1d1d40c)

configContext


								void 
								configContext
								(type, args, obj)

The default event handler fired when the "context" property is changed. HASH(0x1da2a40)

configFixedCenter


								void 
								configFixedCenter
								(type, args, obj)

The default event handler fired when the "fixedcenter" property is changed. HASH(0x1da2b60)

configHeight


								void 
								configHeight
								(type, args, obj)

The default event handler fired when the "height" property is changed. HASH(0x1da2c80)

configIframe


								void 
								configIframe
								(type, args, obj)

The default event handler fired when the "iframe" property is changed. HASH(0x1da2da0)

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(0x1da2ec0)

configWidth


								void 
								configWidth
								(type, args, obj)

The default event handler fired when the "width" property is changed. HASH(0x1da2fe0)

configX


								void 
								configX
								(type, args, obj)

The default event handler fired when the "x" property is changed. HASH(0x1da8b6c)

configXY


								void 
								configXY
								(type, args, obj)

The default event handler fired when the "xy" property is changed. HASH(0x1da8c8c)

configY


								void 
								configY
								(type, args, obj)

The default event handler fired when the "y" property is changed. HASH(0x1da8dac)

configzIndex


								void 
								configzIndex
								(type, args, obj)

The default event handler fired when the "zIndex" property is changed. HASH(0x1da8ecc)

destroy


								void 
								destroy
								()

Removes the Overlay element from the DOM and sets all child elements to null. HASH(0x1da8fec)

doCenterOnDOMEvent


								void 
								doCenterOnDOMEvent
								()

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

enforceConstraints


								void 
								enforceConstraints
								(type, args, obj)

The default event handler executed when the moveEvent is fired, if the "constraintoviewport" is set to true. HASH(0x1da922c)

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(0x1da934c)

init


								void 
								init
								(<string> <Element> el, <object> userConfig)

The Overlay initialization method, which is executed for Overlay 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 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(0x1da9460)

initDefaultConfig


								void 
								initDefaultConfig
								()

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

initEvents


								void 
								initEvents
								()

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

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(0x1da9838)

onDomResize


								void 
								onDomResize
								(e, obj)

Event handler fired when the resize monitor element is resized. HASH(0x1da99ac)

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(0x1d600b0)

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(0x1d601d0)

toString


								string 
								toString
								()

Returns a string representation of the object. HASH(0x1d602f0)

windowResizeHandler


								Function 
								windowResizeHandler
								(e)

The DOM event handler used to fire the CustomEvent for window resize HASH(0x1d60410)

windowScrollHandler


								Function 
								windowScrollHandler
								(e)

The DOM event handler used to fire the CustomEvent for window scroll HASH(0x1d60530)