bimouseevent.xml

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

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiMouseEvent" extends="BiEvent">
	<description>This class describes event objects used in mouse events.<br>
		</br>
		<br>
		</br>
 All mouse events bubble by default. This means that once all the
 event listeners have been notified 	the event propagates to the parent
 <link class="BiComponent">BiComponent</link>. To prevent the event to
 bubble to the parent call <link class="BiEvent" field="stopPropagation">
 stopPropagation()</link> on the event object.<br>
		</br>
		<br>
		</br>
 The currently supported events by <link class="BiComponent">BiComponent</link>
 are:<br>
		</br>
		<br>
		</br>
		<link class="BiComponent" field="mousedown">mousedown</link>
		<br>
		</br>
		<link class="BiComponent" field="mouseup">mouseup</link>
		<br>
		</br>
		<link class="BiComponent" field="click">click</link>
		<br>
		</br>
		<link class="BiComponent" field="dblclick">dblclick</link>
		<br>
		</br>
		<link class="BiComponent" field="contextmenu">contextmenu</link> - this one is a bit tricky since it might also be dispatched when the user presses the context menu key on their keyboard<br>
		</br>
		<link class="BiComponent" field="mouseover">mouseover</link>
		<br>
		</br>
		<link class="BiComponent" field="mouseout">mouseout</link>
		<br>
		</br>
		<link class="BiComponent" field="mousemove">mousemove</link>
		<br>
		</br>
		<link class="BiComponent" field="mousewheel">mousewheel</link>
		<br>
		</br>
		<br>
		</br>
 When a user double clicks on a component the order of the mouse events is
 the following:<br>
		</br>
		<link class="BiComponent" field="mousedown">mousedown</link>
		<br>
		</br>
		<link class="BiComponent" field="mouseup">mouseup</link>
		<br>
		</br>
		<link class="BiComponent" field="click">click</link>
		<br>
		</br>
		<link class="BiComponent" field="mousedown">mousedown</link>
		<br>
		</br>
		<link class="BiComponent" field="mouseup">mouseup</link>
		<br>
		</br>
		<link class="BiComponent" field="click">click</link>
		<br>
		</br>
		<link class="BiComponent" field="dblclick">dblclick</link>
		<br>
		</br>
		<br>
		</br>
 This object should not be created by the user. It is created as needed by the event system.</description>
	<arguments>
		<argument name="sType">
			<description>The type (name) of the event.</description>
			<type>String</type>
		</argument>
		<argument name="oEvent">
			<description>This is the internal browser event object.</description>
			<type>Object</type>
		</argument>
	</arguments>
	<staticMethods>
		<method name="getScreenX">
			<description>This returns the last recorded left mouse position relative to
 the screen.</description>
			<arguments>
			</arguments>
			<returns>
				<type>Number</type>
			</returns>
		</method>
		<method name="getScreenY">
			<description>This returns the last recorded top mouse position relative to
 the screen.</description>
			<arguments>
			</arguments>
			<returns>
				<type>Number</type>
			</returns>
		</method>
		<method name="getClientX">
			<description>This returns the last recorded left mouse position relative to
 the browser view port (client area).</description>
			<arguments>
			</arguments>
			<returns>
				<type>Number</type>
			</returns>
		</method>
		<method name="getClientY">
			<description>This returns the last recorded top mouse position relative to
 the browser view port (client area).</description>
			<arguments>
			</arguments>
			<returns>
				<type>Number</type>
			</returns>
		</method>
		<method name="getButton">
			<description>Returns the last recorded mouse button used in a mouse event.</description>
			<arguments>
			</arguments>
			<returns>
				<type>Number</type>
			</returns>
		</method>
	</staticMethods>
	<staticFields>
		<field name="LEFT">
			<description>Constant used to test whether the left button is pressed.</description>
			<type>Number</type>
		</field>
		<field name="RIGHT">
			<description>Constant used to test whether the middle button is pressed.</description>
			<type>Number</type>
		</field>
		<field name="MIDDLE">
			<description>Constant used to test whether the right button is pressed.</description>
			<type>Number</type>
		</field>
	</staticFields>
	<methods>
	</methods>
	<properties>
		<property name="clientX" get="true">
			<description>The position of the mouse pointer relative to the browser viewport.</description>
			<type>Number</type>
		</property>
		<property name="clientY" get="true">
			<description>The position of the mouse pointer relative to the browser viewport.</description>
			<type>Number</type>
		</property>
		<property name="screenX" get="true">
			<description>The position of the mouse pointer relative to the screen.</description>
			<type>Number</type>
		</property>
		<property name="screenY" get="true">
			<description>The position of the mouse pointer relative to the screen.</description>
			<type>Number</type>
		</property>
		<property name="offsetX" get="true">
			<description>The position of the mouse pointer relative to the event target.</description>
			<type>Number</type>
		</property>
		<property name="offsetY" get="true">
			<description>The position of the mouse pointer relative to the event target.</description>
			<type>Number</type>
		</property>
		<property name="ctrlKey" get="true">
			<description>Whether the ctrl key pressed.</description>
			<type>Boolean</type>
		</property>
		<property name="shiftKey" get="true">
			<description>Whether the shift key pressed.</description>
			<type>Boolean</type>
		</property>
		<property name="altKey" get="true">
			<description>Whether the alt key pressed.</description>
			<type>Boolean</type>
		</property>
		<property name="relatedTarget" get="true">
			<description>The related target is used with mouseover and mouseout events. In
 a mouseover event the related target is the component that the mouse
 pointer left and for a mouseout it is the component that the mouse
 entered.</description>
			<type>
				<link class="BiEventTarget">BiEventTarget</link>
			</type>
		</property>
		<property name="button" get="true">
			<description>Returns a number representing the mouse button that is pressed.</description>
			<type>Number</type>
		</property>
		<property name="wheelDelta" get="true">
			<description>The amount that the user scrolled the mouse wheel.</description>
			<type>Number</type>
		</property>
	</properties>
	<events>
	</events>
	<remarks>This object should not be created by the user. It is created as
 			needed by the event system.</remarks>
</class>