biwizardpane.xml

来自「ajax 框价．是个好工具．javascript 矿家．可以用在任何平台．」· XML 代码 · 共 212 行

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiWizardPane" extends="BiComponent">
	<description>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>
		<br>
		</br>
 Any <link class="BiComponent">BiComponent</link> may be used as a page.
 Use <link>addPage</link> 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 <link>change</link> event to get notifications
 about when the user changes the active page.</description>
	<arguments>
	</arguments>
	<staticMethods>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
		<method name="next">
			<description>Goes to the next page.</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="back">
			<description>Goes to the previous page.</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="finish">
			<description>This is called when the user presses the finish button.</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="cancel">
			<description>This is called when the user presses the cancel button.</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="addPage">
			<description>This adds a page to the wizard pane.</description>
			<arguments>
				<argument name="oPage">
					<description>The page to add</description>
					<type>
						<link class="BiComponent">BiComponent</link>
					</type>
				</argument>
				<argument name="oBefore" optional="true">
					<description>Optional and if provided the new page will be added before this one.</description>
					<type>
						<link class="BiComponent">BiComponent</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="removePage">
			<description>This removes a page from the wizard pane.</description>
			<arguments>
				<argument name="oPage">
					<description>The page to remove.</description>
					<type>
						<link class="BiComponent">BiComponent</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>
					<link class="BiComponent">BiComponent</link>
				</type>
			</returns>
		</method>
	</methods>
	<properties>
		<property name="selectedIndex" get="true" set="true">
			<description>The index of the selected page. If no page is selected this
 returns <code>-1</code>.</description>
			<type>Number</type>
		</property>
		<property name="selectedPage" get="true" set="true">
			<description>The currently selected page.</description>
			<type>
				<link class="BiComponent">BiComponent</link>
			</type>
		</property>
		<property name="pages" get="true">
			<description>Returns the added pages</description>
			<type>
				<link class="BiComponent">BiComponent[]</link>
			</type>
		</property>
		<property name="nextButton" get="true">
			<description>Returns the next button of the wizard.</description>
			<type>
				<link class="BiButton">BiButton</link>
			</type>
		</property>
		<property name="backButton" get="true">
			<description>Returns the back button of the wizard.</description>
			<type>
				<link class="BiButton">BiButton</link>
			</type>
		</property>
		<property name="finishButton" get="true">
			<description>Returns the finish button of the wizard.</description>
			<type>
				<link class="BiButton">BiButton</link>
			</type>
		</property>
		<property name="cancelButton" get="true">
			<description>Returns the cancel button of the wizard.</description>
			<type>
				<link class="BiButton">BiButton</link>
			</type>
		</property>
		<property name="backdropImage" get="true" set="true">
			<description>The image used as the backdrop on the left side of the wizard pane</description>
			<type>
				<link class="BiImage">BiImage</link>
			</type>
		</property>
		<property name="stringBundle" get="true" set="true">
			<description>The string bundle to use for this wizard pane. If this is set to
 <code>null</code> then the string bundle for
 <link class="BiApplication">application</link> is used.</description>
			<type>
				<link class="BiStringBundle">BiStringBundle</link>
			</type>
		</property>
	</properties>
	<events>
		<event name="change">
			<description>Fires when the <link>selectedPage</link> page changes.</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
		<event name="beforechange">
			<description>Fires before the <link>selectedPage</link> page changes. Call
									<link field="preventDefault" class="BiEvent">preventDefault</link>
                                 on the event object to prevent the wizard pane to change the page.</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
		<event name="finish">
			<description>This event is dispatched when the user clicks
 								the finish button.</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
		<event name="cancel">
			<description>This event is dispatched when the user clicks
 								the cancel button.</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
	</events>
	<remarks>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 <link>beforechange</link> except that this is
             fired on the page instead of on the wizard pane<br>
		</br>
		<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>
		<br>
		</br>
             The labels for the buttons are provided by a<link class="BiStringBundle">BiStringBundle</link> and
             the following keys are used:<br>
		</br>
		<br>
		</br>
             WizardPaneBack - Text for back button<br>
		</br>
             WizardPaneNext - Text for next button<br>
		</br>
             WizardPaneFinish - Text for finish button<br>
		</br>
             WizardPaneCancel - Text for cancel button<br>
		</br>
             WizardPaneBackMnemonic - Mnemonic for back button<br>
		</br>
             WizardPaneNextMnemonic - Mnemonic for next button<br>
		</br>
             WizardPaneBackAccessKey - Access key for back button<br>
		</br>
             WizardPaneNextAccessKey - Access key for next button</remarks>
</class>