📄 biwindowmanager.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>BiWindowManager</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="BiWindowManager">BiWindowManager</h1>
<p>
This class can be used with internal <code><a href="BiWindow.html">windows</a></code>
to provide more features.
</p>
<p>This class extends
<code><a href="BiObject.html">BiObject</a></code>
and therefore all methods and fields available for
<code><a href="BiObject.html">BiObject</a></code>
are also available for <code>BiWindowManager</code>.</p>
<ul class="partial-class-tree">
<li><code><a href="BiObject.html">BiObject</a></code><ul>
<li><code>BiWindowManager</code><ul id="api-derived-classes"></ul></li></ul>
</li>
</ul>
<h2>Constructor</h2>
<p><code>
new BiWindowManager([<span class="methodArgument">oComponent</span>])</code></p>
<h3>Parameters</h3>
<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"><img src="check.png" alt="checked"></td>
<td></td>
<td>
This is the component that is the container for the windows.
Do not use the window manager before a valid <code><a href="#component">component</a></code>
is set.
</td>
</tr>
</tbody>
</table>
<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="activeWindow"></a><code>activeWindow</code></td>
<td><code class="type"><code><a href="BiWindow.html">BiWindow</a></code></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 window that is currently active. This might be <code>null</code>
if no window is active.
</td>
</tr>
<tr>
<td><a name="component"></a><code>component</code></td>
<td><code class="type"><code><a href="BiComponent.html">BiComponent</a></code></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 component that the windows are added to</td>
</tr>
<tr>
<td><a name="windows"></a><code>windows</code></td>
<td><code class="type"><code><a href="BiWindow.html">BiWindow[]</a></code></code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"></td>
<td>
Returns an array with the windows managed by the window manager.
</td>
</tr>
<tr>
<td><a name="windowsMenu"></a><code>windowsMenu</code></td>
<td><code class="type"><code><a href="BiMenu.html">BiMenu</a></code></code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"></td>
<td>
This returns a menu that contains items for commands as well as
menu items for all the windows. This can be used to switch between
the windows and organize the windows.<br>
<br>
This menu can be added to a menu bar, as a sub menu or used as
a context menu.
</td>
</tr>
</tbody>
</table>
<h2>Methods</h2>
<table>
<thead>
<tr>
<td>Name</td>
<td>Description</td>
</tr>
</thead>
<tbody>
<tr>
<td><code><a href="#add">add</a></code></td>
<td>Adds a window to the window manager. Added windows are then
managed by the window manager.</td>
</tr>
<tr>
<td><code><a href="#cascade">cascade</a></code></td>
<td>Cascades the visible windows.</td>
</tr>
<tr>
<td><code><a href="#closeAll">closeAll</a></code></td>
<td>Closes all the windows.</td>
</tr>
<tr>
<td><code><a href="#getLastState">getLastState</a></code></td>
<td>
Returns the last state (non minimized state) for the window. This
is used to know to what state the window should return to once it
is restored from minimized.
</td>
</tr>
<tr>
<td><code><a href="#minimizeAll">minimizeAll</a></code></td>
<td>Minimizes all the windows.</td>
</tr>
<tr>
<td><code><a href="#remove">remove</a></code></td>
<td>
Removes a window from the window manager. The window
is no longer managed by the window manager. Closing a window automatically
removes it from the window manager. The method returns the removed
window.
</td>
</tr>
<tr>
<td><code><a href="#tileHorizontally">tileHorizontally</a></code></td>
<td>Tiles the visible windows horizontally.</td>
</tr>
<tr>
<td><code><a href="#tileVertically">tileVertically</a></code></td>
<td>Tiles the visible windows vertically.</td>
</tr>
</tbody>
</table>
<h2>Events</h2>
<p>None.</p>
<h2>Static Methods</h2>
<p>None.</p>
<h2>Static Fields</h2>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>CASCADE_ICON</code></td>
<td><code class="type">String</code></td>
<td>The URI of the image to use for the cascade menu item</td>
</tr>
<tr>
<td><code>CLOSE_ALL_ICON</code></td>
<td><code class="type">String</code></td>
<td>The URI of the image to use for the close all menu item</td>
</tr>
<tr>
<td><code>TILE_HORIZONTALLY_ICON</code></td>
<td><code class="type">String</code></td>
<td>The URI of the image to use for the tile horizontally menu item</td>
</tr>
<tr>
<td><code>TILE_VERTICALLY_ICON</code></td>
<td><code class="type">String</code></td>
<td>The URI of the image to use for the tile vertically menu item</td>
</tr>
</tbody>
</table>
<h2>Remarks</h2>
<p>
Adding a window to a component that has a window manager does not
automatically add the window to the window manager. The window needs to be
added to the parent component as well as to the window manager.<br>
<br>
You might wan to use the <code><a href="BiDesktopPane.html">BiDesktopPane</a></code>
which is a component that handles the adding and removing of the windows
for you.
</p>
<h2>Method Details</h2>
<h3><a name="add"></a>add</h3>
<p>Adds a window to the window manager. Added windows are then
managed by the window manager.</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.add(<span class="methodArgument">oWindow</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>oWindow</code></td>
<td><code class="type"><code><a href="BiWindow.html">BiWindow</a></code></code></td>
<td class="optional-column"></td>
<td></td>
<td>The window to add to the window manager</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="cascade"></a>cascade</h3>
<p>Cascades the visible windows.</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.cascade()</pre>
<h4>Parameters</h4>
<p>No arguments.</p>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="closeAll"></a>closeAll</h3>
<p>Closes all the windows.</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.closeAll()</pre>
<h4>Parameters</h4>
<p>No arguments.</p>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="getLastState"></a>getLastState</h3>
<p>
Returns the last state (non minimized state) for the window. This
is used to know to what state the window should return to once it
is restored from minimized.
</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getLastState(<span class="methodArgument">oWindow</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>oWindow</code></td>
<td><code class="type"><code><a href="BiWindow.html">BiWindow</a></code></code></td>
<td class="optional-column"></td>
<td></td>
<td>The window to get the state for</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">String</code></p>
<h3><a name="minimizeAll"></a>minimizeAll</h3>
<p>Minimizes all the windows.</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.minimizeAll()</pre>
<h4>Parameters</h4>
<p>No arguments.</p>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="remove"></a>remove</h3>
<p>
Removes a window from the window manager. The window
is no longer managed by the window manager. Closing a window automatically
removes it from the window manager. The method returns the removed
window.
</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.remove(<span class="methodArgument">oWindow</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>oWindow</code></td>
<td><code class="type"><code><a href="BiWindow.html">BiWindow</a></code></code></td>
<td class="optional-column"></td>
<td></td>
<td>The window to remove to the window manager</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type"><code><a href="BiWindow.html">BiWindow</a></code></code></p>
<h3><a name="tileHorizontally"></a>tileHorizontally</h3>
<p>Tiles the visible windows horizontally.</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.tileHorizontally()</pre>
<h4>Parameters</h4>
<p>No arguments.</p>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="tileVertically"></a>tileVertically</h3>
<p>Tiles the visible windows vertically.</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.tileVertically()</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 + -