biolapgridstatemanager.xml

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

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiOlapGridStateManager" extends="BiEventTarget">
	<description>A simple class that is used internally with the<link class="BiOlapGrid">BiOlapGrid</link> to keep track
 of active and hover cell</description>
	<arguments>
	</arguments>
	<staticMethods>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
		<method name="setHover">
			<description>Sets the hover state</description>
			<arguments>
				<argument name="oCellInfo">
					<description>Information about the cell</description>
					<type>
						<link class="BiOlapGridCellInfo">BiOlapGridCellInfo</link>
					</type>
				</argument>
				<argument name="e">
					<description>The mouse event causing this change</description>
					<type>
						<link class="BiMouseEvent">BiMouseEvent</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="setDrag">
			<description>Sets the drag state</description>
			<arguments>
				<argument name="oCellInfo">
					<description>Information about the cell</description>
					<type>
						<link class="BiOlapGridCellInfo">BiOlapGridCellInfo</link>
					</type>
				</argument>
				<argument name="e">
					<description>The mouse event causing this change</description>
					<type>
						<link class="BiMouseEvent">BiMouseEvent</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="setDragOver">
			<description>Sets the drag over state</description>
			<arguments>
				<argument name="oCellInfo">
					<description>Information about the cell</description>
					<type>
						<link class="BiOlapGridCellInfo">BiOlapGridCellInfo</link>
					</type>
				</argument>
				<argument name="e">
					<description>The mouse event causing this change</description>
					<type>
						<link class="BiMouseEvent">BiMouseEvent</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="updateState">
			<description>Updates the internal state given the argument</description>
			<arguments>
				<argument name="sType">
					<description>The event type that caused this to be called</description>
					<type>String</type>
				</argument>
				<argument name="oCellInfo">
					<description>Information about the cell</description>
					<type>
						<link class="BiOlapGridCellInfo">BiOlapGridCellInfo</link>
					</type>
				</argument>
				<argument name="e">
					<description>The mouse event causing this change</description>
					<type>
						<link class="BiMouseEvent">BiMouseEvent</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
	</methods>
	<properties>
		<property name="active" get="true" set="true">
			<description>The active cell info</description>
			<type>
				<link class="BiOlapGridCellInfo">BiOlapGridCellInfo</link>
			</type>
		</property>
		<property name="hover" get="true">
			<description>The hover cell info</description>
			<type>
				<link class="BiOlapGridCellInfo">BiOlapGridCellInfo</link>
			</type>
		</property>
		<property name="drag" get="true">
			<description>The cell info for the cell where the user started the drag on</description>
			<type>
				<link class="BiOlapGridCellInfo">BiOlapGridCellInfo</link>
			</type>
		</property>
		<property name="dragOver" get="true">
			<description>This is used to allow specific feedback during drag and drop. This returns
 the cell info for the cell that the user is dragging over</description>
			<type>
				<link class="BiOlapGridCellInfo">BiOlapGridCellInfo</link>
			</type>
		</property>
	</properties>
	<events>
		<event name="hoverchanged">
			<description>When the user hovers over a different part
 										of the OLAP grid</description>
			<type>
				<link class="BiOlapStateEvent">BiOlapStateEvent</link>
			</type>
		</event>
		<event name="dropoverchanged">
			<description>This event is fired when the user is doing drag and drop
 											and the cell that the user is over changes.</description>
			<type>
				<link class="BiOlapStateEvent">BiOlapStateEvent</link>
			</type>
		</event>
	</events>
	<remarks>
	</remarks>
</class>