📄 biwindow.html

📁 ajax 框价．是个好工具．javascript 矿家．可以用在任何平台．
💻 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>BiWindow</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="BiWindow">BiWindow</h1><p>This class is used for internal windows inside the application window.</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>BiWindow</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>BiWindow</code><ul id="api-derived-classes"><li><code><a href="BiDialog.html">BiDialog</a></code></li></ul></li></ul></li></ul></li></ul></li></ul><h2>Constructor</h2><p><code>	new BiWindow([<span class="methodArgument">sCaption</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>sCaption</code></td><td><code class="type">String</code></td><td class="optional-column"><img src="check.png" alt="checked"></td><td><code>""</code></td><td>The title text of the window </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="acceptButton"></a><code>acceptButton</code></td><td><code class="type">				<code><a href="BiEventTarget.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="active"></a><code>active</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 teh window should be the active window</td></tr><tr><td><a name="cancelButton"></a><code>cancelButton</code></td><td><code class="type">				<code><a href="BiEventTarget.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="canMinimize"></a><code>canMinimize</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 can be minimized by the user. If the window cannot be minimized and the minimize button is shown the button is disabled.</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 of the window</td></tr><tr><td><a name="contentPane"></a><code>contentPane</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>This returns the component representing the client area of the window. All components should be added to this component.</td></tr><tr><td><a name="hideChrome"></a><code>hideChrome</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 hide the caption bar of the window</td></tr><tr><td><a name="icon"></a><code>icon</code></td><td><code class="type">				<code><a href="BiImage.html">BiImage</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 icon image to show on the window caption. Note that changing the image object does not update the window icon. You'll have to set the icon property to update the label icon. The size of the icon is ignored and will always be 16 x 16 pixels.</td></tr><tr><td><a name="movable"></a><code>movable</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 can be moved by the user.</td></tr><tr><td><a name="opaque"></a><code>opaque</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 make the window opaque. An opaque window will not let plugins and other windowed controls show through. However, there is a price to this. This is  achieved using an internal iframe and this makes the window heavier and slower.</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 can be resized by the user. If the window cannot be resized and the maximize button is shown the button is disabled.</td></tr><tr><td><a name="showClose"></a><code>showClose</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 show the close buttton on the caption</td></tr><tr><td><a name="showIcon"></a><code>showIcon</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 show the icon on the caption</td></tr><tr><td><a name="showMaximize"></a><code>showMaximize</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>Whether to show the maximize buttton on the caption</td></tr><tr><td><a name="showMinimize"></a><code>showMinimize</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 show the minimize buttton on the caption</td></tr><tr><td><a name="state"></a><code>state</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 state of the window. Valid values are:<br>								<br>								<code>normal</code>				<br>								<code>maximized</code>				<br>								<code>minimized</code>			</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.</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><p>None.</p><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>The command to add</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>The command to remove</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>
⌨️ 快捷键说明

复制代码 Ctrl + C
搜索代码 Ctrl + F
全屏模式 F11
切换主题 Ctrl + Shift + D
显示快捷键 ?
增大字号 Ctrl + =
减小字号 Ctrl + -