biapplicationwindow.xml

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

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiApplicationWindow" extends="BiComponent">
	<description>This class represents the actual browser window hosting the application</description>
	<arguments>
	</arguments>
	<staticMethods>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
		<method name="close">
			<description>Close the window. Some browsers allow this and some don't. Don't rely on this.</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="print">
			<description>Sends the content of the window to the printer</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. Commands are added
 to the application window by default so this is only needed to be called
 if the command previously was added to an internal <link class="BiWindow">window</link>.</description>
			<arguments>
				<argument name="c">
					<description>The command to add</description>
					<type>
						<link class="BiCommmand">BiCommmand</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="BiCommmand">BiCommmand</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="updateGlassPane">
			<description>The glass pane is used to prevent clickingon components. It is usually
 used with dialogs to make them application modal. This method takes a dialog
 and whether to hide or show the glass pane</description>
			<arguments>
				<argument name="oDialog">
					<description>The dialog window to hide or remove</description>
					<type>
						<link class="BiDialog">BiDialog</link>
					</type>
				</argument>
				<argument name="bVisible">
					<description>Whether to hide or show the glass pane</description>
					<type>Boolean</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
	</methods>
	<properties>
		<property name="caption" get="true" set="true">
			<description>The title text on the application window</description>
			<type>String</type>
		</property>
		<property name="fullScreen" get="true">
			<description>Whether the window is in full screen or not. This is currently not supported</description>
			<type>Boolean</type>
		</property>
		<property name="resizable" get="true">
			<description>Whether the window can be resized by the use. This is currently not supported</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="glassPaneVisible" get="true" set="true">
			<description>Whether to hide or show the glass pane. This allows you to manually decide
 whether to hide or show the glass pane. This is done for you when using dialogs</description>
			<type>Boolean</type>
		</property>
		<property name="globalCursor" get="true" set="true">
			<description>Setting the global cursor will make the mouse pointer use the
 given cursor for all the components and thus overriding the
 cursor property of the component.</description>
			<type>String</type>
		</property>
		<property name="allowBrowserContextMenu" get="true" set="true">
			<description>Decides whether the browser context menu should be shown by default.
 If this is set to <code>true</code> you can still prevent the
 browser context menu from being shown by calling <link class="BiEvent" field="preventDefault">preventDefault</link> on the event object
 used in the <link class="BiComponent" field="contextmenu">contextmenu</link>
 event.</description>
			<type>Boolean</type>
		</property>
	</properties>
	<events>
	</events>
	<remarks>Although<link class="BiApplicationWindow">BiApplicationWindow</link> extends<link class="BiComponent">BiComponent</link> it cannot be added
			to another component as a child. Also, some methods from<link class="BiComponent">BiComponent</link> do
			not apply. Currently known properties and methods that do not apply:<br>
		</br>
		<br>
		</br>
		<link class="BiComponent" field="visible">visible</link>
		<br>
		</br>
		<link class="BiComponent" field="zIndex">zIndex</link>
	</remarks>
</class>