biwindowmanager.xml

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

<?xml version="1.0"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>

<class name="BiWindowManager" extends="BiObject">

	<description>
		This class can be used with internal <link class="BiWindow">windows</link>
		to provide more features.
	</description>

	<arguments>
		<argument name="oComponent" optional="true">
			<description>
				This is the component that is the container for the windows.
				Do not use the window manager before a valid <link>component</link>
				is set.
			</description>
			<type><link class="BiComponent">BiComponent</link></type>
		</argument>
	</arguments>

	<staticMethods/>

	<staticFields>
		<field name="CASCADE_ICON" type="String" description="The URI of the image to use for the cascade menu item"/>
		<field name="TILE_HORIZONTALLY_ICON" type="String" description="The URI of the image to use for the tile horizontally menu item"/>
		<field name="TILE_VERTICALLY_ICON" type="String" description="The URI of the image to use for the tile vertically menu item"/>
		<field name="CLOSE_ALL_ICON" type="String" description="The URI of the image to use for the close all menu item"/>
	</staticFields>

	<methods>
		<method name="add">
			<description>Adds a window to the window manager. Added windows are then
				managed by the window manager.</description>
			<arguments>
				<argument name="oWindow" description="The window to add to the window manager">
					<type><link class="BiWindow">BiWindow</link></type>
				</argument>
			</arguments>
			<returns type="void"/>
		</method>
		<method name="remove">
			<description>
				Removes a window from the window manager. The window
				is no longer managed by the window manager. Closing a window automatically
				removes it from the window manager. The method returns the removed
				window.
			</description>
			<arguments>
				<argument name="oWindow" description="The window to remove to the window manager">
					<type><link class="BiWindow">BiWindow</link></type>
				</argument>
			</arguments>
			<returns>
				<type><link class="BiWindow">BiWindow</link></type>
			</returns>
		</method>
		<method name="cascade" description="Cascades the visible windows.">
			<arguments/>
			<returns type="void"/>
		</method>
		<method name="tileVertically" description="Tiles the visible windows vertically.">
			<arguments/>
			<returns type="void"/>
		</method>
		<method name="tileHorizontally" description="Tiles the visible windows horizontally.">
			<arguments/>
			<returns type="void"/>
		</method>
		<method name="closeAll" description="Closes all the windows.">
			<arguments/>
			<returns type="void"/>
		</method>
		<method name="minimizeAll" description="Minimizes all the windows.">
			<arguments/>
			<returns type="void"/>
		</method>
		<method name="getLastState">
			<description>
				Returns the last state (non minimized state) for the window. This
				is used to know to what state the window should return to once it
				is restored from minimized.
			</description>
			<arguments>
				<argument name="oWindow" description="The window to get the state for">
					<type><link class="BiWindow">BiWindow</link></type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
	</methods>

	<properties>
		<property name="component" description="The component that the windows are added to" get="true" set="true">
			<type><link class="BiComponent">BiComponent</link></type>
		</property>
		<property name="activeWindow" get="true" set="true">
			<description>
				The window that is currently active. This might be <code>null</code>
				if no window is active.
			</description>
			<type><link class="BiWindow">BiWindow</link></type>
		</property>
		<property name="windowsMenu" get="true">
			<description>
				This returns a menu that contains items for commands as well as
				menu items for all the windows. This can be used to switch between
				the windows and organize the windows.<br/>
				<br/>
				This menu can be added to a menu bar, as a sub menu or used as
				a context menu.
			</description>
			<type><link class="BiMenu">BiMenu</link></type>
		</property>
		<property name="windows" get="true">
			<description>
				Returns an array with the windows managed by the window manager.
			</description>
			<type><link class="BiWindow">BiWindow[]</link></type>
		</property>
	</properties>

	<events/>

	<remarks>
		Adding a window to a component that has a window manager does not
		automatically add the window to the window manager. The window needs to be
		added to the parent component as well as to the window manager.<br/>
		<br/>
		You might want to use the <link class="BiDesktopPane">BiDesktopPane</link>
		which is a component that handles the adding and removing of the windows
		for you.
	</remarks>

</class>