bidragevent.xml

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

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiDragEvent" extends="BiMouseEvent">
	<description>This event is used in drag and drop sesssions</description>
	<arguments>
		<argument name="sType">
			<description>The type of the event</description>
			<type>String</type>
		</argument>
		<argument name="oMouseEvent">
			<description>The mouse event object used to initiate this event</description>
			<type>
				<link class="BiMouseEvent">BiMouseEvent</link>
			</type>
		</argument>
	</arguments>
	<staticMethods>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
		<method name="startDrag">
			<description>Call this in a <link class="BiComponent" field="dragstart">dragstart</link>
 event to start the actual drag and drop session.</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="addData">
			<description>This adds some data to be used in the drag and drop session</description>
			<arguments>
				<argument name="sType">
					<description>A string identifying the data</description>
					<type>String</type>
				</argument>
				<argument name="oData">
					<description>The data to be used</description>
					<type>Object</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="getData">
			<description>Returns the data for the given type</description>
			<arguments>
				<argument name="sType">
					<description>The string identifying the data</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>Object</type>
			</returns>
		</method>
		<method name="clearData">
			<description>Clears the data associated with the drag and drop session</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="addAction">
			<description>Adds an action supported by the drag and drop session</description>
			<arguments>
				<argument name="sAction">
					<description>The name of the action to add</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="removeAction">
			<description>Removes an action which is no longer supported by the drag and drop session</description>
			<arguments>
				<argument name="sAction">
					<description>The name of the action to remove</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="clearActions">
			<description>Removes the supported actions for the current drag and drop session</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
	</methods>
	<properties>
		<property name="manager" get="true">
			<description>This returns the drag and drop manager used in the drag and drop session</description>
			<type>
				<link class="BiDragAndDropManager">BiDragAndDropManager</link>
			</type>
		</property>
		<property name="dropDataTypes" get="true">
			<description>Returns the types that the data is avaible for</description>
			<type>String[]</type>
		</property>
		<property name="action" get="true">
			<description>Returns the action that the session is currently using</description>
			<type>String</type>
		</property>
		<property name="relatedTarget" get="true">
			<description>Returns the related component in the drag'n drop session<br>
				</br>
				<br>
				</br>
 For <code>dragover</code> this returns the component that was left (if a
 valid drop target)<br>
				</br>
 For <code>dragout</code> this returns the component that was entered (if a
 valid drop target)<br>
				</br>
 For <code>dragdrop</code> this returns the source of the drag'n drop<br>
				</br>
 For <code>dragend</code> this returns the destination (drop target)</description>
			<type>
				<link class="BiComponent">BiComponent</link>
			</type>
		</property>
		<property name="dragIcon" get="true" set="true">
			<description>The component to use as the icon next to the pointer</description>
			<type>
				<link class="BiComponent">BiComponent</link>
			</type>
		</property>
		<property name="realTarget" get="true">
			<description>This is the component that mouse is currently over. This is useful in case
 You want to show a drop marker relative to the component below the pointer
 and that component is not a valid drop target</description>
			<type>
				<link class="BiComponent">BiComponent</link>
			</type>
		</property>
	</properties>
	<events>
	</events>
	<remarks>Unlike<link class="BiMouseEvent">BiMouseEvent</link> the target (and relatedTarget) is not always
 			the direct component under the mouse pointer but the first
             valid drop target (or the source of the drag'n drop).<br>
		</br>
		<br>
		</br>
             Valid drop targets are decided based on the
             <link class="BiComponent" field="dropDataTypes">drop data types</link>
             and the data in the drag'n drop session.</remarks>
</class>