oqapi/webgui
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
webgui/www/extras/yui/docs/container/YAHOO.widget.OverlayManager.html
JT Smith 4f68a0933c added YUI and YUI-ext 
fixed the resizable text area with IE problem
fixed the ad space with IE problem
merged the 7.2.0 and 7.1.4 change logs
2006-11-07 23:15:57 +00:00

890 lines
19 KiB
HTML
Raw Blame History

<html>
<head>
<title>JavaScript Documentation - </title>
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="header">
<h1>JavaScript Documentation</h1>
<h3><a href="./index.html">Yahoo! UI Library: Container</a></h3>
<div class="breadcrumbs">
<a href="./index.html">Yahoo! UI Library: Container</a>
&gt;
<strong>YAHOO.widget.OverlayManager</strong>
</div>
</div>
<div id="body">
<div class="nav">
<div class="module resources">
<ul class="content">
<li><a href="overview-tree.html">Tree View</a></li>
<li><a href="index-all.html">Element Index</a></li>
</ul>
</div>
<div class="module">
<h4><a href="./allclasses-noframe.html">Classes</a></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><a href="./overview-summary.html">Files</a></h4>
<ul class="content">
<li>
<a href="overview-summary-Config.js.html">
Config.js</a>
</li>
<li>
<a href="overview-summary-ContainerEffect.js.html">
ContainerEffect.js</a>
</li>
<li>
<a href="overview-summary-Dialog.js.html">
Dialog.js</a>
</li>
<li>
<a href="overview-summary-KeyListener.js.html">
KeyListener.js</a>
</li>
<li>
<a href="overview-summary-Module.js.html">
Module.js</a>
</li>
<li>
<a href="overview-summary-Overlay.js.html">
Overlay.js</a>
</li>
<li>
<a href="overview-summary-OverlayManager.js.html">
OverlayManager.js</a>
</li>
<li>
<a href="overview-summary-Panel.js.html">
Panel.js</a>
</li>
<li>
<a href="overview-summary-SimpleDialog.js.html">
SimpleDialog.js</a>
</li>
<li>
<a href="overview-summary-Tooltip.js.html">
Tooltip.js</a>
</li>
</ul>
</div>
</div>
<div id="pri">
<div class="main">
<h2>Class YAHOO.widget.OverlayManager</h2>
<pre>Object
|
+--<b>YAHOO.widget.OverlayManager</b>
</pre>
<hr />
<!-- Class definition -->
<div class="class-def">
<div class="class-name">
<span class="class-attribs">
</span>
<span class="class-type">class</span>
<b>YAHOO.widget.OverlayManager</b>
</div>
<div class="class-extends">
</div>
</div>
<div class="meta">
</div>
<!-- ======== QUICK LINKS ======== -->
<div class="quick-links">
<strong>Quick Links:</strong>&nbsp;
<a href="#field_summary">Field Summary</a>
|
<a href="#constructor_summary">Constructor Summary</a>
|
<a href="#methodSummary">Method Summary</a> |
<a href="#methodDetails">Method Details</a>
</div>
<!-- ======== END QUICK LINKS ======== -->
<!-- ======== NESTED CLASS SUMMARY ======== -->
<!-- ======== END NESTED CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<div class="section field summaries">
<h3><a name="field_summary">Field Summary</a> <span class="top">[<a href="#top">top</a>]</span></h3>
<div class="content">
<table border="1" cellpadding="3" cellspacing="0">
<tr>
<td class="flags">Array</td>
<td class="spec">
<code>
<a href="#overlays">overlays</a>
</code>
<div class="description">
The array of Overlays that are currently registered&nbsp;
</div>
</td>
</tr>
<tr>
<td class="flags">string</td>
<td class="spec">
<code>
<a href="#CSS_FOCUSED">CSS_FOCUSED</a>
</code>
<div class="description">
The CSS class representing a focused Overlay&nbsp;
</div>
</td>
</tr>
</table>
</div>
</div>
<!-- =========== END FIELD SUMMARY =========== -->
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<div class="section contructor summaries">
<h3><a name="constructor_summary">Constructor Summary</a> <span class="top">[<a href="#top">top</a>]</span></h3>
<div class="content">
<code class="spec">
<a href="YAHOO.widget.OverlayManager.html#YAHOO.widget.OverlayManager()">YAHOO.widget.OverlayManager</a>
</code>
<div class="description">
OverlayManager is used for maintaining the focus status of multiple Overlays.&nbsp;
</div>
</div>
</div>
<!-- ======== END CONSTRUCTOR SUMMARY ======== -->
<!-- ========== METHOD SUMMARY =========== -->
<div class="section method summaries">
<h3><a name="methodSummary">Method Summary</a> <span class="top">[<a href="#top">top</a>]</span></h3>
<div class="content">
<table border="1" cellpadding="3" cellspacing="0">
<tr>
<td class="flags">void</td>
<td class="spec">
<code>
<a href="#blurAll">blurAll</a>
()
</code>
<div class="description">
Removes focus from all registered Overlays in the manager&nbsp;
</div>
</td>
</tr>
<tr>
<td class="flags">Overlay</td>
<td class="spec">
<code>
<a href="#find">find</a>
(&lt;Overlay&gt; &lt;string&gt; overlay)
</code>
<div class="description">
Attempts to locate an Overlay by instance or ID.&nbsp;
</div>
</td>
</tr>
<tr>
<td class="flags">void</td>
<td class="spec">
<code>
<a href="#focus">focus</a>
(overlay)
</code>
<div class="description">
Focuses the specified Overlay&nbsp;
</div>
</td>
</tr>
<tr>
<td class="flags">Overlay</td>
<td class="spec">
<code>
<a href="#getActive">getActive</a>
()
</code>
<div class="description">
Returns the currently focused Overlay&nbsp;
</div>
</td>
</tr>
<tr>
<td class="flags">void</td>
<td class="spec">
<code>
<a href="#hideAll">hideAll</a>
()
</code>
<div class="description">
Hides all Overlays in the manager.&nbsp;
</div>
</td>
</tr>
<tr>
<td class="flags">void</td>
<td class="spec">
<code>
<a href="#init">init</a>
(&lt;object&gt; userConfig)
</code>
<div class="description">
Initializes the OverlayManager&nbsp;
</div>
</td>
</tr>
<tr>
<td class="flags">void</td>
<td class="spec">
<code>
<a href="#initDefaultConfig">initDefaultConfig</a>
()
</code>
<div class="description">
Initializes the default configuration of the OverlayManager&nbsp;
</div>
</td>
</tr>
<tr>
<td class="flags">boolean</td>
<td class="spec">
<code>
<a href="#register">register</a>
(&lt;Overlay&gt; overlay)
</code>
<div class="description">
Registers an Overlay or an array of Overlays with the manager.&nbsp;
</div>
</td>
</tr>
<tr>
<td class="flags">void</td>
<td class="spec">
<code>
<a href="#remove">remove</a>
(overlay)
</code>
<div class="description">
Removes the specified Overlay from the manager&nbsp;
</div>
</td>
</tr>
<tr>
<td class="flags">void</td>
<td class="spec">
<code>
<a href="#showAll">showAll</a>
()
</code>
<div class="description">
Shows all Overlays in the manager.&nbsp;
</div>
</td>
</tr>
<tr>
<td class="flags">string</td>
<td class="spec">
<code>
<a href="#toString">toString</a>
()
</code>
<div class="description">
Returns a string representation of the object.&nbsp;
</div>
</td>
</tr>
</table>
</div>
</div>
<!-- ========== END METHOD SUMMARY =========== -->
<!-- ============ FIELD DETAIL START =========== -->
<div class="section field details">
<h3><a name="field_detail">Field Detail</a> <span class="top">[<a href="#top">top</a>]</span></h3>
<div class="content">
<h4><a name="overlays">overlays</a></h4>
<div class="detail">
<code>
Array
&nbsp;
<strong>overlays</strong>
</code>
<div class="description">
The array of Overlays that are currently registered
</div>
</div>
<hr />
<h4><a name="CSS_FOCUSED">CSS_FOCUSED</a></h4>
<div class="detail">
<code>
string
&nbsp;
<strong>CSS_FOCUSED</strong>
</code>
<div class="description">
The CSS class representing a focused Overlay
</div>
</div>
<hr />
</div>
</div>
<!-- ============ FIELD DETAIL END =========== -->
<!-- ========= CONSTRUCTOR DETAIL START ======== -->
<div class="section constructor details">
<h3><a name="constructor_detail">Constructor Detail</a> <span class="top">[<a href="#top">top</a>]</span></h3>
<div class="content">
<h4><a name="YAHOO.widget.OverlayManager()">YAHOO.widget.OverlayManager</a></h4>
<div class="detail">
<code>
<strong>YAHOO.widget.OverlayManager</strong>
()
</code>
<div class="description">
OverlayManager is used for maintaining the focus status of multiple Overlays.
<dl>
<dt>Parameters:</dt>
<dd>
<code>overlays</code> -
Optional. A collection of Overlays to register with the manager.
</dd>
<dd>
<code>userConfig</code> -
The object literal representing the user configuration of the OverlayManager
</dd>
</dl>
HASH(0x1d77544)
</div>
</div>
</div>
</div>
<!-- ========= CONSTRUCTOR DETAIL END ======== -->
<!-- ============ METHOD DETAIL START ========== -->
<div class="section method details">
<h3><a name="methodDetails">Method Detail</a> <span class="top">[<a href="#top">top</a>]</span></h3>
<div class="content">
<h4><a name="blurAll">blurAll</a></h4>
<div class="detail">
<code>
void
<strong>blurAll</strong>
()
</code>
<div class="description">
Removes focus from all registered Overlays in the manager
HASH(0x1d6c440)
</div>
</div>
<hr />
<h4><a name="find">find</a></h4>
<div class="detail">
<code>
Overlay
<strong>find</strong>
(&lt;Overlay&gt; &lt;string&gt; overlay)
</code>
<div class="description">
Attempts to locate an Overlay by instance or ID.
<dl>
<dt>Parameters:</dt>
<dd>
<code>overlay</code> -
An Overlay to locate within the manager
</dd>
<dd>
<code>overlay</code> -
An Overlay id to locate within the manager
</dd>
</dl>
<dl>
<dt>Returns:</dt>
<dd> The requested Overlay, if found, or null if it cannot be located.</dd>
</dl>
HASH(0x1d6c5b4)
</div>
</div>
<hr />
<h4><a name="focus">focus</a></h4>
<div class="detail">
<code>
void
<strong>focus</strong>
(overlay)
</code>
<div class="description">
Focuses the specified Overlay
<dl>
<dt>Parameters:</dt>
<dd>
<code>The</code> -
Overlay to focus
</dd>
<dd>
<code>The</code> -
id of the Overlay to focus
</dd>
</dl>
HASH(0x1d3e248)
</div>
</div>
<hr />
<h4><a name="getActive">getActive</a></h4>
<div class="detail">
<code>
Overlay
<strong>getActive</strong>
()
</code>
<div class="description">
Returns the currently focused Overlay
<dl>
<dt>Returns:</dt>
<dd> The currently focused Overlay</dd>
</dl>
HASH(0x1d6c8fc)
</div>
</div>
<hr />
<h4><a name="hideAll">hideAll</a></h4>
<div class="detail">
<code>
void
<strong>hideAll</strong>
()
</code>
<div class="description">
Hides all Overlays in the manager.
HASH(0x1d6cadc)
</div>
</div>
<hr />
<h4><a name="init">init</a></h4>
<div class="detail">
<code>
void
<strong>init</strong>
(&lt;object&gt; userConfig)
</code>
<div class="description">
Initializes the OverlayManager
<dl>
<dt>Parameters:</dt>
<dd>
<code>userConfig</code> -
The object literal representing the user configuration of the OverlayManager
</dd>
<dd>
<code>overlays</code> -
Optional. A collection of Overlays to register with the manager.
</dd>
</dl>
HASH(0x1d6cbe4)
</div>
</div>
<hr />
<h4><a name="initDefaultConfig">initDefaultConfig</a></h4>
<div class="detail">
<code>
void
<strong>initDefaultConfig</strong>
()
</code>
<div class="description">
Initializes the default configuration of the OverlayManager
HASH(0x1d6cdf4)
</div>
</div>
<hr />
<h4><a name="register">register</a></h4>
<div class="detail">
<code>
boolean
<strong>register</strong>
(&lt;Overlay&gt; overlay)
</code>
<div class="description">
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.
<dl>
<dt>Parameters:</dt>
<dd>
<code>overlay</code> -
An Overlay to register with the manager.
</dd>
<dd>
<code>Overlay</code> -
[]} overlay An array of Overlays to register with the manager.
</dd>
</dl>
<dl>
<dt>Returns:</dt>
<dd> True if any Overlays are registered.</dd>
</dl>
HASH(0x1d6cf38)
</div>
</div>
<hr />
<h4><a name="remove">remove</a></h4>
<div class="detail">
<code>
void
<strong>remove</strong>
(overlay)
</code>
<div class="description">
Removes the specified Overlay from the manager
<dl>
<dt>Parameters:</dt>
<dd>
<code>The</code> -
Overlay to remove
</dd>
<dd>
<code>The</code> -
id of the Overlay to remove
</dd>
</dl>
HASH(0x1cc4dec)
</div>
</div>
<hr />
<h4><a name="showAll">showAll</a></h4>
<div class="detail">
<code>
void
<strong>showAll</strong>
()
</code>
<div class="description">
Shows all Overlays in the manager.
HASH(0x1d87204)
</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.
HASH(0x1d5b25c)
</div>
</div>
<hr />
</div>
</div>
<!-- ============ METHOD DETAIL END ========== -->
</div>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<div id="footer">
<hr />
Copyright &copy; 2006 Yahoo! Inc. All rights reserved.
<br /><br />
Documentation generated by <a href="http://jsdoc.sourceforge.net/">
JSDoc</a>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink