bidraganddropmanager.xml

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

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiDragAndDropManager" extends="BiObject">
	<description>This class is used to manage the drag and drop system</description>
	<arguments>
	</arguments>
	<staticMethods>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
		<method name="addData">
			<description>Adds data with the given type</description>
			<arguments>
				<argument name="sType">
					<description>A string identifying the type of the data</description>
					<type>String</type>
				</argument>
				<argument name="oData">
					<description>The data to ue</description>
					<type>Obejct</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="startDrag">
			<description>This initiates the drag and drop session and can only be called during a
 <link class="BiComponent" field="dragstart">dragstart</link> event</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="handleMouseEvent">
			<description>Called by the event manager when a mouse event occurs</description>
			<arguments>
				<argument name="e">
					<description>The mouse event in use</description>
					<type>
						<link class="BiMouseEvent">BiMouseEvent</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="handleMouseDown">
			<description>This is called by the event system when a mousedown event occurs</description>
			<arguments>
				<argument name="e">
					<description>The event in use when the mousedown event</description>
					<type>
						<link class="BiMouseEvent">BiMouseEvent</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="handleMouseMove">
			<description>This is called by the event system when a mousemove event occurs</description>
			<arguments>
				<argument name="e">
					<description>The event in use for the mousemove event</description>
					<type>
						<link class="BiMouseEvent">BiMouseEvent</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="handleMouseUp">
			<description>This is called by the event system when a mouseup event occurs</description>
			<arguments>
				<argument name="e">
					<description>The event in use for the mouseup event</description>
					<type>
						<link class="BiMouseEvent">BiMouseEvent</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="handleKeyboardEvent">
			<description>Called by the event manager when a mouse event occurs</description>
			<arguments>
				<argument name="e">
					<description>The mouse event in use</description>
					<type>
						<link class="BiKeyboardEvent">BiKeyboardEvent</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="handleKeyDown">
			<description>This is called by the event system when a keydown event occurs</description>
			<arguments>
				<argument name="e">
					<description>The event in use for the keydown event</description>
					<type>
						<link class="BiKeyboardEvent">BiKeyboardEvent</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="handleKeyUp">
			<description>This is called by the event system when a keyup event occurs</description>
			<arguments>
				<argument name="e">
					<description>The event in use for the keyup event</description>
					<type>
						<link class="BiKeyboardEvent">BiKeyboardEvent</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="cancelDrag">
			<description>Ends the current drag and drop session and fires dragend on the source</description>
			<arguments>
				<argument name="e">
					<description>The event that caused this to be canceled</description>
					<type>
						<link class="BiMouseEvent">BiMouseEvent</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="supportsDrop">
			<description>Tests that the component supports the data type</description>
			<arguments>
				<argument name="oComponent">
					<description>The component to test whether a drop can be done on it</description>
					<type>
						<link class="BiComponent">BiComponent</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="getDropTarget">
			<description>Gets first component that can support the data type.</description>
			<arguments>
				<argument name="e">
					<description>The mouse event used</description>
					<type>
						<link class="BiMouseEvent">BiMouseEvent</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>
					<link class="BiComponent">BiComponent</link>
				</type>
			</returns>
		</method>
		<method name="addAction">
			<description>Adds a supported action. Valid values are <br>
				</br>
				<br>
				</br>
 copy<br>
				</br>
 alias<br>
				</br>
 move</description>
			<arguments>
				<argument name="sAction">
					<description>The action to add support for</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="clearActions">
			<description>Clears the supported action.</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="removeAction">
			<description>Removes an action.</description>
			<arguments>
				<argument name="sAction">
					<description>The action to no longer support</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
	</methods>
	<properties>
		<property name="source" get="true">
			<description>The component that started the drag and drop session</description>
			<type>
				<link class="BiComponent">BiComponent</link>
			</type>
		</property>
		<property name="destination" get="true">
			<description>The drop target</description>
			<type>
				<link class="BiComponent">BiComponent</link>
			</type>
		</property>
		<property name="dropDataTypes" get="true">
			<description>The union of the supported data types by the drop target and the drag and
 drop session</description>
			<type>String[]</type>
		</property>
		<property name="action" get="true" set="true">
			<description>The desired action to use for the drag and drop session</description>
			<type>String</type>
		</property>
		<property name="dragIcon" get="true" set="true">
			<description>The component to use as the icon next to the cursor when doing drag
 and drop. When this is set to null images are shown that represents the
 action</description>
			<type>oComp :<link class="BiComponent">BiComponent</link>	The component to show</type>
		</property>
	</properties>
	<events>
	</events>
	<remarks>
	</remarks>
</class>