2223 lines
120 KiB
HTML
2223 lines
120 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
<html>
|
|
<head>
|
|
<title>API: container YAHOO.widget.Overlay (YUI Library)</title>
|
|
<link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css">
|
|
<link rel="stylesheet" type="text/css" href="assets/api.css">
|
|
</head>
|
|
|
|
<body id="yahoo-com">
|
|
<div id="doc3" class="yui-t2">
|
|
|
|
<div id="hd">
|
|
<h1>Yahoo! UI Library</h1>
|
|
<h3>Container </h3>
|
|
<p>
|
|
<a href="./index.html">Yahoo! UI Library</a>
|
|
> <a href="./module_container.html">container</a>
|
|
> YAHOO.widget.Overlay
|
|
|
|
</p>
|
|
</div>
|
|
|
|
<div id="bd">
|
|
<div id="yui-main">
|
|
<div class="yui-b">
|
|
|
|
|
|
<h2>
|
|
|
|
|
|
|
|
|
|
Class <b>YAHOO.widget.Overlay</b>
|
|
<span class="extends">
|
|
- extends <a href="YAHOO.widget.Module.html">YAHOO.widget.Module</a>
|
|
</span>
|
|
|
|
<span class="extends">
|
|
</span>
|
|
|
|
</code>
|
|
</h2>
|
|
<!-- class tree goes here -->
|
|
|
|
<dl class="subclasses">
|
|
<dt>Known Subclasses:</dd>
|
|
<dd>
|
|
<a href="YAHOO.widget.Panel.html">YAHOO.widget.Panel</a>
|
|
<a href="YAHOO.widget.MenuModule.html">YAHOO.widget.MenuModule</a>
|
|
<a href="YAHOO.widget.Menu.html">YAHOO.widget.Menu</a>
|
|
<a href="YAHOO.widget.Tooltip.html">YAHOO.widget.Tooltip</a>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<div class="summary description">
|
|
Overlay is a Module that is absolutely positioned above the page flow. It has convenience methods for positioning and sizing, as well as options for controlling zIndex and constraining the Overlay's position to the current visible viewport. Overlay also contains a dynamicly generated IFRAME which is placed beneath it for Internet Explorer 6 and 5.x so that it will be properly rendered above SELECT elements.
|
|
</div>
|
|
|
|
<div class="section constructor details">
|
|
<h3><a name="constructor_detail">Constructor</a></h3>
|
|
<div class="content">
|
|
<div class="detail">
|
|
<strong>YAHOO.widget.Overlay</strong>
|
|
<code>
|
|
(
|
|
|
|
|
|
|
|
el
|
|
|
|
|
|
,
|
|
userConfig
|
|
)
|
|
</code>
|
|
<div class="description">
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>el
|
|
<String>
|
|
</code>
|
|
The element ID representing the Overlay <em>OR</em>
|
|
</dd>
|
|
<dd>
|
|
<code>el
|
|
<HTMLElement>
|
|
</code>
|
|
The element representing the Overlay
|
|
</dd>
|
|
<dd>
|
|
<code>userConfig
|
|
<Object>
|
|
</code>
|
|
The configuration object literal containing 10/23/2006the configuration that should be set for this Overlay. See configuration documentation for more details.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="section field details">
|
|
<h3><a name="field_detail">Properties</a></h3>
|
|
<div class="content">
|
|
<h4><a name="YAHOO.widget.Overlay._initialized">YAHOO.widget.Overlay._initialized</a>
|
|
<code>- private Boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
A boolean that indicated whether the window resize and scroll events have already been subscribed to.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="YAHOO.widget.Overlay.BOTTOM_LEFT">YAHOO.widget.Overlay.BOTTOM_LEFT</a>
|
|
<code>- static final String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Constant representing the top bottom left corner of an element, used for configuring the context element alignment
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="YAHOO.widget.Overlay.BOTTOM_RIGHT">YAHOO.widget.Overlay.BOTTOM_RIGHT</a>
|
|
<code>- static final String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Constant representing the bottom right corner of an element, used for configuring the context element alignment
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="YAHOO.widget.Overlay.CSS_OVERLAY">YAHOO.widget.Overlay.CSS_OVERLAY</a>
|
|
<code>- static final String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Constant representing the default CSS class used for an Overlay
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="YAHOO.widget.Overlay.IFRAME_SRC">YAHOO.widget.Overlay.IFRAME_SRC</a>
|
|
<code>- static final String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
The URL that will be placed in the iframe
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="YAHOO.widget.Overlay.TOP_LEFT">YAHOO.widget.Overlay.TOP_LEFT</a>
|
|
<code>- static final String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Constant representing the top left corner of an element, used for configuring the context element alignment
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
<h4><a name="YAHOO.widget.Overlay.TOP_RIGHT">YAHOO.widget.Overlay.TOP_RIGHT</a>
|
|
<code>- static final String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Constant representing the top right corner of an element, used for configuring the context element alignment
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="section field inheritance">
|
|
<h4>Properties inherited from <a href="YAHOO.widget.Module.html">YAHOO.widget.Module</a>:</h4>
|
|
<div class="content">
|
|
<code>
|
|
|
|
<a href="YAHOO.widget.Module.html#body">body</a>,
|
|
<a href="YAHOO.widget.Module.html#browser">browser</a>,
|
|
<a href="YAHOO.widget.Module.html#cfg">cfg</a>,
|
|
<a href="YAHOO.widget.Module.html#contructor">contructor</a>,
|
|
<a href="YAHOO.widget.Module.html#element">element</a>,
|
|
<a href="YAHOO.widget.Module.html#footer">footer</a>,
|
|
<a href="YAHOO.widget.Module.html#header">header</a>,
|
|
<a href="YAHOO.widget.Module.html#id">id</a>,
|
|
<a href="YAHOO.widget.Module.html#imageRoot">imageRoot</a>,
|
|
<a href="YAHOO.widget.Module.html#isSecure">isSecure</a>,
|
|
<a href="YAHOO.widget.Module.html#platform">platform</a>
|
|
</code>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="section method details">
|
|
<h3><a name="methodDetails">Methods</a></h3>
|
|
<div class="content">
|
|
<h4>
|
|
<a name="align">align</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>align</strong>
|
|
(
|
|
|
|
|
|
elementAlign
|
|
|
|
|
|
,
|
|
contextAlign
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
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.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>elementAlign <String></code>
|
|
The String representing the corner of the Overlay that should be aligned to the context element
|
|
</dd>
|
|
<dd>
|
|
<code>contextAlign <String></code>
|
|
The corner of the context element that the elementAlign corner should stick to.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="center">center</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>center</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Centers the container in the viewport.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="configConstrainToViewport">configConstrainToViewport</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>configConstrainToViewport</strong>
|
|
(
|
|
|
|
|
|
type
|
|
|
|
|
|
,
|
|
args
|
|
|
|
|
|
,
|
|
obj
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
The default event handler fired when the "constraintoviewport" property is changed.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>type <String></code>
|
|
The CustomEvent type (usually the property name)
|
|
</dd>
|
|
<dd>
|
|
<code>args <Object[]></code>
|
|
The CustomEvent arguments. For configuration handlers, args[0] will equal the newly applied value for the property.
|
|
</dd>
|
|
<dd>
|
|
<code>obj <Object></code>
|
|
The scope object. For configuration handlers, this will usually equal the owner.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="configContext">configContext</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>configContext</strong>
|
|
(
|
|
|
|
|
|
type
|
|
|
|
|
|
,
|
|
args
|
|
|
|
|
|
,
|
|
obj
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
The default event handler fired when the "context" property is changed.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>type <String></code>
|
|
The CustomEvent type (usually the property name)
|
|
</dd>
|
|
<dd>
|
|
<code>args <Object[]></code>
|
|
The CustomEvent arguments. For configuration handlers, args[0] will equal the newly applied value for the property.
|
|
</dd>
|
|
<dd>
|
|
<code>obj <Object></code>
|
|
The scope object. For configuration handlers, this will usually equal the owner.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="configFixedCenter">configFixedCenter</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>configFixedCenter</strong>
|
|
(
|
|
|
|
|
|
type
|
|
|
|
|
|
,
|
|
args
|
|
|
|
|
|
,
|
|
obj
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
The default event handler fired when the "fixedcenter" property is changed.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>type <String></code>
|
|
The CustomEvent type (usually the property name)
|
|
</dd>
|
|
<dd>
|
|
<code>args <Object[]></code>
|
|
The CustomEvent arguments. For configuration handlers, args[0] will equal the newly applied value for the property.
|
|
</dd>
|
|
<dd>
|
|
<code>obj <Object></code>
|
|
The scope object. For configuration handlers, this will usually equal the owner.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="configHeight">configHeight</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>configHeight</strong>
|
|
(
|
|
|
|
|
|
type
|
|
|
|
|
|
,
|
|
args
|
|
|
|
|
|
,
|
|
obj
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
The default event handler fired when the "height" property is changed.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>type <String></code>
|
|
The CustomEvent type (usually the property name)
|
|
</dd>
|
|
<dd>
|
|
<code>args <Object[]></code>
|
|
The CustomEvent arguments. For configuration handlers, args[0] will equal the newly applied value for the property.
|
|
</dd>
|
|
<dd>
|
|
<code>obj <Object></code>
|
|
The scope object. For configuration handlers, this will usually equal the owner.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="configIframe">configIframe</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>configIframe</strong>
|
|
(
|
|
|
|
|
|
type
|
|
|
|
|
|
,
|
|
args
|
|
|
|
|
|
,
|
|
obj
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
The default event handler fired when the "iframe" property is changed.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>type <String></code>
|
|
The CustomEvent type (usually the property name)
|
|
</dd>
|
|
<dd>
|
|
<code>args <Object[]></code>
|
|
The CustomEvent arguments. For configuration handlers, args[0] will equal the newly applied value for the property.
|
|
</dd>
|
|
<dd>
|
|
<code>obj <Object></code>
|
|
The scope object. For configuration handlers, this will usually equal the owner.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="configVisible">configVisible</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>configVisible</strong>
|
|
(
|
|
|
|
|
|
type
|
|
|
|
|
|
,
|
|
args
|
|
|
|
|
|
,
|
|
obj
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
The default event handler fired when the "visible" property is changed. This method is responsible for firing showEvent and hideEvent.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>type <String></code>
|
|
The CustomEvent type (usually the property name)
|
|
</dd>
|
|
<dd>
|
|
<code>args <Object[]></code>
|
|
The CustomEvent arguments. For configuration handlers, args[0] will equal the newly applied value for the property.
|
|
</dd>
|
|
<dd>
|
|
<code>obj <Object></code>
|
|
The scope object. For configuration handlers, this will usually equal the owner.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="configWidth">configWidth</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>configWidth</strong>
|
|
(
|
|
|
|
|
|
type
|
|
|
|
|
|
,
|
|
args
|
|
|
|
|
|
,
|
|
obj
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
The default event handler fired when the "width" property is changed.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>type <String></code>
|
|
The CustomEvent type (usually the property name)
|
|
</dd>
|
|
<dd>
|
|
<code>args <Object[]></code>
|
|
The CustomEvent arguments. For configuration handlers, args[0] will equal the newly applied value for the property.
|
|
</dd>
|
|
<dd>
|
|
<code>obj <Object></code>
|
|
The scope object. For configuration handlers, this will usually equal the owner.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="configX">configX</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>configX</strong>
|
|
(
|
|
|
|
|
|
type
|
|
|
|
|
|
,
|
|
args
|
|
|
|
|
|
,
|
|
obj
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
The default event handler fired when the "x" property is changed.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>type <String></code>
|
|
The CustomEvent type (usually the property name)
|
|
</dd>
|
|
<dd>
|
|
<code>args <Object[]></code>
|
|
The CustomEvent arguments. For configuration handlers, args[0] will equal the newly applied value for the property.
|
|
</dd>
|
|
<dd>
|
|
<code>obj <Object></code>
|
|
The scope object. For configuration handlers, this will usually equal the owner.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="configXY">configXY</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>configXY</strong>
|
|
(
|
|
|
|
|
|
type
|
|
|
|
|
|
,
|
|
args
|
|
|
|
|
|
,
|
|
obj
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
The default event handler fired when the "xy" property is changed.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>type <String></code>
|
|
The CustomEvent type (usually the property name)
|
|
</dd>
|
|
<dd>
|
|
<code>args <Object[]></code>
|
|
The CustomEvent arguments. For configuration handlers, args[0] will equal the newly applied value for the property.
|
|
</dd>
|
|
<dd>
|
|
<code>obj <Object></code>
|
|
The scope object. For configuration handlers, this will usually equal the owner.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="configY">configY</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>configY</strong>
|
|
(
|
|
|
|
|
|
type
|
|
|
|
|
|
,
|
|
args
|
|
|
|
|
|
,
|
|
obj
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
The default event handler fired when the "y" property is changed.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>type <String></code>
|
|
The CustomEvent type (usually the property name)
|
|
</dd>
|
|
<dd>
|
|
<code>args <Object[]></code>
|
|
The CustomEvent arguments. For configuration handlers, args[0] will equal the newly applied value for the property.
|
|
</dd>
|
|
<dd>
|
|
<code>obj <Object></code>
|
|
The scope object. For configuration handlers, this will usually equal the owner.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="configzIndex">configzIndex</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>configzIndex</strong>
|
|
(
|
|
|
|
|
|
type
|
|
|
|
|
|
,
|
|
args
|
|
|
|
|
|
,
|
|
obj
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
The default event handler fired when the "zIndex" property is changed.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>type <String></code>
|
|
The CustomEvent type (usually the property name)
|
|
</dd>
|
|
<dd>
|
|
<code>args <Object[]></code>
|
|
The CustomEvent arguments. For configuration handlers, args[0] will equal the newly applied value for the property.
|
|
</dd>
|
|
<dd>
|
|
<code>obj <Object></code>
|
|
The scope object. For configuration handlers, this will usually equal the owner.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="destroy">destroy</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>destroy</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Removes the Overlay element from the DOM and sets all child elements to null.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="doCenterOnDOMEvent">doCenterOnDOMEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>doCenterOnDOMEvent</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Center event handler used for centering on scroll/resize, but only if the Overlay is visible
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="enforceConstraints">enforceConstraints</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>enforceConstraints</strong>
|
|
(
|
|
|
|
|
|
type
|
|
|
|
|
|
,
|
|
args
|
|
|
|
|
|
,
|
|
obj
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
The default event handler executed when the moveEvent is fired, if the "constraintoviewport" is set to true.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>type <String></code>
|
|
The CustomEvent type (usually the property name)
|
|
</dd>
|
|
<dd>
|
|
<code>args <Object[]></code>
|
|
The CustomEvent arguments. For configuration handlers, args[0] will equal the newly applied value for the property.
|
|
</dd>
|
|
<dd>
|
|
<code>obj <Object></code>
|
|
The scope object. For configuration handlers, this will usually equal the owner.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="hideIframe">hideIframe</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>hideIframe</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Hides the iframe shim, if it has been enabled
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="hideMacGeckoScrollbars">hideMacGeckoScrollbars</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>hideMacGeckoScrollbars</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
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
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="init">init</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>init</strong>
|
|
(
|
|
|
|
|
|
el
|
|
|
|
|
|
|
|
|
|
,
|
|
userConfig
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
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.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>el <String></code>
|
|
The element ID representing the Overlay <em>OR</em>
|
|
</dd>
|
|
<dd>
|
|
<code>el <HTMLElement></code>
|
|
The element representing the Overlay
|
|
</dd>
|
|
<dd>
|
|
<code>userConfig <Object></code>
|
|
The configuration object literal containing the configuration that should be set for this Overlay. See configuration documentation for more details.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="initDefaultConfig">initDefaultConfig</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>initDefaultConfig</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Initializes the class's configurable properties which can be changed using the Overlay's Config object (cfg).
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="initEvents">initEvents</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>initEvents</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Initializes the custom events for Overlay which are fired automatically at appropriate times by the Overlay class.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="moveTo">moveTo</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>moveTo</strong>
|
|
(
|
|
|
|
|
|
x
|
|
|
|
|
|
,
|
|
y
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Moves the Overlay to the specified position. This function is identical to calling this.cfg.setProperty("xy", [x,y]);
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>x <Number></code>
|
|
The Overlay's new x position
|
|
</dd>
|
|
<dd>
|
|
<code>y <Number></code>
|
|
The Overlay's new y position
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="onDomResize">onDomResize</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>onDomResize</strong>
|
|
(
|
|
|
|
|
|
e
|
|
|
|
|
|
,
|
|
obj
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Event handler fired when the resize monitor element is resized.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>e <DOMEvent></code>
|
|
The resize DOM event
|
|
</dd>
|
|
<dd>
|
|
<code>obj <Object></code>
|
|
The scope object
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="showIframe">showIframe</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>showIframe</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Shows the iframe shim, if it has been enabled
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="showMacGeckoScrollbars">showMacGeckoScrollbars</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>showMacGeckoScrollbars</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
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
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="syncPosition">syncPosition</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>syncPosition</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
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.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="toString">toString</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
String
|
|
<strong>toString</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Returns a String representation of the object.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
String
|
|
</code></dt>
|
|
<dd>The string representation of the Overlay.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="YAHOO.widget.Overlay.windowResizeHandler">YAHOO.widget.Overlay.windowResizeHandler</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
static
|
|
|
|
void
|
|
<strong>YAHOO.widget.Overlay.windowResizeHandler</strong>
|
|
(
|
|
|
|
|
|
e
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
The DOM event handler used to fire the CustomEvent for window resize
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>e <DOMEvent></code>
|
|
The DOM resize event
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="YAHOO.widget.Overlay.windowScrollHandler">YAHOO.widget.Overlay.windowScrollHandler</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
static
|
|
|
|
void
|
|
<strong>YAHOO.widget.Overlay.windowScrollHandler</strong>
|
|
(
|
|
|
|
|
|
e
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
The DOM event handler used to fire the CustomEvent for window scroll
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>e <DOMEvent></code>
|
|
The DOM scroll event
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
</div>
|
|
|
|
<div class="section field inheritance">
|
|
<h4>Methods inherited from <a href="YAHOO.widget.Module.html">YAHOO.widget.Module</a>:</h4>
|
|
<div class="content">
|
|
<code>
|
|
|
|
<a href="YAHOO.widget.Module.html#appendToBody">appendToBody</a>,
|
|
<a href="YAHOO.widget.Module.html#appendToFooter">appendToFooter</a>,
|
|
<a href="YAHOO.widget.Module.html#appendToHeader">appendToHeader</a>,
|
|
<a href="YAHOO.widget.Module.html#configMonitorResize">configMonitorResize</a>,
|
|
<a href="YAHOO.widget.Module.html#configVisible">configVisible</a>,
|
|
<a href="YAHOO.widget.Module.html#destroy">destroy</a>,
|
|
<a href="YAHOO.widget.Module.html#hide">hide</a>,
|
|
<a href="YAHOO.widget.Module.html#init">init</a>,
|
|
<a href="YAHOO.widget.Module.html#initDefaultConfig">initDefaultConfig</a>,
|
|
<a href="YAHOO.widget.Module.html#initEvents">initEvents</a>,
|
|
<a href="YAHOO.widget.Module.html#initResizeMonitor">initResizeMonitor</a>,
|
|
<a href="YAHOO.widget.Module.html#onDomResize">onDomResize</a>,
|
|
<a href="YAHOO.widget.Module.html#render">render</a>,
|
|
<a href="YAHOO.widget.Module.html#setBody">setBody</a>,
|
|
<a href="YAHOO.widget.Module.html#setFooter">setFooter</a>,
|
|
<a href="YAHOO.widget.Module.html#setHeader">setHeader</a>,
|
|
<a href="YAHOO.widget.Module.html#show">show</a>,
|
|
<a href="YAHOO.widget.Module.html#toString">toString</a>
|
|
</code>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="section method details">
|
|
<h3><a name="methodDetails">Events</a></h3>
|
|
<div class="content">
|
|
<h4>
|
|
<a name="beforeMoveEvent">beforeMoveEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>beforeMoveEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
x
|
|
|
|
|
|
,
|
|
y
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
CustomEvent fired before the Overlay is moved.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>x <Number></code>
|
|
x coordinate
|
|
</dd>
|
|
<dd>
|
|
<code>y <Number></code>
|
|
y coordinate
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="moveEvent">moveEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>moveEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
x
|
|
|
|
|
|
,
|
|
y
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
CustomEvent fired after the Overlay is moved.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>x <Number></code>
|
|
x coordinate
|
|
</dd>
|
|
<dd>
|
|
<code>y <Number></code>
|
|
y coordinate
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="YAHOO.widget.Overlay.windowResizeEvent">YAHOO.widget.Overlay.windowResizeEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>YAHOO.widget.Overlay.windowResizeEvent</strong>
|
|
|
|
(
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
A singleton CustomEvent used for reacting to the DOM event for window resize
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="YAHOO.widget.Overlay.windowScrollEvent">YAHOO.widget.Overlay.windowScrollEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>YAHOO.widget.Overlay.windowScrollEvent</strong>
|
|
|
|
(
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
A singleton CustomEvent used for reacting to the DOM event for window scroll
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="section field inheritance">
|
|
<h4>Events inherited from <a href="YAHOO.widget.Module.html">YAHOO.widget.Module</a>:</h4>
|
|
<div class="content">
|
|
<code>
|
|
|
|
<a href="YAHOO.widget.Module.html#appendEvent">appendEvent</a>,
|
|
<a href="YAHOO.widget.Module.html#beforeHideEvent">beforeHideEvent</a>,
|
|
<a href="YAHOO.widget.Module.html#beforeInitEvent">beforeInitEvent</a>,
|
|
<a href="YAHOO.widget.Module.html#beforeRenderEvent">beforeRenderEvent</a>,
|
|
<a href="YAHOO.widget.Module.html#beforeShowEvent">beforeShowEvent</a>,
|
|
<a href="YAHOO.widget.Module.html#changeBodyEvent">changeBodyEvent</a>,
|
|
<a href="YAHOO.widget.Module.html#changeContentEvent">changeContentEvent</a>,
|
|
<a href="YAHOO.widget.Module.html#changeFooterEvent">changeFooterEvent</a>,
|
|
<a href="YAHOO.widget.Module.html#changeHeaderEvent">changeHeaderEvent</a>,
|
|
<a href="YAHOO.widget.Module.html#destroyEvent">destroyEvent</a>,
|
|
<a href="YAHOO.widget.Module.html#hideEvent">hideEvent</a>,
|
|
<a href="YAHOO.widget.Module.html#initEvent">initEvent</a>,
|
|
<a href="YAHOO.widget.Module.html#renderEvent">renderEvent</a>,
|
|
<a href="YAHOO.widget.Module.html#showEvent">showEvent</a>
|
|
</code>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="section field details">
|
|
<h3><a name="field_detail">Configuration Attributes</a></h3>
|
|
<div class="content">
|
|
<h4><a name="constraintoviewport">constraintoviewport</a>
|
|
<code>- Boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
True if the Overlay should be prevented from being positioned out of the viewport.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: false
|
|
</div>
|
|
|
|
<hr />
|
|
<h4><a name="context">context</a>
|
|
<code>- Array</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
The array of context arguments for context-sensitive positioning. The format is: [id or element, element corner, context corner]. For example, setting this property to ["img1", "tl", "bl"] would align the Overlay's top left corner to the context element's bottom left corner.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: null
|
|
</div>
|
|
|
|
<hr />
|
|
<h4><a name="fixedcenter">fixedcenter</a>
|
|
<code>- Boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
True if the Overlay should be anchored to the center of the viewport.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: false
|
|
</div>
|
|
|
|
<hr />
|
|
<h4><a name="height">height</a>
|
|
<code>- String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
CSS height of the Overlay.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: null
|
|
</div>
|
|
|
|
<hr />
|
|
<h4><a name="iframe">iframe</a>
|
|
<code>- Boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
True if the Overlay should have an IFRAME shim (for correcting the select z-index bug in IE6 and below).
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: true for IE6 and below, false for all others
|
|
</div>
|
|
|
|
<hr />
|
|
<h4><a name="width">width</a>
|
|
<code>- String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
CSS width of the Overlay.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: null
|
|
</div>
|
|
|
|
<hr />
|
|
<h4><a name="x">x</a>
|
|
<code>- Number</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
The absolute x-coordinate position of the Overlay
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: null
|
|
</div>
|
|
|
|
<hr />
|
|
<h4><a name="xy">xy</a>
|
|
<code>- Number[]</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
An array with the absolute x and y positions of the Overlay
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: null
|
|
</div>
|
|
|
|
<hr />
|
|
<h4><a name="y">y</a>
|
|
<code>- Number</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
The absolute y-coordinate position of the Overlay
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: null
|
|
</div>
|
|
|
|
<hr />
|
|
<h4><a name="zIndex">zIndex</a>
|
|
<code>- Number</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
CSS z-index of the Overlay.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: null
|
|
</div>
|
|
|
|
<hr />
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="section field inheritance">
|
|
<h4>Configuration attributes inherited from <a href="YAHOO.widget.Module.html">YAHOO.widget.Module</a>:</h4>
|
|
<div class="content">
|
|
<code>
|
|
|
|
<a href="YAHOO.widget.Module.html#effect">effect</a>,
|
|
<a href="YAHOO.widget.Module.html#monitorresize">monitorresize</a>,
|
|
<a href="YAHOO.widget.Module.html#visible">visible</a>
|
|
</code>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="yui-b">
|
|
<div class="nav">
|
|
|
|
<div class="module">
|
|
<h4>Modules</h4>
|
|
<ul class="content">
|
|
<li><a href="module_animation.html">animation</a></li>
|
|
<li><a href="module_autocomplete.html">autocomplete</a></li>
|
|
<li><a href="module_calendar.html">calendar</a></li>
|
|
<li><a href="module_connection.html">connection</a></li>
|
|
<li><a href="module_container.html">container</a></li>
|
|
<li><a href="module_dom.html">dom</a></li>
|
|
<li><a href="module_dragdrop.html">dragdrop</a></li>
|
|
<li><a href="module_event.html">event</a></li>
|
|
<li><a href="module_logger.html">logger</a></li>
|
|
<li><a href="module_menu.html">menu</a></li>
|
|
<li><a href="module_slider.html">slider</a></li>
|
|
<li><a href="module_tabview.html">tabview</a></li>
|
|
<li><a href="module_treeview.html">treeview</a></li>
|
|
<li><a href="module_yahoo.html">yahoo</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Classes</h4>
|
|
<ul class="content">
|
|
<li><a href="YAHOO.util.Config.html">YAHOO.util.Config</a></li>
|
|
<li><a href="YAHOO.util.KeyListener.html">YAHOO.util.KeyListener</a></li>
|
|
<li><a href="YAHOO.widget.ContainerEffect.html">YAHOO.widget.ContainerEffect</a></li>
|
|
<li><a href="YAHOO.widget.Dialog.html">YAHOO.widget.Dialog</a></li>
|
|
<li><a href="YAHOO.widget.Module.html">YAHOO.widget.Module</a></li>
|
|
<li><a href="YAHOO.widget.Overlay.html">YAHOO.widget.Overlay</a></li>
|
|
<li><a href="YAHOO.widget.OverlayManager.html">YAHOO.widget.OverlayManager</a></li>
|
|
<li><a href="YAHOO.widget.Panel.html">YAHOO.widget.Panel</a></li>
|
|
<li><a href="YAHOO.widget.SimpleDialog.html">YAHOO.widget.SimpleDialog</a></li>
|
|
<li><a href="YAHOO.widget.Tooltip.html">YAHOO.widget.Tooltip</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Files</h4>
|
|
<ul class="content">
|
|
<li><a href="Config.js.html">Config.js</a></li>
|
|
<li><a href="ContainerEffect.js.html">ContainerEffect.js</a></li>
|
|
<li><a href="Dialog.js.html">Dialog.js</a></li>
|
|
<li><a href="KeyListener.js.html">KeyListener.js</a></li>
|
|
<li><a href="Module.js.html">Module.js</a></li>
|
|
<li><a href="Overlay.js.html">Overlay.js</a></li>
|
|
<li><a href="OverlayManager.js.html">OverlayManager.js</a></li>
|
|
<li><a href="Panel.js.html">Panel.js</a></li>
|
|
<li><a href="SimpleDialog.js.html">SimpleDialog.js</a></li>
|
|
<li><a href="Tooltip.js.html">Tooltip.js</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Properties</h4>
|
|
<ul class="content">
|
|
<li><a href="#YAHOO.widget.Overlay._initialized">YAHOO.widget.Overlay._initialized</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#YAHOO.widget.Overlay.BOTTOM_LEFT">YAHOO.widget.Overlay.BOTTOM_LEFT</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#YAHOO.widget.Overlay.BOTTOM_RIGHT">YAHOO.widget.Overlay.BOTTOM_RIGHT</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#YAHOO.widget.Overlay.CSS_OVERLAY">YAHOO.widget.Overlay.CSS_OVERLAY</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#YAHOO.widget.Overlay.IFRAME_SRC">YAHOO.widget.Overlay.IFRAME_SRC</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#YAHOO.widget.Overlay.TOP_LEFT">YAHOO.widget.Overlay.TOP_LEFT</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#YAHOO.widget.Overlay.TOP_RIGHT">YAHOO.widget.Overlay.TOP_RIGHT</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Methods</h4>
|
|
<ul class="content">
|
|
<li><!--<code>void</code>-->
|
|
<a href="#align">align</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#center">center</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#configConstrainToViewport">configConstrainToViewport</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#configContext">configContext</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#configFixedCenter">configFixedCenter</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#configHeight">configHeight</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#configIframe">configIframe</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#configVisible">configVisible</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#configWidth">configWidth</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#configX">configX</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#configXY">configXY</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#configY">configY</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#configzIndex">configzIndex</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#destroy">destroy</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#doCenterOnDOMEvent">doCenterOnDOMEvent</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#enforceConstraints">enforceConstraints</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#hideIframe">hideIframe</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#hideMacGeckoScrollbars">hideMacGeckoScrollbars</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#init">init</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#initDefaultConfig">initDefaultConfig</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#initEvents">initEvents</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#moveTo">moveTo</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#onDomResize">onDomResize</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#showIframe">showIframe</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#showMacGeckoScrollbars">showMacGeckoScrollbars</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#syncPosition">syncPosition</a>
|
|
</li>
|
|
<li><!--<code>String</code>-->
|
|
<a href="#toString">toString</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#YAHOO.widget.Overlay.windowResizeHandler">YAHOO.widget.Overlay.windowResizeHandler</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#YAHOO.widget.Overlay.windowScrollHandler">YAHOO.widget.Overlay.windowScrollHandler</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Events</h4>
|
|
<ul class="content">
|
|
<li>
|
|
<a href="#beforeMoveEvent">beforeMoveEvent</a>
|
|
</li>
|
|
<li>
|
|
<a href="#moveEvent">moveEvent</a>
|
|
</li>
|
|
<li>
|
|
<a href="#YAHOO.widget.Overlay.windowResizeEvent">YAHOO.widget.Overlay.windowResizeEvent</a>
|
|
</li>
|
|
<li>
|
|
<a href="#YAHOO.widget.Overlay.windowScrollEvent">YAHOO.widget.Overlay.windowScrollEvent</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Configuration Attributes</h4>
|
|
<ul class="content">
|
|
<li>
|
|
<a href="#constraintoviewport">constraintoviewport</a>
|
|
</li>
|
|
<li>
|
|
<a href="#context">context</a>
|
|
</li>
|
|
<li>
|
|
<a href="#fixedcenter">fixedcenter</a>
|
|
</li>
|
|
<li>
|
|
<a href="#height">height</a>
|
|
</li>
|
|
<li>
|
|
<a href="#iframe">iframe</a>
|
|
</li>
|
|
<li>
|
|
<a href="#width">width</a>
|
|
</li>
|
|
<li>
|
|
<a href="#x">x</a>
|
|
</li>
|
|
<li>
|
|
<a href="#xy">xy</a>
|
|
</li>
|
|
<li>
|
|
<a href="#y">y</a>
|
|
</li>
|
|
<li>
|
|
<a href="#zIndex">zIndex</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="ft">
|
|
<hr />
|
|
Copyright © 2006 Yahoo! Inc. All rights reserved.
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|