1 <!DOCTYPE HTML PUBLIC
"-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
4 <title>API: container YAHOO.widget.OverlayManager (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.OverlayManager
32 Class
<b>YAHOO.widget.OverlayManager
</b>
33 <span class=
"extends">
36 <span class=
"extends">
41 <!-- class tree goes here -->
46 <div class=
"summary description">
47 OverlayManager is used for maintaining the focus status of multiple Overlays.* @namespace YAHOO.widget
50 <div class=
"section constructor details">
51 <h3><a name=
"constructor_detail">Constructor
</a></h3>
54 <strong>YAHOO.widget.OverlayManager
</strong>
66 <div class=
"description">
73 Optional. A collection of Overlays to register with the manager.
79 The object literal representing the user configuration of the OverlayManager
89 <div class=
"section field details">
90 <h3><a name=
"field_detail">Properties
</a></h3>
92 <h4><a name=
"activeOverlay">activeOverlay
</a>
93 <code>- private YAHOO.widget.Overlay
</code>
96 <div class=
"description">
97 The currently activated Overlay
105 <h4><a name=
"cfg">cfg
</a>
106 <code>- YAHOO.util.Config
</code>
109 <div class=
"description">
110 The OverlayManager's Config object used for monitoring configuration properties.
118 <h4><a name=
"contructor">contructor
</a>
119 <code>- Function
</code>
122 <div class=
"description">
123 The class's constructor function
131 <h4><a name=
"overlays">overlays
</a>
132 <code>- YAHOO.widget.Overlay[]
</code>
135 <div class=
"description">
136 The array of Overlays that are currently registered
144 <h4><a name=
"YAHOO.widget.OverlayManager.CSS_FOCUSED">YAHOO.widget.OverlayManager.CSS_FOCUSED
</a>
145 <code>- static final String
</code>
148 <div class=
"description">
149 The CSS class representing a focused Overlay
163 <div class=
"section method details">
164 <h3><a name=
"methodDetails">Methods
</a></h3>
165 <div class=
"content">
167 <a name=
"blurAll">blurAll
</a></h4>
174 <strong>blurAll
</strong>
179 <div class=
"description">
180 Removes focus from all registered Overlays in the manager
183 <div class=
"description">
199 <a name=
"compareZIndexDesc">compareZIndexDesc
</a></h4>
206 <strong>compareZIndexDesc
</strong>
211 <div class=
"description">
212 Used for sorting the manager's Overlays by z-index.
215 <div class=
"description">
223 <dd>0,
1, or -
1, depending on where the Overlay should fall in the stacking order.
</dd>
231 <a name=
"find">find
</a></h4>
238 <strong>find
</strong>
250 <div class=
"description">
251 Attempts to locate an Overlay by instance or ID.
254 <div class=
"description">
259 <code>overlay
<YAHOO.widget.Overlay
></code>
260 An Overlay to locate within the manager
263 <code>overlay
<String
></code>
264 An Overlay id to locate within the manager
273 <dd>The requested Overlay, if found, or null if it cannot be located.
</dd>
281 <a name=
"focus">focus
</a></h4>
288 <strong>focus
</strong>
300 <div class=
"description">
301 Focuses the specified Overlay
304 <div class=
"description">
309 <code>overlay
<YAHOO.widget.Overlay
></code>
313 <code>overlay
<String
></code>
314 The id of the Overlay to focus
331 <a name=
"getActive">getActive
</a></h4>
338 <strong>getActive
</strong>
343 <div class=
"description">
344 Returns the currently focused Overlay
347 <div class=
"description">
355 <dd>The currently focused Overlay
</dd>
363 <a name=
"hideAll">hideAll
</a></h4>
370 <strong>hideAll
</strong>
375 <div class=
"description">
376 Hides all Overlays in the manager.
379 <div class=
"description">
395 <a name=
"init">init
</a></h4>
402 <strong>init
</strong>
416 <div class=
"description">
417 Initializes the OverlayManager
420 <div class=
"description">
425 <code>overlays
<YAHOO.widget.Overlay[]
></code>
426 Optional. A collection of Overlays to register with the manager.
429 <code>userConfig
<Object
></code>
430 The object literal representing the user configuration of the OverlayManager
447 <a name=
"initDefaultConfig">initDefaultConfig
</a></h4>
454 <strong>initDefaultConfig
</strong>
459 <div class=
"description">
460 Initializes the default configuration of the OverlayManager
463 <div class=
"description">
479 <a name=
"register">register
</a></h4>
486 <strong>register
</strong>
498 <div class=
"description">
499 Registers an Overlay or an array of Overlays with the manager. Upon registration, the Overlay receives functions for focus and blur, along with CustomEvents for each.
502 <div class=
"description">
507 <code>overlay
<YAHOO.widget.Overlay
></code>
508 An Overlay to register with the manager.
511 <code>overlay
<YAHOO.widget.Overlay[]
></code>
512 An array of Overlays to register with the manager.
521 <dd>True if any Overlays are registered.
</dd>
529 <a name=
"remove">remove
</a></h4>
536 <strong>remove
</strong>
548 <div class=
"description">
549 Removes the specified Overlay from the manager
552 <div class=
"description">
557 <code>overlay
<YAHOO.widget.Overlay
></code>
558 The Overlay to remove
561 <code>overlay
<String
></code>
562 The id of the Overlay to remove
579 <a name=
"showAll">showAll
</a></h4>
586 <strong>showAll
</strong>
591 <div class=
"description">
592 Shows all Overlays in the manager.
595 <div class=
"description">
611 <a name=
"toString">toString
</a></h4>
618 <strong>toString
</strong>
623 <div class=
"description">
624 Returns a string representation of the object.
627 <div class=
"description">
635 <dd>The string representation of the OverlayManager
</dd>
649 <div class=
"section field details">
650 <h3><a name=
"field_detail">Configuration Attributes
</a></h3>
651 <div class=
"content">
652 <h4><a name=
"focusevent">focusevent
</a>
653 <code>- String
</code>
656 <div class=
"description">
657 The default DOM event that should be used to focus an Overlay
662 <div class=
"default">
663 Default Value:
"mousedown"
667 <h4><a name=
"overlays">overlays
</a>
668 <code>- YAHOO.widget.Overlay[]
</code>
671 <div class=
"description">
672 The collection of registered Overlays in use by the OverlayManager
677 <div class=
"default">
696 <li class=
""><a href=
"module_animation.html">animation
</a></li>
698 <li class=
""><a href=
"module_autocomplete.html">autocomplete
</a></li>
700 <li class=
""><a href=
"module_button.html">button
</a></li>
702 <li class=
""><a href=
"module_calendar.html">calendar
</a></li>
704 <li class=
""><a href=
"module_connection.html">connection
</a></li>
706 <li class=
"selected"><a href=
"module_container.html">container
</a></li>
708 <li class=
""><a href=
"module_datasource.html">datasource
</a></li>
710 <li class=
""><a href=
"module_datatable.html">datatable
</a></li>
712 <li class=
""><a href=
"module_dom.html">dom
</a></li>
714 <li class=
""><a href=
"module_dragdrop.html">dragdrop
</a></li>
716 <li class=
""><a href=
"module_element.html">element
</a></li>
718 <li class=
""><a href=
"module_event.html">event
</a></li>
720 <li class=
""><a href=
"module_history.html">history
</a></li>
722 <li class=
""><a href=
"module_logger.html">logger
</a></li>
724 <li class=
""><a href=
"module_menu.html">menu
</a></li>
726 <li class=
""><a href=
"module_slider.html">slider
</a></li>
728 <li class=
""><a href=
"module_tabview.html">tabview
</a></li>
730 <li class=
""><a href=
"module_treeview.html">treeview
</a></li>
732 <li class=
""><a href=
"module_yahoo.html">yahoo
</a></li>
739 <li class=
""><a href=
"YAHOO.util.Config.html">YAHOO.util.Config
</a></li>
740 <li class=
""><a href=
"YAHOO.util.KeyListener.html">YAHOO.util.KeyListener
</a></li>
741 <li class=
""><a href=
"YAHOO.widget.ContainerEffect.html">YAHOO.widget.ContainerEffect
</a></li>
742 <li class=
""><a href=
"YAHOO.widget.Dialog.html">YAHOO.widget.Dialog
</a></li>
743 <li class=
""><a href=
"YAHOO.widget.Module.html">YAHOO.widget.Module
</a></li>
744 <li class=
""><a href=
"YAHOO.widget.Overlay.html">YAHOO.widget.Overlay
</a></li>
745 <li class=
"selected"><a href=
"YAHOO.widget.OverlayManager.html">YAHOO.widget.OverlayManager
</a></li>
746 <li class=
""><a href=
"YAHOO.widget.Panel.html">YAHOO.widget.Panel
</a></li>
747 <li class=
""><a href=
"YAHOO.widget.SimpleDialog.html">YAHOO.widget.SimpleDialog
</a></li>
748 <li class=
""><a href=
"YAHOO.widget.Tooltip.html">YAHOO.widget.Tooltip
</a></li>
755 <li class=
""><a href=
"Config.js.html">Config.js
</a></li>
756 <li class=
""><a href=
"ContainerEffect.js.html">ContainerEffect.js
</a></li>
757 <li class=
""><a href=
"Dialog.js.html">Dialog.js
</a></li>
758 <li class=
""><a href=
"KeyListener.js.html">KeyListener.js
</a></li>
759 <li class=
""><a href=
"Module.js.html">Module.js
</a></li>
760 <li class=
""><a href=
"Overlay.js.html">Overlay.js
</a></li>
761 <li class=
""><a href=
"OverlayManager.js.html">OverlayManager.js
</a></li>
762 <li class=
""><a href=
"Panel.js.html">Panel.js
</a></li>
763 <li class=
""><a href=
"SimpleDialog.js.html">SimpleDialog.js
</a></li>
764 <li class=
""><a href=
"Tooltip.js.html">Tooltip.js
</a></li>
771 <li><a href=
"#activeOverlay">activeOverlay
</a>
772 <!--<code><String></code>-->
774 <li><a href=
"#cfg">cfg
</a>
775 <!--<code><String></code>-->
777 <li><a href=
"#contructor">contructor
</a>
778 <!--<code><String></code>-->
780 <li><a href=
"#overlays">overlays
</a>
781 <!--<code><String></code>-->
783 <li><a href=
"#YAHOO.widget.OverlayManager.CSS_FOCUSED">YAHOO.widget.OverlayManager.CSS_FOCUSED
</a>
784 <!--<code><String></code>-->
792 <li><!--<code>void</code>-->
793 <a href=
"#blurAll">blurAll
</a>
795 <li><!--<code>Number</code>-->
796 <a href=
"#compareZIndexDesc">compareZIndexDesc
</a>
798 <li><!--<code>YAHOO.widget.Overlay</code>-->
799 <a href=
"#find">find
</a>
801 <li><!--<code>void</code>-->
802 <a href=
"#focus">focus
</a>
804 <li><!--<code>YAHOO.widget.Overlay</code>-->
805 <a href=
"#getActive">getActive
</a>
807 <li><!--<code>void</code>-->
808 <a href=
"#hideAll">hideAll
</a>
810 <li><!--<code>void</code>-->
811 <a href=
"#init">init
</a>
813 <li><!--<code>void</code>-->
814 <a href=
"#initDefaultConfig">initDefaultConfig
</a>
816 <li><!--<code>Boolean</code>-->
817 <a href=
"#register">register
</a>
819 <li><!--<code>void</code>-->
820 <a href=
"#remove">remove
</a>
822 <li><!--<code>void</code>-->
823 <a href=
"#showAll">showAll
</a>
825 <li><!--<code>String</code>-->
826 <a href=
"#toString">toString
</a>
833 <h4>Configuration Attributes
</h4>
836 <a href=
"#focusevent">focusevent
</a>
839 <a href=
"#overlays">overlays
</a>
849 Copyright
© 2007 Yahoo! Inc. All rights reserved.