bipopup.xml

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

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

<class name="BiPopup" extends="BiLabel">

	<description>
		A popup is a component that is displayed on top of all other components
		and is not limited by the parent components view port.
	</description>


	<arguments/>

	<staticMethods/>

	<staticFields/>

	<methods>
		<method name="sendToBack">
			<description>Makes so that the current popup is displayed behind all other shown popups</description>
			<arguments/>
			<returns type="void"/>
		</method>
		<method name="bringToFront">
			<description>Makes so that the popup is displayed on top of all other shown popups.</description>
			<arguments/>
			<returns type="void"/>
		</method>
		<method name="positionRelativeToComponent">
			<description>
				Sets the popup to be positioned relative to another component.
				Valid values for the direction are <code>vertical</code>
				and <code>horizontal</code>.
			</description>
			<arguments>
				<argument name="oComponent">
					<description>
						The component to position the popup relative to
					</description>
					<type><link class="BiComponent">BiComponent</link></type>
				</argument>
				<argument name="sDir" optional="true" default="vertical">
					<description>
						The direction relative to the component
					</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns type="void"/>
		</method>
	</methods>

	<properties>
		<property name="allowOffScreen" type="Boolean" description="Whether to allow the popup to be positioned off screen" get="true" set="true"/>
		<property name="autoHide" type="Boolean" get="true" set="true">
			<description>
				Whether to let the system decide when to hide the popup. Setting
				this to <code>false</code> gives you better control but it also
				requires you to handle the closing of the popup.
			</description>
		</property>
		<property name="screenLeft" type="Number" description="The position relative to the screen.
			Note that this can be both set and get for popups." get="true" set="true"/>
		<property name="screenTop" type="Number" description="The position relative to the screen.
			Note that this can be both set and get for popups." get="true" set="true"/>
		<property name="clientLeft" type="Number" description="The position relative to the browser client area.
			Note that this can be both set and get for popups." get="true" set="true"/>
		<property name="clientTop" type="Number" description="The position relative to the browser client area.
			Note that this can be both set and get for popups." get="true" set="true"/>
		<property name="showTimeStamp" type="Date" description="The time when the popup was shown." get="true"/>
		<property name="hideTimeStamp" type="Date" description="The time when the popup was hidden.
			This can be useful to find out whether the popup was just hidden." get="true"/>
	</properties>

	<events>
		<event name="beforeshow" description="Fires before the popup is shown.
			This is a good place to change the content of the tool tip and set the
			preferred size if the default preferred size is not wanted">
			<type><link class="BiEvent">BiEvent</link></type>
		</event>
		<event name="show" description="Fires when the popup is shown">
			<type><link class="BiEvent">BiEvent</link></type>
		</event>
		<event name="hide" description="Fires when the popup is hidden">
			<type><link class="BiEvent">BiEvent</link></type>
		</event>
	</events>

	<remarks/>
</class>