bidialog.xml

ajax 框价．是个好工具．javascript 矿家．可以用在任何平台．

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiDialog" extends="BiWindow">
	<description>This class is used for dialog windows. Dialog windows are internal windows
 that require immediate attention. Dialog windows are modal to the application.<br>
		</br>
		<br>
		</br>
 Example usage:<br>
		</br>
		<br>
		</br>
		<code>var confirm = new<link class="BiDialog">BiDialog</link>("Are you sure");<br>
			</br>
 // add components to the dialog<br>
			</br>
 confirm.addEventListener("dialogresult", this.doSomething, this);<br>
			</br>
 confirm.setVisible(true);</code>
	</description>
	<arguments>
		<argument name="sCaption" optional="true">
			<description>Optional caption text</description>
			<type>String</type>
		</argument>
	</arguments>
	<staticMethods>
		<method name="createMessageDialog">
			<description>Creates a new <link class="BiDialog">BiDialog</link> with a
 <link class="BiOptionPane">option pane</link> as the
 <link class="BiWindow" field="contentPane">contentPane</link> of the dialog
 window.<br>
				</br>
				<br>
				</br>
 This dialog is used to show a simple message. The iamge can either
 be set using the option type or by setting using the image argument.<br>
				</br>
				<br>
				</br>
 The <link field="dialogResult" class="BiDialog">dialogResult</link>
 for the dialog reflects the button clicked. The values are:<br>
				</br>
				<br>
				</br>
 ok - The "OK" button was clicked<br>
				</br>
 cancel - The "Cancel" button was clicked<br>
				</br>
 yes - The "Yes" button was clicked<br>
				</br>
 no  - The "No" button was clicked<br>
				</br>
				<br>
				</br>
 This method uses the static method provided by the
 <link class="BiOptionPane">BiOptionPane</link> class.</description>
			<arguments>
				<argument name="oMessage">
					<description>The text or
 							<link class="BiComponent">BiComponent</link> to
                             show as a message inside the dialog</description>
					<type>Object</type>
				</argument>
				<argument name="sCaption" optional="true" default="Message">
					<description>Optional caption text to show on the dialog window </description>
					<type>String</type>
				</argument>
				<argument name="sMessageType" optional="true" default="information">
					<description>The type of the message that is shown. This sets the image on the option pane if no
                                 other image is provided. Valid values are:<br>
						</br>
						<br>
						</br>
                                 plain - No image<br>
						</br>
                                 error - Shows a stop (x) image<br>
						</br>
                                 information - Shows an image with an 'i' on<br>
						</br>
                                 warning - Shows an image with an exclamation mark on<br>
						</br>
                                 question - Show a question mark image</description>
					<type>String</type>
				</argument>
				<argument name="oImage" optional="true">
					<description>Optional image to show on the option pane. If
 							left out then the image defined by the
                             <link class="BiOptionPane" field="messageType">messageType</link> is used.</description>
					<type>
						<link class="BiImage">BiImage</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>
					<link class="BiDialog">BiDialog</link>
				</type>
			</returns>
		</method>
		<method name="createOptionDialog">
			<description>Creates a new<link class="BiDialog">BiDialog</link> with a
 <link class="BiOptionPane">option pane</link> as the
 <link class="BiWindow" field="contentPane">contentPane</link>
 of the dialog window.<br>
				</br>
				<br>
				</br>
 This dialog is used to show custom option buttons that the user
 can select between. The options argument should be used to define
 the buttons to use.<br>
				</br>
				<br>
				</br>
 The <link field="dialogResult" class="BiDialog">dialogResult</link>
 for the dialog reflects the button clicked. The value will be the
 object that the clicked button was created from.<br>
				</br>
				<br>
				</br>
 This method uses the static method provided by the
 <link class="BiOptionPane">BiOptionPane</link> class.</description>
			<arguments>
				<argument name="oMessage">
					<description>The text or<link class="BiComponent">BiComponent</link> to show
 							as a message inside the dialog</description>
					<type>Object</type>
				</argument>
				<argument name="sCaption">
					<description>The caption text to show on the dialog window</description>
					<type>String</type>
				</argument>
				<argument name="sMessageType">
					<description>The type of the message that is shown. This sets the image on
								the option pane if no other image is provided. Valid values are:<br>
						</br>
						<br>
						</br>
                                 plain - No image<br>
						</br>
                                 error - Shows a stop (x) image<br>
						</br>
                                 information - Shows an image with an 'i' on<br>
						</br>
                                 warning - Shows an image with an exclamation mark on<br>
						</br>
                                 question - Show a question mark image</description>
					<type>String</type>
				</argument>
				<argument name="sOptionType" optional="true">
					<description>Optional option type describes what buttons to show on the option pane.
 								This is ignored if the <link class="BiDialog" field="options">options</link>
                                 are set. Valid values are:<br>
						</br>
						<br>
						</br>
                                 default - Usually shows an "OK" button<br>
						</br>
                                 yesno - Shows a "Yes" and a "No" button<br>
						</br>
                                 yesnocancel - Shows three buttons with the text "Yes", "No" and "Cancel"<br>
						</br>
                                 okcancel - Shows a "OK" and a "Cancel" button</description>
					<type>String</type>
				</argument>
				<argument name="oImage" optional="true">
					<description>Optional image to show on the option pane. If left out then the image
 							defined by the <link>messageType</link> is used.</description>
					<type>
						<link class="BiImage">BiImage</link>
					</type>
				</argument>
				<argument name="oOptions" optional="true">
					<description>Optional array describing what options/buttons to
 							show on the option pane. This is an array of
                             objects and if the object is a<link class="BiComponent">BiComponent</link> then
                             it is added as it is. If not, a new button is
                             created where the text is taken by using the
                             <code>toString</code> method on the object.</description>
					<type>Object[]</type>
				</argument>
				<argument name="oInitialValue" optional="true">
					<description>Optional argument and can be used when
 								oOptions is provided. This is used to define
                                 which of the options that should be treated
                                 as the default <link class="BiOptionPane" field="acceptButton">acceptButton</link>
					</description>
					<type>Object</type>
				</argument>
			</arguments>
			<returns>
				<type>
					<link class="BiDialog">BiDialog</link>
				</type>
			</returns>
		</method>
		<method name="createConfirmDialog">
			<description>Creates a new <link class="BiDialog">BiDialog</link> with a
 <link class="BiOptionPane">option pane</link> as the
 <link class="BiWindow" field="contentPane">contentPane</link>
 of the dialog window.<br>
				</br>
				<br>
				</br>
 This dialog is used to ask the user to confirm something. The
 buttons shown are set by the <link>optionType</link>.<br>
				</br>
				<br>
				</br>
 The <link field="dialogResult" class="BiDialog">dialogResult</link>
 for the dialog reflects the button clicked. The values are:<br>
				</br>
				<br>
				</br>
 ok - The "OK" button was clicked<br>
				</br>
 cancel - The "Cancel" button was clicked<br>
				</br>
 yes - The "Yes" button was clicked<br>
				</br>
 no  - The "No" button was clicked<br>
				</br>
				<br>
				</br>
 This method uses the static method provided by the
