📄 bipopup.html
字号:
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"><html><!--
Generated using api.website.xsl version 2003-07-17
-->
<head>
<META http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>BiPopup</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link type="text/css" rel="stylesheet" href="api.css"><script type="text/javascript">
function showDerivedClasses() {
var ul = document.getElementById("api-derived-classes");
var lis = ul.childNodes;
var l = lis.length;
for (var i = 1; i < l; i++)
lis[i].style.display = "";
lis[0].style.display = "none";
}
</script></head>
<body>
<h1 id="BiPopup">BiPopup</h1>
<p>
A popup is a component that is displayed on top of all other components
and is not limited by the parent components view port.
</p>
<p>This class extends
<code><a href="BiLabel.html">BiLabel</a></code>
and therefore all methods and fields available for
<code><a href="BiLabel.html">BiLabel</a></code>
are also available for <code>BiPopup</code>.</p>
<ul class="partial-class-tree">
<li><code><a href="BiObject.html">BiObject</a></code><ul>
<li><code><a href="BiEventTarget.html">BiEventTarget</a></code><ul><li><code><a href="BiComponent.html">BiComponent</a></code><ul><li><code><a href="BiLabel.html">BiLabel</a></code><ul><li><code>BiPopup</code><ul id="api-derived-classes"><li><code><a href="BiToolTip.html">BiToolTip</a></code></li></ul></li></ul></li></ul></li></ul></li></ul>
</li>
</ul>
<h2>Constructor</h2>
<p><code>
new BiPopup()</code></p>
<h3>Parameters</h3>
<p>No parameters.</p>
<h2>Properties</h2>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="get-header">get</td>
<td class="set-header">set</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><a name="allowOffScreen"></a><code>allowOffScreen</code></td>
<td><code class="type">Boolean</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"><img src="check.png" alt="checked"></td>
<td>Whether to allow the popup to be positioned off screen</td>
</tr>
<tr>
<td><a name="autoHide"></a><code>autoHide</code></td>
<td><code class="type">Boolean</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"><img src="check.png" alt="checked"></td>
<td>
Whether to let the system decide when to hide the popup. Setting
this to <code>false</code> gives you better control but it also
requires you to handle the closing of the popup.
</td>
</tr>
<tr>
<td><a name="clientLeft"></a><code>clientLeft</code></td>
<td><code class="type">Number</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"><img src="check.png" alt="checked"></td>
<td>The position relative to the browser client area.
Note that this can be both set and get for popups.</td>
</tr>
<tr>
<td><a name="clientTop"></a><code>clientTop</code></td>
<td><code class="type">Number</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"><img src="check.png" alt="checked"></td>
<td>The position relative to the browser client area.
Note that this can be both set and get for popups.</td>
</tr>
<tr>
<td><a name="hideTimeStamp"></a><code>hideTimeStamp</code></td>
<td><code class="type">Date</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"></td>
<td>The time when the popup was hidden.
This can be useful to find out whether the popup was just hidden.</td>
</tr>
<tr>
<td><a name="screenLeft"></a><code>screenLeft</code></td>
<td><code class="type">Number</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"><img src="check.png" alt="checked"></td>
<td>The position relative to the screen.
Note that this can be both set and get for popups.</td>
</tr>
<tr>
<td><a name="screenTop"></a><code>screenTop</code></td>
<td><code class="type">Number</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"><img src="check.png" alt="checked"></td>
<td>The position relative to the screen.
Note that this can be both set and get for popups.</td>
</tr>
<tr>
<td><a name="showTimeStamp"></a><code>showTimeStamp</code></td>
<td><code class="type">Date</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"></td>
<td>The time when the popup was shown.</td>
</tr>
</tbody>
</table>
<h2>Methods</h2>
<table>
<thead>
<tr>
<td>Name</td>
<td>Description</td>
</tr>
</thead>
<tbody>
<tr>
<td><code><a href="#bringToFront">bringToFront</a></code></td>
<td>Makes so that the popup is displayed on top of all other shown popups.</td>
</tr>
<tr>
<td><code><a href="#positionRelativeToComponent">positionRelativeToComponent</a></code></td>
<td>
Sets the popup to be positioned relative to another component.
Valid values for the direction are <code>vertical</code>
and <code>horizontal</code>.
</td>
</tr>
<tr>
<td><code><a href="#sendToBack">sendToBack</a></code></td>
<td>Makes so that the current popup is displayed behind all other shown popups</td>
</tr>
</tbody>
</table>
<h2>Events</h2>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="bubbles-header">Bubbles</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><a name="beforeshow"></a><code>beforeshow</code></td>
<td><code class="type"><code><a href="BiEvent.html">BiEvent</a></code></code></td>
<td class="bubbles-column"></td>
<td>Fires before the popup is shown.
This is a good place to change the content of the tool tip and set the
preferred size if the default preferred size is not wanted</td>
</tr>
<tr>
<td><a name="hide"></a><code>hide</code></td>
<td><code class="type"><code><a href="BiEvent.html">BiEvent</a></code></code></td>
<td class="bubbles-column"></td>
<td>Fires when the popup is hidden</td>
</tr>
<tr>
<td><a name="show"></a><code>show</code></td>
<td><code class="type"><code><a href="BiEvent.html">BiEvent</a></code></code></td>
<td class="bubbles-column"></td>
<td>Fires when the popup is shown</td>
</tr>
</tbody>
</table>
<h2>Static Methods</h2>
<p>None.</p>
<h2>Static Fields</h2>
<p>None.</p>
<h2>Remarks</h2>
<p>None.</p>
<h2>Method Details</h2>
<h3><a name="bringToFront"></a>bringToFront</h3>
<p>Makes so that the popup is displayed on top of all other shown popups.</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.bringToFront()</pre>
<h4>Parameters</h4>
<p>No arguments.</p>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="positionRelativeToComponent"></a>positionRelativeToComponent</h3>
<p>
Sets the popup to be positioned relative to another component.
Valid values for the direction are <code>vertical</code>
and <code>horizontal</code>.
</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.positionRelativeToComponent(<span class="methodArgument">oComponent</span> [, <span class="methodArgument">sDir</span>])</pre>
<h4>Parameters</h4>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>oComponent</code></td>
<td><code class="type"><code><a href="BiComponent.html">BiComponent</a></code></code></td>
<td class="optional-column"></td>
<td></td>
<td>
The component to position the popup relative to
</td>
</tr>
<tr>
<td><code>sDir</code></td>
<td><code class="type">String</code></td>
<td class="optional-column"><img src="check.png" alt="checked"></td>
<td><code>vertical</code></td>
<td>
The direction relative to the component
</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="sendToBack"></a>sendToBack</h3>
<p>Makes so that the current popup is displayed behind all other shown popups</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.sendToBack()</pre>
<h4>Parameters</h4>
<p>No arguments.</p>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
</body>
</html>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -