Simple status box for the sidebar.
[elgg_plugins.git] / yui / docs / YAHOO.widget.OverlayManager.html
blob2e82013fae790eeaba937452f1a2c8c23d791265
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
2 <html>
3 <head>
4 <title>API: container YAHOO.widget.OverlayManager (YUI Library)</title>
5 <link rel="stylesheet" type="text/css" href="assets/api.css">
6 </head>
8 <body id="yahoo-com">
9 <div id="doc3" class="yui-t2">
11 <div id="hd">
12 <h1>Yahoo! UI Library</h1>
13 <h3>Container&nbsp; <span class="subtitle">2.2.0</span></h3>
14 <p>
15 <a href="./index.html">Yahoo! UI Library</a>
16 &gt; <a href="./module_container.html">container</a>
17 &gt; YAHOO.widget.OverlayManager
19 </p>
20 </div>
22 <div id="bd">
23 <div id="yui-main">
24 <div class="yui-b">
27 <h2>
32 Class <b>YAHOO.widget.OverlayManager</b>
33 <span class="extends">
34 </span>
36 <span class="extends">
37 </span>
39 </code>
40 </h2>
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
48 </div>
50 <div class="section constructor details">
51 <h3><a name="constructor_detail">Constructor</a></h3>
52 <div class="content">
53 <div class="detail">
54 <strong>YAHOO.widget.OverlayManager</strong>
55 <code>
60 overlays
63 userConfig
65 </code>
66 <div class="description">
67 <dl>
68 <dt>Parameters:</dt>
69 <dd>
70 <code>overlays
71 &lt;Array&gt;
72 </code>
73 Optional. A collection of Overlays to register with the manager.
74 </dd>
75 <dd>
76 <code>userConfig
77 &lt;Object&gt;
78 </code>
79 The object literal representing the user configuration of the OverlayManager
80 </dd>
81 </dl>
84 </div>
85 </div>
86 </div>
87 </div>
89 <div class="section field details">
90 <h3><a name="field_detail">Properties</a></h3>
91 <div class="content">
92 <h4><a name="activeOverlay">activeOverlay</a>
93 <code>- private YAHOO.widget.Overlay</code>
94 </h4>
95 <div class="detail">
96 <div class="description">
97 The currently activated Overlay
98 </div>
99 </div>
104 <hr />
105 <h4><a name="cfg">cfg</a>
106 <code>- YAHOO.util.Config</code>
107 </h4>
108 <div class="detail">
109 <div class="description">
110 The OverlayManager's Config object used for monitoring configuration properties.
111 </div>
112 </div>
117 <hr />
118 <h4><a name="contructor">contructor</a>
119 <code>- Function</code>
120 </h4>
121 <div class="detail">
122 <div class="description">
123 The class's constructor function
124 </div>
125 </div>
130 <hr />
131 <h4><a name="overlays">overlays</a>
132 <code>- YAHOO.widget.Overlay[]</code>
133 </h4>
134 <div class="detail">
135 <div class="description">
136 The array of Overlays that are currently registered
137 </div>
138 </div>
143 <hr />
144 <h4><a name="YAHOO.widget.OverlayManager.CSS_FOCUSED">YAHOO.widget.OverlayManager.CSS_FOCUSED</a>
145 <code>- static final String</code>
146 </h4>
147 <div class="detail">
148 <div class="description">
149 The CSS class representing a focused Overlay
150 </div>
151 </div>
156 <hr />
159 </div>
160 </div>
163 <div class="section method details">
164 <h3><a name="methodDetails">Methods</a></h3>
165 <div class="content">
166 <h4>
167 <a name="blurAll">blurAll</a></h4>
168 <div class="detail">
169 <code>
173 void
174 <strong>blurAll</strong>
177 </code>
179 <div class="description">
180 Removes focus from all registered Overlays in the manager
181 </div>
183 <div class="description">
186 <dl>
187 <dt>Returns:
188 <code>
189 void
190 </code></dt>
191 <dd></dd>
192 </dl>
194 </div>
196 </div>
197 <hr />
198 <h4>
199 <a name="compareZIndexDesc">compareZIndexDesc</a></h4>
200 <div class="detail">
201 <code>
202 private
205 Number
206 <strong>compareZIndexDesc</strong>
209 </code>
211 <div class="description">
212 Used for sorting the manager's Overlays by z-index.
213 </div>
215 <div class="description">
218 <dl>
219 <dt>Returns:
220 <code>
221 Number
222 </code></dt>
223 <dd>0, 1, or -1, depending on where the Overlay should fall in the stacking order.</dd>
224 </dl>
226 </div>
228 </div>
229 <hr />
230 <h4>
231 <a name="find">find</a></h4>
232 <div class="detail">
233 <code>
237 YAHOO.widget.Overlay
238 <strong>find</strong>
242 overlay
248 </code>
250 <div class="description">
251 Attempts to locate an Overlay by instance or ID.
252 </div>
254 <div class="description">
256 <dl>
257 <dt>Parameters:</dt>
258 <dd>
259 <code>overlay &lt;YAHOO.widget.Overlay&gt;</code>
260 An Overlay to locate within the manager
261 </dd>
262 <dd>
263 <code>overlay &lt;String&gt;</code>
264 An Overlay id to locate within the manager
265 </dd>
266 </dl>
268 <dl>
269 <dt>Returns:
270 <code>
271 YAHOO.widget.Overlay
272 </code></dt>
273 <dd>The requested Overlay, if found, or null if it cannot be located.</dd>
274 </dl>
276 </div>
278 </div>
279 <hr />
280 <h4>
281 <a name="focus">focus</a></h4>
282 <div class="detail">
283 <code>
287 void
288 <strong>focus</strong>
292 overlay
298 </code>
300 <div class="description">
301 Focuses the specified Overlay
302 </div>
304 <div class="description">
306 <dl>
307 <dt>Parameters:</dt>
308 <dd>
309 <code>overlay &lt;YAHOO.widget.Overlay&gt;</code>
310 The Overlay to focus
311 </dd>
312 <dd>
313 <code>overlay &lt;String&gt;</code>
314 The id of the Overlay to focus
315 </dd>
316 </dl>
318 <dl>
319 <dt>Returns:
320 <code>
321 void
322 </code></dt>
323 <dd></dd>
324 </dl>
326 </div>
328 </div>
329 <hr />
330 <h4>
331 <a name="getActive">getActive</a></h4>
332 <div class="detail">
333 <code>
337 YAHOO.widget.Overlay
338 <strong>getActive</strong>
341 </code>
343 <div class="description">
344 Returns the currently focused Overlay
345 </div>
347 <div class="description">
350 <dl>
351 <dt>Returns:
352 <code>
353 YAHOO.widget.Overlay
354 </code></dt>
355 <dd>The currently focused Overlay</dd>
356 </dl>
358 </div>
360 </div>
361 <hr />
362 <h4>
363 <a name="hideAll">hideAll</a></h4>
364 <div class="detail">
365 <code>
369 void
370 <strong>hideAll</strong>
373 </code>
375 <div class="description">
376 Hides all Overlays in the manager.
377 </div>
379 <div class="description">
382 <dl>
383 <dt>Returns:
384 <code>
385 void
386 </code></dt>
387 <dd></dd>
388 </dl>
390 </div>
392 </div>
393 <hr />
394 <h4>
395 <a name="init">init</a></h4>
396 <div class="detail">
397 <code>
401 void
402 <strong>init</strong>
406 overlays
410 userConfig
414 </code>
416 <div class="description">
417 Initializes the OverlayManager
418 </div>
420 <div class="description">
422 <dl>
423 <dt>Parameters:</dt>
424 <dd>
425 <code>overlays &lt;YAHOO.widget.Overlay[]&gt;</code>
426 Optional. A collection of Overlays to register with the manager.
427 </dd>
428 <dd>
429 <code>userConfig &lt;Object&gt;</code>
430 The object literal representing the user configuration of the OverlayManager
431 </dd>
432 </dl>
434 <dl>
435 <dt>Returns:
436 <code>
437 void
438 </code></dt>
439 <dd></dd>
440 </dl>
442 </div>
444 </div>
445 <hr />
446 <h4>
447 <a name="initDefaultConfig">initDefaultConfig</a></h4>
448 <div class="detail">
449 <code>
453 void
454 <strong>initDefaultConfig</strong>
457 </code>
459 <div class="description">
460 Initializes the default configuration of the OverlayManager
461 </div>
463 <div class="description">
466 <dl>
467 <dt>Returns:
468 <code>
469 void
470 </code></dt>
471 <dd></dd>
472 </dl>
474 </div>
476 </div>
477 <hr />
478 <h4>
479 <a name="register">register</a></h4>
480 <div class="detail">
481 <code>
485 Boolean
486 <strong>register</strong>
490 overlay
496 </code>
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.
500 </div>
502 <div class="description">
504 <dl>
505 <dt>Parameters:</dt>
506 <dd>
507 <code>overlay &lt;YAHOO.widget.Overlay&gt;</code>
508 An Overlay to register with the manager.
509 </dd>
510 <dd>
511 <code>overlay &lt;YAHOO.widget.Overlay[]&gt;</code>
512 An array of Overlays to register with the manager.
513 </dd>
514 </dl>
516 <dl>
517 <dt>Returns:
518 <code>
519 Boolean
520 </code></dt>
521 <dd>True if any Overlays are registered.</dd>
522 </dl>
524 </div>
526 </div>
527 <hr />
528 <h4>
529 <a name="remove">remove</a></h4>
530 <div class="detail">
531 <code>
535 void
536 <strong>remove</strong>
540 overlay
546 </code>
548 <div class="description">
549 Removes the specified Overlay from the manager
550 </div>
552 <div class="description">
554 <dl>
555 <dt>Parameters:</dt>
556 <dd>
557 <code>overlay &lt;YAHOO.widget.Overlay&gt;</code>
558 The Overlay to remove
559 </dd>
560 <dd>
561 <code>overlay &lt;String&gt;</code>
562 The id of the Overlay to remove
563 </dd>
564 </dl>
566 <dl>
567 <dt>Returns:
568 <code>
569 void
570 </code></dt>
571 <dd></dd>
572 </dl>
574 </div>
576 </div>
577 <hr />
578 <h4>
579 <a name="showAll">showAll</a></h4>
580 <div class="detail">
581 <code>
585 void
586 <strong>showAll</strong>
589 </code>
591 <div class="description">
592 Shows all Overlays in the manager.
593 </div>
595 <div class="description">
598 <dl>
599 <dt>Returns:
600 <code>
601 void
602 </code></dt>
603 <dd></dd>
604 </dl>
606 </div>
608 </div>
609 <hr />
610 <h4>
611 <a name="toString">toString</a></h4>
612 <div class="detail">
613 <code>
617 String
618 <strong>toString</strong>
621 </code>
623 <div class="description">
624 Returns a string representation of the object.
625 </div>
627 <div class="description">
630 <dl>
631 <dt>Returns:
632 <code>
633 String
634 </code></dt>
635 <dd>The string representation of the OverlayManager</dd>
636 </dl>
638 </div>
640 </div>
641 <hr />
642 </div>
643 </div>
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>
654 </h4>
655 <div class="detail">
656 <div class="description">
657 The default DOM event that should be used to focus an Overlay
658 </div>
659 </div>
662 <div class="default">
663 Default Value: "mousedown"
664 </div>
666 <hr />
667 <h4><a name="overlays">overlays</a>
668 <code>- YAHOO.widget.Overlay[]</code>
669 </h4>
670 <div class="detail">
671 <div class="description">
672 The collection of registered Overlays in use by the OverlayManager
673 </div>
674 </div>
677 <div class="default">
678 Default Value: null
679 </div>
681 <hr />
683 </div>
684 </div>
687 </div>
688 </div>
689 <div class="yui-b">
690 <div class="nav">
692 <div class="module">
693 <h4>Modules</h4>
694 <ul class="content">
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>
733 </ul>
734 </div>
736 <div class="module">
737 <h4>Classes</h4>
738 <ul class="content">
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>
749 </ul>
750 </div>
752 <div class="module">
753 <h4>Files</h4>
754 <ul class="content">
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>
765 </ul>
766 </div>
768 <div class="module">
769 <h4>Properties</h4>
770 <ul class="content">
771 <li><a href="#activeOverlay">activeOverlay</a>
772 <!--<code>&lt;String&gt;</code>-->
773 </li>
774 <li><a href="#cfg">cfg</a>
775 <!--<code>&lt;String&gt;</code>-->
776 </li>
777 <li><a href="#contructor">contructor</a>
778 <!--<code>&lt;String&gt;</code>-->
779 </li>
780 <li><a href="#overlays">overlays</a>
781 <!--<code>&lt;String&gt;</code>-->
782 </li>
783 <li><a href="#YAHOO.widget.OverlayManager.CSS_FOCUSED">YAHOO.widget.OverlayManager.CSS_FOCUSED</a>
784 <!--<code>&lt;String&gt;</code>-->
785 </li>
786 </ul>
787 </div>
789 <div class="module">
790 <h4>Methods</h4>
791 <ul class="content">
792 <li><!--<code>void</code>-->
793 <a href="#blurAll">blurAll</a>
794 </li>
795 <li><!--<code>Number</code>-->
796 <a href="#compareZIndexDesc">compareZIndexDesc</a>
797 </li>
798 <li><!--<code>YAHOO.widget.Overlay</code>-->
799 <a href="#find">find</a>
800 </li>
801 <li><!--<code>void</code>-->
802 <a href="#focus">focus</a>
803 </li>
804 <li><!--<code>YAHOO.widget.Overlay</code>-->
805 <a href="#getActive">getActive</a>
806 </li>
807 <li><!--<code>void</code>-->
808 <a href="#hideAll">hideAll</a>
809 </li>
810 <li><!--<code>void</code>-->
811 <a href="#init">init</a>
812 </li>
813 <li><!--<code>void</code>-->
814 <a href="#initDefaultConfig">initDefaultConfig</a>
815 </li>
816 <li><!--<code>Boolean</code>-->
817 <a href="#register">register</a>
818 </li>
819 <li><!--<code>void</code>-->
820 <a href="#remove">remove</a>
821 </li>
822 <li><!--<code>void</code>-->
823 <a href="#showAll">showAll</a>
824 </li>
825 <li><!--<code>String</code>-->
826 <a href="#toString">toString</a>
827 </li>
828 </ul>
829 </div>
832 <div class="module">
833 <h4>Configuration Attributes</h4>
834 <ul class="content">
835 <li>
836 <a href="#focusevent">focusevent</a>
837 </li>
838 <li>
839 <a href="#overlays">overlays</a>
840 </li>
841 </ul>
842 </div>
844 </div>
845 </div>
846 </div>
847 <div id="ft">
848 <hr />
849 Copyright &copy; 2007 Yahoo! Inc. All rights reserved.
850 </div>
851 </div>
852 </body>
853 </html>