<link class="BiOptionPane">BiOptionPane</link> class.</description>
			<arguments>
				<argument name="oMessage">
					<description>The text or<link class="BiComponent">BiComponent</link> to show as a message
 							inside the dialog</description>
					<type>Object</type>
				</argument>
				<argument name="sCaption" optional="true" default="Select an Option">
					<description>The caption text to show on the dialog window </description>
					<type>String</type>
				</argument>
				<argument name="sMessageType" optional="true" default="question">
					<description>The type of the message that is shown. This sets the image on the option pane if no other image is provided. Valid values are:<br>
						</br>
						<br>
						</br>
                                 plain - No image<br>
						</br>
                                 error - Shows a stop (x) image<br>
						</br>
                                 information - Shows an image with an 'i' on<br>
						</br>
                                 warning - Shows an image with an exclamation mark on<br>
						</br>
                                 question - Show a question mark image</description>
					<type>String</type>
				</argument>
				<argument name="sOptionType" optional="true" default="yesnocancel">
					<description>The option type describes what buttons to show on the optinon pane. This is ignored if the <link>options</link> are set. Valid values are:<br>
						</br>
						<br>
						</br>
                                 default - Usually shows an "OK" button<br>
						</br>
                                 yesno - Shows a "Yes" and a "No" button<br>
						</br>
                                 yesnocancel - Shows three buttons with the text "Yes", "No" and "Cancel"<br>
						</br>
                                 okcancel - Shows a "OK" and a "Cancel" button</description>
					<type>String</type>
				</argument>
				<argument name="oImage" optional="true">
					<description>The image to show on the option pane. If left out then the image defined by the <link class="BiOptionPane" field="messageType">messageType</link> is used.</description>
					<type>
						<link class="BiImage">BiImage</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>
					<link class="BiDialog">BiDialog</link>
				</type>
			</returns>
		</method>
		<method name="createInputDialog">
			<description>Creates a new<link class="BiDialog">BiDialog</link> with a <link class="BiOptionPane">option pane</link>
 as the <link class="BiWindow" field="contentPane">contentPane</link> of the
 dialog window.<br>
				</br>
				<br>
				</br>
 This dialog is used to allow the user to enter a text value. The
 default text value can be provided using the <code>sDefaultValue</code>
 argument. The buttons provided for these dialogs are always an
 "OK" and a "Cancel" button.<br>
				</br>
				<br>
				</br>
 The <link field="dialogResult" class="BiDialog">dialogResult</link>
 for the dialog reflects whether the user entered any value and pressed
 "OK" or pressed "Cancel". The value is <code>null</code> when the
 user canceled the dialog, otherwise the entered string value is used.<br>
				</br>
				<br>
				</br>
 This method uses the static method provided by the<link class="BiOptionPane">BiOptionPane</link> class.</description>
			<arguments>
				<argument name="oMessage">
					<description>The text or<link class="BiComponent">BiComponent</link> to show
 							as a message inside the dialog</description>
					<type>Object</type>
				</argument>
				<argument name="sCaption" optional="true" default="Input">
					<description>The caption text to show on the dialog window </description>
					<type>String</type>
				</argument>
				<argument name="sMessageType" optional="true" default="question">
					<description>The type of the message that is shown. This sets the image on the option pane if no other image is provided. Valid values are:<br>
						</br>
						<br>
						</br>
                                 plain - No image<br>
						</br>
                                 error - Shows a stop (x) image<br>
						</br>
                                 information - Shows an image with an 'i' on<br>
						</br>
                                 warning - Shows an image with an exclamation mark on<br>
						</br>
                                 question - Show a question mark image</description>
					<type>String</type>
				</argument>
				<argument name="oImage">
					<description>The image to show on the option pane. If left out then the image
 							defined by the <link>messageType</link> is used.</description>
					<type>
						<link class="BiImage">BiImage</link>
					</type>
				</argument>
				<argument name="sDefaultValue">
					<description>The default text to show on the text field</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>
					<link class="BiDialog">BiDialog</link>
				</type>
			</returns>
		</method>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
		<method name="centerDialog">
			<description>Centers the dialog window inside the application window</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
	</methods>
	<properties>
		<property name="dialogResult" get="true" set="true">
			<description>The value set by the dialog before it is closed. the dialogResult should be
 set by the content of the dialog before it is closed</description>
			<type>Object</type>
		</property>
		<property name="defaultFocusedComponent" get="true" set="true">
			<description>This allows you to set the component that should be focused when the dialog
 is shown. If <code>null</code> then the acceptButton is used for this.</description>
			<type>
				<link class="BiComponent">BiComponent</link>
			</type>
		</property>
		<property name="centered" get="true" set="true">
			<description>This property decides whether to automatically center the dialog when it
 is shown</description>
			<type>Boolean</type>
		</property>
	</properties>
	<events>
		<event name="dialogresult">
			<description>This event is called when the dialog is
 								closed (or hidden). This is the main event
                                 to use with dialogs since it is fired when
                                 the user closes it or selects a value in it.</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
	</events>
	<remarks>When the dialog is closed it is also disposed and can therefore
 			not be used any more. To be able to reuse the dialog catch the
             <link class="BiWindow" field="beforeclose">beforeclose</link>
             event and prevent the default action.</remarks>
</class>