biwindow.xml

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

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiWindow" extends="BiComponent">
	<description>This class is used for internal windows inside the application window.</description>
	<arguments>
		<argument name="sCaption" optional="true" default="&quot;&quot;">
			<description>The title text of the window </description>
			<type>String</type>
		</argument>
	</arguments>
	<staticMethods>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
		<method name="close">
			<description>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
 <link class="BiComponent" field="visible">visible</link> property
 to <code>false</code>.<br>
				</br>
				<br>
				</br>
 Before the window is closed the <link>beforeclose</link> event is
 fired. If the default action is prevented using
 <link class="BiEvent" field="preventDefault">preventDefault</link>
 the window will not be closed. If the default action is not prevented
 then the <link>close</link> event is fired and the window is closed.</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="bringToFront">
			<description>Makes so that the window is displayed on top of all other shown windows.</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="sendToBack">
			<description>Makes so that the current window is displayed behind all other windows</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="addCommand">
			<description>Adding a command to the window allows the window to execute the
 command when the user presses the needed keys.</description>
			<arguments>
				<argument name="c">
					<description>The command to add</description>
					<type>
						<link class="BiCommand">BiCommand</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="removeCommand">
			<description>Removes a command from the window.</description>
			<arguments>
				<argument name="c">
					<description>The command to remove</description>
					<type>
						<link class="BiCommand">BiCommand</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
	</methods>
	<properties>
		<property name="contentPane" get="true" set="true">
			<description>This returns the component representing the client area of the window.
 All components should be added to this component.</description>
			<type>
				<link class="BiComponent">BiComponent</link>
			</type>
		</property>
		<property name="showIcon" get="true" set="true">
			<description>Whether to show the icon on the caption</description>
			<type>Boolean</type>
		</property>
		<property name="showMinimize" get="true" set="true">
			<description>Whether to show the minimize buttton on the caption</description>
			<type>Boolean</type>
		</property>
		<property name="showMaximize" get="true" set="true">
			<description>Whether to show the maximize buttton on the caption</description>
			<type>
				<link class="BiWindow">BiWindow</link>
			</type>
		</property>
		<property name="showClose" get="true" set="true">
			<description>Whether to show the close buttton on the caption</description>
			<type>Boolean</type>
		</property>
		<property name="caption" get="true" set="true">
			<description>The title text of the window</description>
			<type>String</type>
		</property>
		<property name="icon" get="true" set="true">
			<description>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.</description>
			<type>
				<link class="BiImage">BiImage</link>
			</type>
		</property>
		<property name="canMinimize" get="true" set="true">
			<description>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.</description>
			<type>Boolean</type>
		</property>
		<property name="hideChrome" get="true" set="true">
			<description>Whether to hide the caption bar of the window</description>
			<type>Boolean</type>
		</property>
		<property name="resizable" get="true" set="true">
			<description>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.</description>
			<type>Boolean</type>
		</property>
		<property name="movable" get="true" set="true">
			<description>Whether the window can be moved by the user.</description>
			<type>Boolean</type>
		</property>
		<property name="state" get="true" set="true">
			<description>The state of the window. Valid values are:<br>
				</br>
				<br>
				</br>
				<code>normal</code>
				<br>
				</br>
				<code>maximized</code>
				<br>
				</br>
				<code>minimized</code>
			</description>
			<type>String</type>
		</property>
		<property name="active" get="true" set="true">
			<description>Whether teh window should be the active window</description>
			<type>Boolean</type>
		</property>
		<property name="acceptButton" get="true" set="true">
			<description>The button that acts as the default accept button. If this is set
 then the <link class="BiButton" field="action">action</link>
 event is dispatched from the accept button when the enter key
 is pressed. This does not have to
 be a <link class="BiButton">BiButton</link>, any
 <link class="BiEventTarget">BiEventTarget</link> will work.</description>
			<type>
				<link class="BiEventTarget">BiEventTarget</link>
			</type>
		</property>
		<property name="cancelButton" get="true" set="true">
			<description>The button that acts as the default cancel button. If this is set
 then the <link class="BiButton" field="action">action</link>
 event is dispatched from the cancel button. This does not have to
 be a <link class="BiButton">BiButton</link>, any
 <link class="BiEventTarget">BiEventTarget</link> will work.</description>
			<type>
				<link class="BiEventTarget">BiEventTarget</link>
			</type>
		</property>
		<property name="opaque" get="true" set="true">
			<description>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.</description>
			<type>Boolean</type>
		</property>
	</properties>
	<events>
		<event name="beforeclose">
			<description>Fires before the window is closed. If the
 									default action is prevented the window is
                                  not closed</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
		<event name="close">
			<description>Fires when the window is closed</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
		<event name="captionchanged">
			<description>Fires when the <link>caption</link> changes</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
		<event name="statechanged">
			<description>Fires when the window <link>state</link> changes.</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
		<event name="iconchanged">
			<description>Fires when the <link>icon</link> changes</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
		<event name="activated">
			<description>Fires when the window becomes <link>active</link>
			</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
		<event name="deactivated">
			<description>Fires when the window becomes <link>active</link>
			</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
	</events>
	<remarks>Content should not be added directly to the window but should be
 			added to the <link>contentPane</link>.</remarks>
</class>