📄 biapplicationwindow.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>BiApplicationWindow</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="BiApplicationWindow">BiApplicationWindow</h1>
<p>
This class represent the actual browser window hosting the application
</p>
<p>This class extends
<code><a href="BiComponent.html">BiComponent</a></code>
and therefore all methods and fields available for
<code><a href="BiComponent.html">BiComponent</a></code>
are also available for <code>BiApplicationWindow</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>BiApplicationWindow</code><ul id="api-derived-classes"></ul></li></ul></li></ul></li></ul>
</li>
</ul>
<h2>Constructor</h2>
<p><code>
new BiApplicationWindow()</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="acceptButton"></a><code>acceptButton</code></td>
<td><code class="type"><code><a href="BiEvenTarget.html">BiEventTarget</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 button that acts as the default accept button. If this is set
then the <code><a href="BiButton.html#action">action</a></code>
event is dispatched from the accept button when the enter key
is pressed. This does not have to
be a <code><a href="BiButton.html">BiButton</a></code>, any
<code><a href="BiEventTarget.html">BiEventTarget</a></code> will work.
</td>
</tr>
<tr>
<td><a name="allowBrowserContextMenu"></a><code>allowBrowserContextMenu</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>
Decides whether the browser context menu should be shown by default.
If this is set to <code>true</code> you can still prevent the
browser context menu from being shown by calling <code><a href="BiEvent.html#preventDefault">preventDefault</a></code> on the event object
used in the <code><a href="BiComponent.html#contextmenu">contextmenu</a></code>
event.
</td>
</tr>
<tr>
<td><a name="cancelButton"></a><code>cancelButton</code></td>
<td><code class="type"><code><a href="BiEvenTarget.html">BiEventTarget</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 button that acts as the default cancel button. If this is set
then the <code><a href="BiButton.html#action">action</a></code>
event is dispatched from the cancel button. This does not have to
be a <code><a href="BiButton.html">BiButton</a></code>, any
<code><a href="BiEventTarget.html">BiEventTarget</a></code> will work.
</td>
</tr>
<tr>
<td><a name="caption"></a><code>caption</code></td>
<td><code class="type">String</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 title text on the application window</td>
</tr>
<tr>
<td><a name="fullScreen"></a><code>fullScreen</code></td>
<td><code class="type">Boolean</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"></td>
<td>Whether the window was opened in full screen mode</td>
</tr>
<tr>
<td><a name="globalCursor"></a><code>globalCursor</code></td>
<td><code class="type">String</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>
Setting the global cursor will make the mouse pointer use the
given cursor for all the components and thus overriding the
cursor property of the component.
</td>
</tr>
<tr>
<td><a name="resizable"></a><code>resizable</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 the window is resizable</td>
</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. Commands are added
to the application window by default so this is only needed to be called
if the command previously was added to an internal <code><a href="BiWindow.html">window</a></code>.
</td>
</tr>
<tr>
<td><code><a href="#close">close</a></code></td>
<td>Closes the window</td>
</tr>
<tr>
<td><code><a href="#print">print</a></code></td>
<td>Sends the content of the window to the printer</td>
</tr>
<tr>
<td><code><a href="#removeCommand">removeCommand</a></code></td>
<td>
Removes a command from the window.
</td>
</tr>
</tbody>
</table>
<h2>Events</h2>
<p>None.</p>
<h2>Static Methods</h2>
<p>None.</p>
<h2>Static Fields</h2>
<p>None.</p>
<h2>Remarks</h2>
<p>
Although, <code><a href="BiApplicationWindow.html">BiApplicationWindow</a></code>
extends <code><a href="BiComponent.html">BiComponent</a></code> it cannot be added
to another component as a child. Also, some methods from
<code><a href="BiComponent.html">BiComponent</a></code> do not apply. Currently
known properties and methods that do not apply.<br>
<br>
<code><a href="BiComponent.html#visible">visible</a></code><br>
<code><a href="BiComponent.html#zIndex">zIndex</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. Commands are added
to the application window by default so this is only needed to be called
if the command previously was added to an internal <code><a href="BiWindow.html">window</a></code>.
</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="close"></a>close</h3>
<p>Closes the window</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="print"></a>print</h3>
<p>Sends the content of the window to the printer</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.print()</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>
</body>
</html>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -