📄 biwizardpane.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>BiWizardPane</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="BiWizardPane">BiWizardPane</h1><p>This component creates a wizard that can contain 1 or more pages. 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.</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>BiWizardPane</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>BiWizardPane</code><ul id="api-derived-classes"></ul></li></ul></li></ul></li></ul></li></ul><h2>Constructor</h2><p><code> new BiWizardPane()</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="backButton"></a><code>backButton</code></td><td><code class="type"> <code><a href="BiButton.html">BiButton</a></code> </code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"></td><td>Returns the back button of the wizard.</td></tr><tr><td><a name="backdropImage"></a><code>backdropImage</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 image used as the backdrop on the left side of the wizard pane</td></tr><tr><td><a name="cancelButton"></a><code>cancelButton</code></td><td><code class="type"> <code><a href="BiButton.html">BiButton</a></code> </code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"></td><td>Returns the cancel button of the wizard.</td></tr><tr><td><a name="finishButton"></a><code>finishButton</code></td><td><code class="type"> <code><a href="BiButton.html">BiButton</a></code> </code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"></td><td>Returns the finish button of the wizard.</td></tr><tr><td><a name="nextButton"></a><code>nextButton</code></td><td><code class="type"> <code><a href="BiButton.html">BiButton</a></code> </code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"></td><td>Returns the next button of the wizard.</td></tr><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><tr><td><a name="stringBundle"></a><code>stringBundle</code></td><td><code class="type"> <code><a href="BiStringBundle.html">BiStringBundle</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 string bundle to use for this wizard pane. If this is set to <code>null</code> then the string bundle for <code><a href="BiApplication.html">application</a></code> is used.</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 pane.</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 pane.</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 pane to change the page.</td></tr><tr><td><a name="cancel"></a><code>cancel</code></td><td><code class="type"> <code><a href="BiEvent.html">BiEvent</a></code> </code></td><td class="bubbles-column"></td><td>This event is dispatched when the user clicks the cancel button.</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><tr><td><a name="finish"></a><code>finish</code></td><td><code class="type"> <code><a href="BiEvent.html">BiEvent</a></code> </code></td><td class="bubbles-column"></td><td>This event is dispatched when the user clicks the finish button.</td></tr></tbody></table><h2>Static Methods</h2><p>None.</p><h2>Static Fields</h2><p>None.</p><h2>Remarks</h2><p>The wizard pane fires an event called <code>deactivate</code> on the page before moving away from that page. If the default action for this event is prevented the wizard stays at the current page. This is similar to the <code><a href="#beforechange">beforechange</a></code> except that this is fired on the page instead of on the wizard pane<br> <br> The wizard pane also fires an event called <code>activate</code> on the page after the wizard pane has navigated to the page.<br> <br> The labels for the buttons are provided by a<code><a href="BiStringBundle.html">BiStringBundle</a></code> and the following keys are used:<br> <br> WizardPaneBack - Text for back button<br> WizardPaneNext - Text for next button<br> WizardPaneFinish - Text for finish button<br> WizardPaneCancel - Text for cancel button<br> WizardPaneBackMnemonic - Mnemonic for back button<br> WizardPaneNextMnemonic - Mnemonic for next button<br> WizardPaneBackAccessKey - Access key for back button<br> WizardPaneNextAccessKey - Access key for next button</p><h2>Method Details</h2><h3><a name="addPage"></a>addPage</h3><p>This adds a page to the wizard pane.</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>Optional and 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 pane.</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 + -