biwindow.html

在流览器上仿CS界面的JAVASCRIPT脚本

</tr>
</tbody>
</table>
<h2>Methods</h2>
<table>
<thead>
<tr>
<td>Name</td>
<td>Description</td>
</tr>
</thead>
<tbody>
<tr>
<td><code><a href="#addCommand">addCommand</a></code></td>
<td>
				Adding a command to the window allows the window to execute the
				command when the user presses the needed keys.
			</td>
</tr>
<tr>
<td><code><a href="#bringToFront">bringToFront</a></code></td>
<td>Makes so that the window is displayed on top of all other shown windows.</td>
</tr>
<tr>
<td><code><a href="#close">close</a></code></td>
<td>
				Closes the window. Once closed the object cannot be used any more.
				To hide the window so that it can be used later set the
				<code><a href="BiComponent.html#visible">visible</a></code> property
				to <code>false</code>.<br>
				<br>
				Before the window is closed the <code><a href="#beforeclose">beforeclose</a></code> event is
				fired. If the default action is prevented using
				<code><a href="BiEvent.html#preventDefault">preventDefault</a></code>
				the window will not be closed. If the default action is not prevented
				then the <code><a href="#close">close</a></code> event is fired and the window is closed.
			</td>
</tr>
<tr>
<td><code><a href="#removeCommand">removeCommand</a></code></td>
<td>
				Removes a command from the window.
			</td>
</tr>
<tr>
<td><code><a href="#sendToBack">sendToBack</a></code></td>
<td>Makes so that the current window is displayed behind all other windows</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="activated"></a><code>activated</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 window becomes <code><a href="#active">active</a></code>
			</td>
</tr>
<tr>
<td><a name="beforeclose"></a><code>beforeclose</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 window is closed.
			If the default action is prevented the window is not closed</td>
</tr>
<tr>
<td><a name="captionchanged"></a><code>captionchanged</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 <code><a href="#caption">caption</a></code> changes
			</td>
</tr>
<tr>
<td><a name="close"></a><code>close</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 window is closed</td>
</tr>
<tr>
<td><a name="deactivated"></a><code>deactivated</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 window becomes <code><a href="#active">active</a></code>
			</td>
</tr>
<tr>
<td><a name="iconchanged"></a><code>iconchanged</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 <code><a href="#icon">icon</a></code> changes
			</td>
</tr>
<tr>
<td><a name="statechanged"></a><code>statechanged</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 window <code><a href="#state">state</a></code> changes.
			</td>
</tr>
</tbody>
</table>
<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>DEFAULT_ICON</code></td>
<td><code class="type">String</code></td>
<td>The uri of the default icon image</td>
</tr>
</tbody>
</table>
<h2>Remarks</h2>
<p>
		Content should not be added directly to the window but should be added
		to the <code><a href="#contentPane">contentPane</a></code>.
	</p>
<h2>Method Details</h2>
<h3><a name="addCommand"></a>addCommand</h3>
<p>
				Adding a command to the window allows the window to execute the
				command when the user presses the needed keys.
			</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.addCommand(<span class="methodArgument">c</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>c</code></td>
<td><code class="type"><code><a href="BiCommand.html">BiCommand</a></code></code></td>
<td class="optional-column"></td>
<td></td>
<td></td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="bringToFront"></a>bringToFront</h3>
<p>Makes so that the window is displayed on top of all other shown windows.</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="close"></a>close</h3>
<p>
				Closes the window. Once closed the object cannot be used any more.
				To hide the window so that it can be used later set the
				<code><a href="BiComponent.html#visible">visible</a></code> property
				to <code>false</code>.<br>
				<br>
				Before the window is closed the <code><a href="#beforeclose">beforeclose</a></code> event is
				fired. If the default action is prevented using
				<code><a href="BiEvent.html#preventDefault">preventDefault</a></code>
				the window will not be closed. If the default action is not prevented
				then the <code><a href="#close">close</a></code> event is fired and the window is closed.
			</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.close()</pre>
<h4>Parameters</h4>
<p>No arguments.</p>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="removeCommand"></a>removeCommand</h3>
<p>
				Removes a command from the window.
			</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.removeCommand(<span class="methodArgument">c</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>c</code></td>
<td><code class="type"><code><a href="BiCommand.html">BiCommand</a></code></code></td>
<td class="optional-column"></td>
<td></td>
<td></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 window is displayed behind all other windows</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>