📄 biwizard.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>BiWizard</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="BiWizard">BiWizard</h1>
<p>
This component creates a dialog that contains a <code><a href="BiWizardPane.html">BiWizardPane</a></code>.
The wizard pane provides buttons for navigating back and forth and finishing
and canceling the wizard.<br>
<br>
Any <code><a href="BiComponent.html">BiComponent</a></code> may be used as a page.
Use <code><a href="#addPage">addPage</a></code> to add pages to the wizard. The pages dispatch
<code>activated</code> and <code>deactivated</code> when the active page
changes. You can also use the <code><a href="#change">change</a></code> event to get notifications
about when the user changes the active page.<br>
<br>
Most of the methods and properties provided by the <code><a href="BiWizardPane.html">BiWizardPane</a></code>
are also available on the wizad dialog.
</p>
<p>This class extends
<code><a href="BiDialog.html">BiDialog</a></code>
and therefore all methods and fields available for
<code><a href="BiDialog.html">BiDialog</a></code>
are also available for <code>BiWizard</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="BiWindow.html">BiWindow</a></code><ul><li><code><a href="BiDialog.html">BiDialog</a></code><ul><li><code>BiWizard</code><ul id="api-derived-classes"></ul></li></ul></li></ul></li></ul></li></ul></li></ul>
</li>
</ul>
<h2>Constructor</h2>
<p><code>
new BiWizard()</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="pages"></a><code>pages</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"></td>
<td>
Returns the added pages
</td>
</tr>
<tr>
<td><a name="selectedIndex"></a><code>selectedIndex</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 index of the selected page. If no page is selected this
returns <code>-1</code>.
</td>
</tr>
<tr>
<td><a name="selectedPage"></a><code>selectedPage</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 currently selected page.
</td>
</tr>
</tbody>
</table>
<h2>Methods</h2>
<table>
<thead>
<tr>
<td>Name</td>
<td>Description</td>
</tr>
</thead>
<tbody>
<tr>
<td><code><a href="#addPage">addPage</a></code></td>
<td>
This adds a page to the wizard
</td>
</tr>
<tr>
<td><code><a href="#back">back</a></code></td>
<td>
Goes to the previous page.
</td>
</tr>
<tr>
<td><code><a href="#cancel">cancel</a></code></td>
<td>
This is called when the user presses the cancel button
</td>
</tr>
<tr>
<td><code><a href="#finish">finish</a></code></td>
<td>
This is called when the user presses the finish button
</td>
</tr>
<tr>
<td><code><a href="#next">next</a></code></td>
<td>
Goes to the next page.
</td>
</tr>
<tr>
<td><code><a href="#removePage">removePage</a></code></td>
<td>
This removes a page from the wizard
</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="beforechange"></a><code>beforechange</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 <code><a href="#selectedPage">selectedPage</a></code> page changes. Call
<code><a href="BiEvent.html#preventDefault">preventDefault</a></code>
on the event object to prevent the wizard to change the page.
</td>
</tr>
<tr>
<td><a name="change"></a><code>change</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="#selectedPage">selectedPage</a></code> page changes.
</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="addPage"></a>addPage</h3>
<p>
This adds a page to the wizard
</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.addPage(<span class="methodArgument">oPage</span> [, <span class="methodArgument">oBefore</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>oPage</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 page to add
</td>
</tr>
<tr>
<td><code>oBefore</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>
If provided the new page will be added before this one.
</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="back"></a>back</h3>
<p>
Goes to the previous page.
</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.back()</pre>
<h4>Parameters</h4>
<p>No arguments.</p>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="cancel"></a>cancel</h3>
<p>
This is called when the user presses the cancel button
</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.cancel()</pre>
<h4>Parameters</h4>
<p>No arguments.</p>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="finish"></a>finish</h3>
<p>
This is called when the user presses the finish button
</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.finish()</pre>
<h4>Parameters</h4>
<p>No arguments.</p>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="next"></a>next</h3>
<p>
Goes to the next page.
</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.next()</pre>
<h4>Parameters</h4>
<p>No arguments.</p>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="removePage"></a>removePage</h3>
<p>
This removes a page from the wizard
</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.removePage(<span class="methodArgument">oPage</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>oPage</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 page to remove
</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type"><code><a href="BiComponent.html">BiComponent</a></code></code></p>
</body>
</html>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -