bimenu.xml

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

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiMenu" extends="BiEventTarget">
	<description>This class represents a menu. Menus can be filled with menu items by
 adding <link class="BiMenuItem">BiMenuItem</link> objects.<br>
		</br>
		<br>
		</br>
 The content model for the menu is very similiar to the content model for
 <link class="BiComponent">BiComponent</link> but there are slight differences.</description>
	<arguments>
	</arguments>
	<staticMethods>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
		<method name="add">
			<description>Adds a menu item to the current menu. The added
 menu item becomes a child of the current menu. If the menu item
 is child of another menu it is first removed from that menu.
 The second, optional, argument can be used to insert the new menu item
 before an existing child.</description>
			<arguments>
				<argument name="oChild">
					<description>The menu item to add</description>
					<type>
						<link class="BiMenuItem">BiMenuItem</link>
					</type>
				</argument>
				<argument name="oBefore" optional="true">
					<description>The existing child do add the new menu item before </description>
					<type>
						<link class="BiMenuItem">BiMenuItem</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="remove">
			<description>Removes an existing menu item from the component.</description>
			<arguments>
				<argument name="oChild">
					<description>The menu item to remove</description>
					<type>
						<link class="BiMenuItem">BiMenuItem</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>
					<link class="BiMenuItem">BiMenuItem</link>
				</type>
			</returns>
		</method>
		<method name="removeAll">
			<description>Removes and disposes all menu items in the menu</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="hasChildren">
			<description>Returns true if the menu has any child menu items</description>
			<arguments>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="contains">
			<description>Returns true if the menu contains another menu item or menu.
 This means that the current component is an ancestor of the descendant.
 Note that the current component contains itself so calling
 <code>component.contains(component)</code> will return <code>true</code>.</description>
			<arguments>
				<argument name="oDescendant">
					<description>The <link class="BiMenu">BiMenu</link> or <link class="BiMenuItem">BiMenuItem</link> to test whether the
 									current component contains it.</description>
					<type>Object</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="setLocation">
			<description>Sets the left and top position relative to the screen for the menu.</description>
			<arguments>
				<argument name="nLeft">
					<description>The new left location for the menu</description>
					<type>Number</type>
				</argument>
				<argument name="nTop">
					<description>The new top location for the menu</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="setSize">
			<description>Sets the width and height of the menu.</description>
			<arguments>
				<argument name="nWidth">
					<description>The new width for the menu</description>
					<type>Number</type>
				</argument>
				<argument name="nHeight">
					<description>The new height for the menu</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
	</methods>
	<properties>
		<property name="showTimeStamp" get="true">
			<description>The time when the menu was shown.</description>
			<type>Date</type>
		</property>
		<property name="hideTimeStamp" get="true">
			<description>The time when the menu was hidden. This can be useful to find out whether
 the popup was just hidden.</description>
			<type>Date</type>
		</property>
		<property name="parent" get="true">
			<description>The parent menu item in case the menu acts as a sub menu</description>
			<type>
				<link class="BiMenuItem">BiMenuItem</link>
			</type>
		</property>
		<property name="parentMenu" get="true">
			<description>The parent menu in case the menu acts as a sub menu.
 This is the same as the parent of the parent menu item</description>
			<type>
				<link class="BiMenu">BiMenu</link>
			</type>
		</property>
		<property name="children" get="true">
			<description>The menu items added to the menu</description>
			<type>
				<link class="BiMenuItem">BiMenuItem[]</link>
			</type>
		</property>
		<property name="topLevelComponent" get="true">
			<description>Returns the top level ancestor component. This is usually the
 application window hosting the application.</description>
			<type>
				<link class="BiComponent">BiComponent</link>
			</type>
		</property>
		<property name="firstChild" get="true">
			<description>Returns the first menu item child</description>
			<type>
				<link class="BiMenuItem">BiMenuItem</link>
			</type>
		</property>
		<property name="lastChild" get="true">
			<description>Returns the last menu item child</description>
			<type>
				<link class="BiMenuItem">BiMenuItem</link>
			</type>
		</property>
		<property name="visible" set="true">
			<description>Shows or hides the menu</description>
			<type>Boolean</type>
		</property>
		<property name="left" get="true" set="true">
			<description>Sets or gets the left position of the menu relative to the screen</description>
			<type>Number</type>
		</property>
		<property name="top" get="true" set="true">
			<description>Sets or gets the top position of the menu relative to the screen</description>
			<type>Number</type>
		</property>
		<property name="width" get="true" set="true">
			<description>The width of the menu</description>
			<type>Number</type>
		</property>
		<property name="height" get="true" set="true">
			<description>The heightof the menu</description>
			<type>Number</type>
		</property>
		<property name="isVisible" get="true">
			<description>Whether the menu is shown on the screen</description>
			<type>Boolean</type>
		</property>
		<property name="preferredWidth" get="true">
			<description>The preferred width of the menu</description>
			<type>Number</type>
		</property>
		<property name="preferredHeight" get="true">
			<description>The preferred height of the menu</description>
			<type>Number</type>
		</property>
		<property name="insetLeft" get="true">
			<description>Border left width.</description>
			<type>Number</type>
		</property>
		<property name="insetRight" get="true">
			<description>Border right width.</description>
			<type>Number</type>
		</property>
		<property name="insetTop" get="true">
			<description>Border top width.</description>
			<type>Number</type>
		</property>
		<property name="insetBottom" get="true">
			<description>Border bottom width.</description>
			<type>Number</type>
		</property>
		<property name="component" get="true">
			<description>If the menu was opened as a context menu for a component
 then this will point to the component that caused the menu
 to be shown.<br>
				</br>
				<br>
				</br>
 This will return <code>null</code> if the menu is hidden or not
 opened by a component. In other words by setting
 <link class="BiComponent" field="visible">visible</link>
 manually. This is available during the <link>beforeshow</link>
 event even though the menu is not yet visible. It is also available
 when the <link>hide</link> event fires.</description>
			<type>
				<link class="BiComponent">BiComponent</link>
			</type>
		</property>
		<property name="rightToLeft" get="true" set="true">
			<description>Describes whether the component should be be layed out to support
 locales using right-to-left fonts. If this is set to <code>null</code>
 then the <link>rightToLeft</link> property for the parent component
 is used.</description>
			<type>Boolean</type>
		</property>
	</properties>
	<events>
		<event name="show">
			<description>Fires when the menu is shown</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
		<event name="beforeshow">
			<description>Fires before the menu is shown.
 									This is a good place to change the content of the menu to reflect the
                                  component causing the menu to be shown</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
		<event name="hide">
			<description>Fires when the menu is hidden</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
	</events>
	<remarks>The location of the menu is relative to the screen.<br>
		</br>
		<br>
		</br>
              A menu can only be used as a sub menu for one menu item.</remarks>
</class>