1 <!DOCTYPE HTML PUBLIC
"-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
4 <title>API: container YAHOO.widget.Overlay (YUI Library)
</title>
5 <link rel=
"stylesheet" type=
"text/css" href=
"assets/api.css">
9 <div id=
"doc3" class=
"yui-t2">
12 <h1>Yahoo! UI Library
</h1>
13 <h3>Container
<span class=
"subtitle">2.2.0</span></h3>
15 <a href=
"./index.html">Yahoo! UI Library
</a>
16 > <a href=
"./module_container.html">container
</a>
17 > YAHOO.widget.Overlay
32 Class
<b>YAHOO.widget.Overlay
</b>
33 <span class=
"extends">
34 - extends
<a href=
"YAHOO.widget.Module.html">YAHOO.widget.Module
</a>
37 <span class=
"extends">
42 <!-- class tree goes here -->
44 <dl class=
"subclasses">
45 <dt>Known Subclasses:
</dd>
47 <a href=
"YAHOO.widget.Panel.html">YAHOO.widget.Panel
</a>
48 <a href=
"YAHOO.widget.Menu.html">YAHOO.widget.Menu
</a>
49 <a href=
"YAHOO.widget.Tooltip.html">YAHOO.widget.Tooltip
</a>
55 <div class=
"summary description">
56 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.
59 <div class=
"section constructor details">
60 <h3><a name=
"constructor_detail">Constructor
</a></h3>
63 <strong>YAHOO.widget.Overlay
</strong>
76 <div class=
"description">
83 The element ID representing the Overlay
<em>OR
</em>
89 The element representing the Overlay
95 The configuration object literal containing
10/
23/
2006the configuration that should be set for this Overlay. See configuration documentation for more details.
105 <div class=
"section field details">
106 <h3><a name=
"field_detail">Properties
</a></h3>
107 <div class=
"content">
108 <h4><a name=
"YAHOO.widget.Overlay._initialized">YAHOO.widget.Overlay._initialized
</a>
109 <code>- private Boolean
</code>
112 <div class=
"description">
113 A boolean that indicated whether the window resize and scroll events have already been subscribed to.
121 <h4><a name=
"YAHOO.widget.Overlay.BOTTOM_LEFT">YAHOO.widget.Overlay.BOTTOM_LEFT
</a>
122 <code>- static final String
</code>
125 <div class=
"description">
126 Constant representing the top bottom left corner of an element, used for configuring the context element alignment
134 <h4><a name=
"YAHOO.widget.Overlay.BOTTOM_RIGHT">YAHOO.widget.Overlay.BOTTOM_RIGHT
</a>
135 <code>- static final String
</code>
138 <div class=
"description">
139 Constant representing the bottom right corner of an element, used for configuring the context element alignment
147 <h4><a name=
"YAHOO.widget.Overlay.CSS_OVERLAY">YAHOO.widget.Overlay.CSS_OVERLAY
</a>
148 <code>- static final String
</code>
151 <div class=
"description">
152 Constant representing the default CSS class used for an Overlay
160 <h4><a name=
"YAHOO.widget.Overlay.IFRAME_SRC">YAHOO.widget.Overlay.IFRAME_SRC
</a>
161 <code>- static final String
</code>
164 <div class=
"description">
165 The URL that will be placed in the iframe
173 <h4><a name=
"YAHOO.widget.Overlay.TOP_LEFT">YAHOO.widget.Overlay.TOP_LEFT
</a>
174 <code>- static final String
</code>
177 <div class=
"description">
178 Constant representing the top left corner of an element, used for configuring the context element alignment
186 <h4><a name=
"YAHOO.widget.Overlay.TOP_RIGHT">YAHOO.widget.Overlay.TOP_RIGHT
</a>
187 <code>- static final String
</code>
190 <div class=
"description">
191 Constant representing the top right corner of an element, used for configuring the context element alignment
204 <div class=
"section field inheritance">
205 <h4>Properties inherited from
<a href=
"YAHOO.widget.Module.html">YAHOO.widget.Module
</a>:
</h4>
206 <div class=
"content">
209 <a href=
"YAHOO.widget.Module.html#body">body
</a>,
210 <a href=
"YAHOO.widget.Module.html#browser">browser
</a>,
211 <a href=
"YAHOO.widget.Module.html#cfg">cfg
</a>,
212 <a href=
"YAHOO.widget.Module.html#contructor">contructor
</a>,
213 <a href=
"YAHOO.widget.Module.html#element">element
</a>,
214 <a href=
"YAHOO.widget.Module.html#footer">footer
</a>,
215 <a href=
"YAHOO.widget.Module.html#header">header
</a>,
216 <a href=
"YAHOO.widget.Module.html#id">id
</a>,
217 <a href=
"YAHOO.widget.Module.html#imageRoot">imageRoot
</a>,
218 <a href=
"YAHOO.widget.Module.html#isSecure">isSecure
</a>,
219 <a href=
"YAHOO.widget.Module.html#platform">platform
</a>
224 <div class=
"section method details">
225 <h3><a name=
"methodDetails">Methods
</a></h3>
226 <div class=
"content">
228 <a name=
"align">align
</a></h4>
235 <strong>align
</strong>
249 <div class=
"description">
250 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.
253 <div class=
"description">
258 <code>elementAlign
<String
></code>
259 The String representing the corner of the Overlay that should be aligned to the context element
262 <code>contextAlign
<String
></code>
263 The corner of the context element that the elementAlign corner should stick to.
280 <a name=
"center">center
</a></h4>
287 <strong>center
</strong>
292 <div class=
"description">
293 Centers the container in the viewport.
296 <div class=
"description">
312 <a name=
"configConstrainToViewport">configConstrainToViewport
</a></h4>
319 <strong>configConstrainToViewport
</strong>
337 <div class=
"description">
338 The default event handler fired when the
"constraintoviewport" property is changed.
341 <div class=
"description">
346 <code>type
<String
></code>
347 The CustomEvent type (usually the property name)
350 <code>args
<Object[]
></code>
351 The CustomEvent arguments. For configuration handlers, args[
0] will equal the newly applied value for the property.
354 <code>obj
<Object
></code>
355 The scope object. For configuration handlers, this will usually equal the owner.
372 <a name=
"configContext">configContext
</a></h4>
379 <strong>configContext
</strong>
397 <div class=
"description">
398 The default event handler fired when the
"context" property is changed.
401 <div class=
"description">
406 <code>type
<String
></code>
407 The CustomEvent type (usually the property name)
410 <code>args
<Object[]
></code>
411 The CustomEvent arguments. For configuration handlers, args[
0] will equal the newly applied value for the property.
414 <code>obj
<Object
></code>
415 The scope object. For configuration handlers, this will usually equal the owner.
432 <a name=
"configFixedCenter">configFixedCenter
</a></h4>
439 <strong>configFixedCenter
</strong>
457 <div class=
"description">
458 The default event handler fired when the
"fixedcenter" property is changed.
461 <div class=
"description">
466 <code>type
<String
></code>
467 The CustomEvent type (usually the property name)
470 <code>args
<Object[]
></code>
471 The CustomEvent arguments. For configuration handlers, args[
0] will equal the newly applied value for the property.
474 <code>obj
<Object
></code>
475 The scope object. For configuration handlers, this will usually equal the owner.
492 <a name=
"configHeight">configHeight
</a></h4>
499 <strong>configHeight
</strong>
517 <div class=
"description">
518 The default event handler fired when the
"height" property is changed.
521 <div class=
"description">
526 <code>type
<String
></code>
527 The CustomEvent type (usually the property name)
530 <code>args
<Object[]
></code>
531 The CustomEvent arguments. For configuration handlers, args[
0] will equal the newly applied value for the property.
534 <code>obj
<Object
></code>
535 The scope object. For configuration handlers, this will usually equal the owner.
552 <a name=
"configIframe">configIframe
</a></h4>
559 <strong>configIframe
</strong>
577 <div class=
"description">
578 The default event handler fired when the
"iframe" property is changed.
581 <div class=
"description">
586 <code>type
<String
></code>
587 The CustomEvent type (usually the property name)
590 <code>args
<Object[]
></code>
591 The CustomEvent arguments. For configuration handlers, args[
0] will equal the newly applied value for the property.
594 <code>obj
<Object
></code>
595 The scope object. For configuration handlers, this will usually equal the owner.
612 <a name=
"configVisible">configVisible
</a></h4>
619 <strong>configVisible
</strong>
637 <div class=
"description">
638 The default event handler fired when the
"visible" property is changed. This method is responsible for firing showEvent and hideEvent.
641 <div class=
"description">
646 <code>type
<String
></code>
647 The CustomEvent type (usually the property name)
650 <code>args
<Object[]
></code>
651 The CustomEvent arguments. For configuration handlers, args[
0] will equal the newly applied value for the property.
654 <code>obj
<Object
></code>
655 The scope object. For configuration handlers, this will usually equal the owner.
672 <a name=
"configWidth">configWidth
</a></h4>
679 <strong>configWidth
</strong>
697 <div class=
"description">
698 The default event handler fired when the
"width" property is changed.
701 <div class=
"description">
706 <code>type
<String
></code>
707 The CustomEvent type (usually the property name)
710 <code>args
<Object[]
></code>
711 The CustomEvent arguments. For configuration handlers, args[
0] will equal the newly applied value for the property.
714 <code>obj
<Object
></code>
715 The scope object. For configuration handlers, this will usually equal the owner.
732 <a name=
"configX">configX
</a></h4>
739 <strong>configX
</strong>
757 <div class=
"description">
758 The default event handler fired when the
"x" property is changed.
761 <div class=
"description">
766 <code>type
<String
></code>
767 The CustomEvent type (usually the property name)
770 <code>args
<Object[]
></code>
771 The CustomEvent arguments. For configuration handlers, args[
0] will equal the newly applied value for the property.
774 <code>obj
<Object
></code>
775 The scope object. For configuration handlers, this will usually equal the owner.
792 <a name=
"configXY">configXY
</a></h4>
799 <strong>configXY
</strong>
817 <div class=
"description">
818 The default event handler fired when the
"xy" property is changed.
821 <div class=
"description">
826 <code>type
<String
></code>
827 The CustomEvent type (usually the property name)
830 <code>args
<Object[]
></code>
831 The CustomEvent arguments. For configuration handlers, args[
0] will equal the newly applied value for the property.
834 <code>obj
<Object
></code>
835 The scope object. For configuration handlers, this will usually equal the owner.
852 <a name=
"configY">configY
</a></h4>
859 <strong>configY
</strong>
877 <div class=
"description">
878 The default event handler fired when the
"y" property is changed.
881 <div class=
"description">
886 <code>type
<String
></code>
887 The CustomEvent type (usually the property name)
890 <code>args
<Object[]
></code>
891 The CustomEvent arguments. For configuration handlers, args[
0] will equal the newly applied value for the property.
894 <code>obj
<Object
></code>
895 The scope object. For configuration handlers, this will usually equal the owner.
912 <a name=
"configzIndex">configzIndex
</a></h4>
919 <strong>configzIndex
</strong>
937 <div class=
"description">
938 The default event handler fired when the
"zIndex" property is changed.
941 <div class=
"description">
946 <code>type
<String
></code>
947 The CustomEvent type (usually the property name)
950 <code>args
<Object[]
></code>
951 The CustomEvent arguments. For configuration handlers, args[
0] will equal the newly applied value for the property.
954 <code>obj
<Object
></code>
955 The scope object. For configuration handlers, this will usually equal the owner.
972 <a name=
"destroy">destroy
</a></h4>
979 <strong>destroy
</strong>
984 <div class=
"description">
985 Removes the Overlay element from the DOM and sets all child elements to null.
988 <div class=
"description">
1004 <a name=
"doCenterOnDOMEvent">doCenterOnDOMEvent
</a></h4>
1005 <div class=
"detail">
1011 <strong>doCenterOnDOMEvent
</strong>
1016 <div class=
"description">
1017 Center event handler used for centering on scroll/resize, but only if the Overlay is visible
1020 <div class=
"description">
1036 <a name=
"enforceConstraints">enforceConstraints
</a></h4>
1037 <div class=
"detail">
1043 <strong>enforceConstraints
</strong>
1061 <div class=
"description">
1062 The default event handler executed when the moveEvent is fired, if the
"constraintoviewport" is set to true.
1065 <div class=
"description">
1068 <dt>Parameters:
</dt>
1070 <code>type
<String
></code>
1071 The CustomEvent type (usually the property name)
1074 <code>args
<Object[]
></code>
1075 The CustomEvent arguments. For configuration handlers, args[
0] will equal the newly applied value for the property.
1078 <code>obj
<Object
></code>
1079 The scope object. For configuration handlers, this will usually equal the owner.
1096 <a name=
"hideIframe">hideIframe
</a></h4>
1097 <div class=
"detail">
1103 <strong>hideIframe
</strong>
1108 <div class=
"description">
1109 Hides the iframe shim, if it has been enabled
1112 <div class=
"description">
1128 <a name=
"hideMacGeckoScrollbars">hideMacGeckoScrollbars
</a></h4>
1129 <div class=
"detail">
1135 <strong>hideMacGeckoScrollbars
</strong>
1140 <div class=
"description">
1141 Adds a special CSS class to the Overlay when Mac/Gecko is in use, to work around a Gecko bug where
1142 scrollbars cannot be hidden. See https://bugzilla.mozilla.org/show_bug.cgi?id=
187435
1145 <div class=
"description">
1161 <a name=
"init">init
</a></h4>
1162 <div class=
"detail">
1168 <strong>init
</strong>
1184 <div class=
"description">
1185 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.
1188 <div class=
"description">
1191 <dt>Parameters:
</dt>
1193 <code>el
<String
></code>
1194 The element ID representing the Overlay
<em>OR
</em>
1197 <code>el
<HTMLElement
></code>
1198 The element representing the Overlay
1201 <code>userConfig
<Object
></code>
1202 The configuration object literal containing the configuration that should be set for this Overlay. See configuration documentation for more details.
1219 <a name=
"initDefaultConfig">initDefaultConfig
</a></h4>
1220 <div class=
"detail">
1226 <strong>initDefaultConfig
</strong>
1231 <div class=
"description">
1232 Initializes the class's configurable properties which can be changed using the Overlay's Config object (cfg).
1235 <div class=
"description">
1251 <a name=
"initEvents">initEvents
</a></h4>
1252 <div class=
"detail">
1258 <strong>initEvents
</strong>
1263 <div class=
"description">
1264 Initializes the custom events for Overlay which are fired automatically at appropriate times by the Overlay class.
1267 <div class=
"description">
1283 <a name=
"moveTo">moveTo
</a></h4>
1284 <div class=
"detail">
1290 <strong>moveTo
</strong>
1304 <div class=
"description">
1305 Moves the Overlay to the specified position. This function is identical to calling this.cfg.setProperty(
"xy", [x,y]);
1308 <div class=
"description">
1311 <dt>Parameters:
</dt>
1313 <code>x
<Number
></code>
1314 The Overlay's new x position
1317 <code>y
<Number
></code>
1318 The Overlay's new y position
1335 <a name=
"onDomResize">onDomResize
</a></h4>
1336 <div class=
"detail">
1342 <strong>onDomResize
</strong>
1356 <div class=
"description">
1357 Event handler fired when the resize monitor element is resized.
1360 <div class=
"description">
1363 <dt>Parameters:
</dt>
1365 <code>e
<DOMEvent
></code>
1366 The resize DOM event
1369 <code>obj
<Object
></code>
1387 <a name=
"showIframe">showIframe
</a></h4>
1388 <div class=
"detail">
1394 <strong>showIframe
</strong>
1399 <div class=
"description">
1400 Shows the iframe shim, if it has been enabled
1403 <div class=
"description">
1419 <a name=
"showMacGeckoScrollbars">showMacGeckoScrollbars
</a></h4>
1420 <div class=
"detail">
1426 <strong>showMacGeckoScrollbars
</strong>
1431 <div class=
"description">
1432 Removes a special CSS class from the Overlay when Mac/Gecko is in use, to work around a Gecko bug where
1433 scrollbars cannot be hidden. See https://bugzilla.mozilla.org/show_bug.cgi?id=
187435
1436 <div class=
"description">
1452 <a name=
"syncPosition">syncPosition
</a></h4>
1453 <div class=
"detail">
1459 <strong>syncPosition
</strong>
1464 <div class=
"description">
1465 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.
1468 <div class=
"description">
1484 <a name=
"toString">toString
</a></h4>
1485 <div class=
"detail">
1491 <strong>toString
</strong>
1496 <div class=
"description">
1497 Returns a String representation of the object.
1500 <div class=
"description">
1508 <dd>The string representation of the Overlay.
</dd>
1516 <a name=
"YAHOO.widget.Overlay.windowResizeHandler">YAHOO.widget.Overlay.windowResizeHandler
</a></h4>
1517 <div class=
"detail">
1523 <strong>YAHOO.widget.Overlay.windowResizeHandler
</strong>
1533 <div class=
"description">
1534 The DOM event handler used to fire the CustomEvent for window resize
1537 <div class=
"description">
1540 <dt>Parameters:
</dt>
1542 <code>e
<DOMEvent
></code>
1543 The DOM resize event
1560 <a name=
"YAHOO.widget.Overlay.windowScrollHandler">YAHOO.widget.Overlay.windowScrollHandler
</a></h4>
1561 <div class=
"detail">
1567 <strong>YAHOO.widget.Overlay.windowScrollHandler
</strong>
1577 <div class=
"description">
1578 The DOM event handler used to fire the CustomEvent for window scroll
1581 <div class=
"description">
1584 <dt>Parameters:
</dt>
1586 <code>e
<DOMEvent
></code>
1587 The DOM scroll event
1606 <div class=
"section field inheritance">
1607 <h4>Methods inherited from
<a href=
"YAHOO.widget.Module.html">YAHOO.widget.Module
</a>:
</h4>
1608 <div class=
"content">
1611 <a href=
"YAHOO.widget.Module.html#appendToBody">appendToBody
</a>,
1612 <a href=
"YAHOO.widget.Module.html#appendToFooter">appendToFooter
</a>,
1613 <a href=
"YAHOO.widget.Module.html#appendToHeader">appendToHeader
</a>,
1614 <a href=
"YAHOO.widget.Module.html#configMonitorResize">configMonitorResize
</a>,
1615 <a href=
"YAHOO.widget.Module.html#configVisible">configVisible
</a>,
1616 <a href=
"YAHOO.widget.Module.html#destroy">destroy
</a>,
1617 <a href=
"YAHOO.widget.Module.html#hide">hide
</a>,
1618 <a href=
"YAHOO.widget.Module.html#init">init
</a>,
1619 <a href=
"YAHOO.widget.Module.html#initDefaultConfig">initDefaultConfig
</a>,
1620 <a href=
"YAHOO.widget.Module.html#initEvents">initEvents
</a>,
1621 <a href=
"YAHOO.widget.Module.html#initResizeMonitor">initResizeMonitor
</a>,
1622 <a href=
"YAHOO.widget.Module.html#onDomResize">onDomResize
</a>,
1623 <a href=
"YAHOO.widget.Module.html#render">render
</a>,
1624 <a href=
"YAHOO.widget.Module.html#setBody">setBody
</a>,
1625 <a href=
"YAHOO.widget.Module.html#setFooter">setFooter
</a>,
1626 <a href=
"YAHOO.widget.Module.html#setHeader">setHeader
</a>,
1627 <a href=
"YAHOO.widget.Module.html#show">show
</a>,
1628 <a href=
"YAHOO.widget.Module.html#toString">toString
</a>
1633 <div class=
"section method details">
1634 <h3><a name=
"methodDetails">Events
</a></h3>
1635 <div class=
"content">
1637 <a name=
"beforeMoveEvent">beforeMoveEvent
</a></h4>
1638 <div class=
"detail">
1643 <strong>beforeMoveEvent
</strong>
1659 <div class=
"description">
1660 CustomEvent fired before the Overlay is moved.
1663 <div class=
"description">
1667 <dt>Parameters:
</dt>
1669 <code>x
<Number
></code>
1673 <code>y
<Number
></code>
1684 <a name=
"moveEvent">moveEvent
</a></h4>
1685 <div class=
"detail">
1690 <strong>moveEvent
</strong>
1706 <div class=
"description">
1707 CustomEvent fired after the Overlay is moved.
1710 <div class=
"description">
1714 <dt>Parameters:
</dt>
1716 <code>x
<Number
></code>
1720 <code>y
<Number
></code>
1731 <a name=
"YAHOO.widget.Overlay.windowResizeEvent">YAHOO.widget.Overlay.windowResizeEvent
</a></h4>
1732 <div class=
"detail">
1737 <strong>YAHOO.widget.Overlay.windowResizeEvent
</strong>
1744 <div class=
"description">
1745 A singleton CustomEvent used for reacting to the DOM event for window resize
1748 <div class=
"description">
1758 <a name=
"YAHOO.widget.Overlay.windowScrollEvent">YAHOO.widget.Overlay.windowScrollEvent
</a></h4>
1759 <div class=
"detail">
1764 <strong>YAHOO.widget.Overlay.windowScrollEvent
</strong>
1771 <div class=
"description">
1772 A singleton CustomEvent used for reacting to the DOM event for window scroll
1775 <div class=
"description">
1788 <div class=
"section field inheritance">
1789 <h4>Events inherited from
<a href=
"YAHOO.widget.Module.html">YAHOO.widget.Module
</a>:
</h4>
1790 <div class=
"content">
1793 <a href=
"YAHOO.widget.Module.html#appendEvent">appendEvent
</a>,
1794 <a href=
"YAHOO.widget.Module.html#beforeHideEvent">beforeHideEvent
</a>,
1795 <a href=
"YAHOO.widget.Module.html#beforeInitEvent">beforeInitEvent
</a>,
1796 <a href=
"YAHOO.widget.Module.html#beforeRenderEvent">beforeRenderEvent
</a>,
1797 <a href=
"YAHOO.widget.Module.html#beforeShowEvent">beforeShowEvent
</a>,
1798 <a href=
"YAHOO.widget.Module.html#changeBodyEvent">changeBodyEvent
</a>,
1799 <a href=
"YAHOO.widget.Module.html#changeContentEvent">changeContentEvent
</a>,
1800 <a href=
"YAHOO.widget.Module.html#changeFooterEvent">changeFooterEvent
</a>,
1801 <a href=
"YAHOO.widget.Module.html#changeHeaderEvent">changeHeaderEvent
</a>,
1802 <a href=
"YAHOO.widget.Module.html#destroyEvent">destroyEvent
</a>,
1803 <a href=
"YAHOO.widget.Module.html#hideEvent">hideEvent
</a>,
1804 <a href=
"YAHOO.widget.Module.html#initEvent">initEvent
</a>,
1805 <a href=
"YAHOO.widget.Module.html#renderEvent">renderEvent
</a>,
1806 <a href=
"YAHOO.widget.Module.html#showEvent">showEvent
</a>,
1807 <a href=
"YAHOO.widget.Module.html#YAHOO.widget.Module.textResizeEvent">YAHOO.widget.Module.textResizeEvent
</a>
1812 <div class=
"section field details">
1813 <h3><a name=
"field_detail">Configuration Attributes
</a></h3>
1814 <div class=
"content">
1815 <h4><a name=
"constraintoviewport">constraintoviewport
</a>
1816 <code>- Boolean
</code>
1818 <div class=
"detail">
1819 <div class=
"description">
1820 True if the Overlay should be prevented from being positioned out of the viewport.
1825 <div class=
"default">
1826 Default Value: false
1830 <h4><a name=
"context">context
</a>
1831 <code>- Array
</code>
1833 <div class=
"detail">
1834 <div class=
"description">
1835 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.
1840 <div class=
"default">
1845 <h4><a name=
"fixedcenter">fixedcenter
</a>
1846 <code>- Boolean
</code>
1848 <div class=
"detail">
1849 <div class=
"description">
1850 True if the Overlay should be anchored to the center of the viewport.
1855 <div class=
"default">
1856 Default Value: false
1860 <h4><a name=
"height">height
</a>
1861 <code>- String
</code>
1863 <div class=
"detail">
1864 <div class=
"description">
1865 CSS height of the Overlay.
1870 <div class=
"default">
1875 <h4><a name=
"iframe">iframe
</a>
1876 <code>- Boolean
</code>
1878 <div class=
"detail">
1879 <div class=
"description">
1880 True if the Overlay should have an IFRAME shim (for correcting the select z-index bug in IE6 and below).
1885 <div class=
"default">
1886 Default Value: true for IE6 and below, false for all others
1890 <h4><a name=
"width">width
</a>
1891 <code>- String
</code>
1893 <div class=
"detail">
1894 <div class=
"description">
1895 CSS width of the Overlay.
1900 <div class=
"default">
1905 <h4><a name=
"x">x
</a>
1906 <code>- Number
</code>
1908 <div class=
"detail">
1909 <div class=
"description">
1910 The absolute x-coordinate position of the Overlay
1915 <div class=
"default">
1920 <h4><a name=
"xy">xy
</a>
1921 <code>- Number[]
</code>
1923 <div class=
"detail">
1924 <div class=
"description">
1925 An array with the absolute x and y positions of the Overlay
1930 <div class=
"default">
1935 <h4><a name=
"y">y
</a>
1936 <code>- Number
</code>
1938 <div class=
"detail">
1939 <div class=
"description">
1940 The absolute y-coordinate position of the Overlay
1945 <div class=
"default">
1950 <h4><a name=
"zIndex">zIndex
</a>
1951 <code>- Number
</code>
1953 <div class=
"detail">
1954 <div class=
"description">
1955 CSS z-index of the Overlay.
1960 <div class=
"default">
1969 <div class=
"section field inheritance">
1970 <h4>Configuration attributes inherited from
<a href=
"YAHOO.widget.Module.html">YAHOO.widget.Module
</a>:
</h4>
1971 <div class=
"content">
1974 <a href=
"YAHOO.widget.Module.html#effect">effect
</a>,
1975 <a href=
"YAHOO.widget.Module.html#monitorresize">monitorresize
</a>,
1976 <a href=
"YAHOO.widget.Module.html#visible">visible
</a>
1986 <div class=
"module">
1988 <ul class=
"content">
1990 <li class=
""><a href=
"module_animation.html">animation
</a></li>
1992 <li class=
""><a href=
"module_autocomplete.html">autocomplete
</a></li>
1994 <li class=
""><a href=
"module_button.html">button
</a></li>
1996 <li class=
""><a href=
"module_calendar.html">calendar
</a></li>
1998 <li class=
""><a href=
"module_connection.html">connection
</a></li>
2000 <li class=
"selected"><a href=
"module_container.html">container
</a></li>
2002 <li class=
""><a href=
"module_datasource.html">datasource
</a></li>
2004 <li class=
""><a href=
"module_datatable.html">datatable
</a></li>
2006 <li class=
""><a href=
"module_dom.html">dom
</a></li>
2008 <li class=
""><a href=
"module_dragdrop.html">dragdrop
</a></li>
2010 <li class=
""><a href=
"module_element.html">element
</a></li>
2012 <li class=
""><a href=
"module_event.html">event
</a></li>
2014 <li class=
""><a href=
"module_history.html">history
</a></li>
2016 <li class=
""><a href=
"module_logger.html">logger
</a></li>
2018 <li class=
""><a href=
"module_menu.html">menu
</a></li>
2020 <li class=
""><a href=
"module_slider.html">slider
</a></li>
2022 <li class=
""><a href=
"module_tabview.html">tabview
</a></li>
2024 <li class=
""><a href=
"module_treeview.html">treeview
</a></li>
2026 <li class=
""><a href=
"module_yahoo.html">yahoo
</a></li>
2030 <div class=
"module">
2032 <ul class=
"content">
2033 <li class=
""><a href=
"YAHOO.util.Config.html">YAHOO.util.Config
</a></li>
2034 <li class=
""><a href=
"YAHOO.util.KeyListener.html">YAHOO.util.KeyListener
</a></li>
2035 <li class=
""><a href=
"YAHOO.widget.ContainerEffect.html">YAHOO.widget.ContainerEffect
</a></li>
2036 <li class=
""><a href=
"YAHOO.widget.Dialog.html">YAHOO.widget.Dialog
</a></li>
2037 <li class=
""><a href=
"YAHOO.widget.Module.html">YAHOO.widget.Module
</a></li>
2038 <li class=
"selected"><a href=
"YAHOO.widget.Overlay.html">YAHOO.widget.Overlay
</a></li>
2039 <li class=
""><a href=
"YAHOO.widget.OverlayManager.html">YAHOO.widget.OverlayManager
</a></li>
2040 <li class=
""><a href=
"YAHOO.widget.Panel.html">YAHOO.widget.Panel
</a></li>
2041 <li class=
""><a href=
"YAHOO.widget.SimpleDialog.html">YAHOO.widget.SimpleDialog
</a></li>
2042 <li class=
""><a href=
"YAHOO.widget.Tooltip.html">YAHOO.widget.Tooltip
</a></li>
2046 <div class=
"module">
2048 <ul class=
"content">
2049 <li class=
""><a href=
"Config.js.html">Config.js
</a></li>
2050 <li class=
""><a href=
"ContainerEffect.js.html">ContainerEffect.js
</a></li>
2051 <li class=
""><a href=
"Dialog.js.html">Dialog.js
</a></li>
2052 <li class=
""><a href=
"KeyListener.js.html">KeyListener.js
</a></li>
2053 <li class=
""><a href=
"Module.js.html">Module.js
</a></li>
2054 <li class=
""><a href=
"Overlay.js.html">Overlay.js
</a></li>
2055 <li class=
""><a href=
"OverlayManager.js.html">OverlayManager.js
</a></li>
2056 <li class=
""><a href=
"Panel.js.html">Panel.js
</a></li>
2057 <li class=
""><a href=
"SimpleDialog.js.html">SimpleDialog.js
</a></li>
2058 <li class=
""><a href=
"Tooltip.js.html">Tooltip.js
</a></li>
2062 <div class=
"module">
2064 <ul class=
"content">
2065 <li><a href=
"#YAHOO.widget.Overlay._initialized">YAHOO.widget.Overlay._initialized
</a>
2066 <!--<code><String></code>-->
2068 <li><a href=
"#YAHOO.widget.Overlay.BOTTOM_LEFT">YAHOO.widget.Overlay.BOTTOM_LEFT
</a>
2069 <!--<code><String></code>-->
2071 <li><a href=
"#YAHOO.widget.Overlay.BOTTOM_RIGHT">YAHOO.widget.Overlay.BOTTOM_RIGHT
</a>
2072 <!--<code><String></code>-->
2074 <li><a href=
"#YAHOO.widget.Overlay.CSS_OVERLAY">YAHOO.widget.Overlay.CSS_OVERLAY
</a>
2075 <!--<code><String></code>-->
2077 <li><a href=
"#YAHOO.widget.Overlay.IFRAME_SRC">YAHOO.widget.Overlay.IFRAME_SRC
</a>
2078 <!--<code><String></code>-->
2080 <li><a href=
"#YAHOO.widget.Overlay.TOP_LEFT">YAHOO.widget.Overlay.TOP_LEFT
</a>
2081 <!--<code><String></code>-->
2083 <li><a href=
"#YAHOO.widget.Overlay.TOP_RIGHT">YAHOO.widget.Overlay.TOP_RIGHT
</a>
2084 <!--<code><String></code>-->
2089 <div class=
"module">
2091 <ul class=
"content">
2092 <li><!--<code>void</code>-->
2093 <a href=
"#align">align
</a>
2095 <li><!--<code>void</code>-->
2096 <a href=
"#center">center
</a>
2098 <li><!--<code>void</code>-->
2099 <a href=
"#configConstrainToViewport">configConstrainToViewport
</a>
2101 <li><!--<code>void</code>-->
2102 <a href=
"#configContext">configContext
</a>
2104 <li><!--<code>void</code>-->
2105 <a href=
"#configFixedCenter">configFixedCenter
</a>
2107 <li><!--<code>void</code>-->
2108 <a href=
"#configHeight">configHeight
</a>
2110 <li><!--<code>void</code>-->
2111 <a href=
"#configIframe">configIframe
</a>
2113 <li><!--<code>void</code>-->
2114 <a href=
"#configVisible">configVisible
</a>
2116 <li><!--<code>void</code>-->
2117 <a href=
"#configWidth">configWidth
</a>
2119 <li><!--<code>void</code>-->
2120 <a href=
"#configX">configX
</a>
2122 <li><!--<code>void</code>-->
2123 <a href=
"#configXY">configXY
</a>
2125 <li><!--<code>void</code>-->
2126 <a href=
"#configY">configY
</a>
2128 <li><!--<code>void</code>-->
2129 <a href=
"#configzIndex">configzIndex
</a>
2131 <li><!--<code>void</code>-->
2132 <a href=
"#destroy">destroy
</a>
2134 <li><!--<code>void</code>-->
2135 <a href=
"#doCenterOnDOMEvent">doCenterOnDOMEvent
</a>
2137 <li><!--<code>void</code>-->
2138 <a href=
"#enforceConstraints">enforceConstraints
</a>
2140 <li><!--<code>void</code>-->
2141 <a href=
"#hideIframe">hideIframe
</a>
2143 <li><!--<code>void</code>-->
2144 <a href=
"#hideMacGeckoScrollbars">hideMacGeckoScrollbars
</a>
2146 <li><!--<code>void</code>-->
2147 <a href=
"#init">init
</a>
2149 <li><!--<code>void</code>-->
2150 <a href=
"#initDefaultConfig">initDefaultConfig
</a>
2152 <li><!--<code>void</code>-->
2153 <a href=
"#initEvents">initEvents
</a>
2155 <li><!--<code>void</code>-->
2156 <a href=
"#moveTo">moveTo
</a>
2158 <li><!--<code>void</code>-->
2159 <a href=
"#onDomResize">onDomResize
</a>
2161 <li><!--<code>void</code>-->
2162 <a href=
"#showIframe">showIframe
</a>
2164 <li><!--<code>void</code>-->
2165 <a href=
"#showMacGeckoScrollbars">showMacGeckoScrollbars
</a>
2167 <li><!--<code>void</code>-->
2168 <a href=
"#syncPosition">syncPosition
</a>
2170 <li><!--<code>String</code>-->
2171 <a href=
"#toString">toString
</a>
2173 <li><!--<code>void</code>-->
2174 <a href=
"#YAHOO.widget.Overlay.windowResizeHandler">YAHOO.widget.Overlay.windowResizeHandler
</a>
2176 <li><!--<code>void</code>-->
2177 <a href=
"#YAHOO.widget.Overlay.windowScrollHandler">YAHOO.widget.Overlay.windowScrollHandler
</a>
2182 <div class=
"module">
2184 <ul class=
"content">
2186 <a href=
"#beforeMoveEvent">beforeMoveEvent
</a>
2189 <a href=
"#moveEvent">moveEvent
</a>
2192 <a href=
"#YAHOO.widget.Overlay.windowResizeEvent">YAHOO.widget.Overlay.windowResizeEvent
</a>
2195 <a href=
"#YAHOO.widget.Overlay.windowScrollEvent">YAHOO.widget.Overlay.windowScrollEvent
</a>
2200 <div class=
"module">
2201 <h4>Configuration Attributes
</h4>
2202 <ul class=
"content">
2204 <a href=
"#constraintoviewport">constraintoviewport
</a>
2207 <a href=
"#context">context
</a>
2210 <a href=
"#fixedcenter">fixedcenter
</a>
2213 <a href=
"#height">height
</a>
2216 <a href=
"#iframe">iframe
</a>
2219 <a href=
"#width">width
</a>
2225 <a href=
"#xy">xy
</a>
2231 <a href=
"#zIndex">zIndex
</a>
2241 Copyright
© 2007 Yahoo! Inc. All rights reserved.