biolapgrid.xml

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

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiOlapGrid" extends="BiTreeViewBase">
	<description>This class is used to display an OLAP Grid</description>
	<arguments>
	</arguments>
	<staticMethods>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
		<method name="updateContentSize">
			<description>This is called when the size of the content has changed.</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="updateSize">
			<description>This updates the sizes of different parts of the sub controls</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="getHtmlCode">
			<description>This returns the HTML code for the body of the OLAP grid</description>
			<arguments>
				<argument name="nStartCol">
					<description>The column to start drawing at</description>
					<type>Number</type>
				</argument>
				<argument name="nStartRow">
					<description>The row to start painting at</description>
					<type>Number</type>
				</argument>
				<argument name="nWidth">
					<description>The width of the viewport</description>
					<type>Number</type>
				</argument>
				<argument name="nHeight">
					<description>The height of the viewport</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
		<method name="getFixedTopHtmlCode">
			<description>This returns the HTML code for fixed top part of the OLAP grid. This includes
 the column headers as well as any fixed rows of the body</description>
			<arguments>
				<argument name="nScrollLeft">
					<description>the distance from the left to start painting at</description>
					<type>Number</type>
				</argument>
				<argument name="nWidth">
					<description>the width of the viewport</description>
					<type>Number</type>
				</argument>
				<argument name="nHeight">
					<description>the height of the viewport</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
		<method name="getHeadersHtmlCode">
			<description>This returns the HTML code for header of the OLAP grid</description>
			<arguments>
				<argument name="nStartCol">
					<description>The column to start drawing at</description>
					<type>Number</type>
				</argument>
				<argument name="nWidth">
					<description>The width of the viewport</description>
					<type>Number</type>
				</argument>
				<argument name="nHeight">
					<description>The height of the viewport</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
		<method name="getFixedLeftHtmlCode">
			<description>This returns the HTML code for the left fixed part of the OLAP grid. This
 includes the row headers and any fixed columns</description>
			<arguments>
				<argument name="nScrollTop">
					<description>the distance from the top to start painting at</description>
					<type>Number</type>
				</argument>
				<argument name="nWidth">
					<description>the width of the viewport</description>
					<type>Number</type>
				</argument>
				<argument name="nHeight">
					<description>the height of the viewport</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
		<method name="getRowHeadersHtmlCode">
			<description>This returns the HTML code for the row headers.</description>
			<arguments>
				<argument name="nStartRow">
					<description>The row to start painting at</description>
					<type>Number</type>
				</argument>
				<argument name="nWidth">
					<description>The width of the viewport</description>
					<type>Number</type>
				</argument>
				<argument name="nHeight">
					<description>The height of the viewport</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
		<method name="getFixedCornerHtmlCode">
			<description>This returns the HTML code for the fixed corner of the OLAP grid. This may include
 both headers, row headers and some part of the body depending on whether there
 are any fixed rows/columns</description>
			<arguments>
				<argument name="nWidth">
					<description>the width of the viewport</description>
					<type>Number</type>
				</argument>
				<argument name="nHeight">
					<description>the height of the viewport</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
		<method name="getCellInfo">
			<description>Returns a<link class="BiOlapGridCellInfo">BiOlapGridCellInfo</link> object based on the mouse coordinates</description>
			<arguments>
				<argument name="nOffsetX">
					<description>The left postion relative to the OLAP grid</description>
					<type>Number</type>
				</argument>
				<argument name="nOffsetY">
					<description>The top postion relative to the OLAP grid</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>
					<link class="BiOlapGridCellInfo">BiOlapGridCellInfo</link>
				</type>
			</returns>
		</method>
		<method name="getCellInfoBounds">
			<description>This returns the bounds of a cell relative to the inner edge of the OLAP
 grid (that is inside the outer border but not inside the headers/fixed area).
 This returns an object with left, top, width and height fields.</description>
			<arguments>
				<argument name="oCellInfo">
					<description>The information about the cell to
 											get the boundaries for</description>
					<type>
						<link class="BiOlapGridCellInfo">BiOlapGridCellInfo</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>Object</type>
			</returns>
		</method>
		<method name="print">
			<description>This prints the OLAP grid</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
	</methods>
	<properties>
		<property name="allowHeaderSelection" get="true" set="true">
			<description>Whether clicking on a dimension header also selects the rows/column of the header.</description>
			<type>
				<link class="BiOlapGridSelectionModel">BiOlapGridSelectionModel</link>
			</type>
		</property>
		<property name="canReorganizeDimensions" get="true" set="true">
			<description>When this is true the user can reorganize the dimensions using drag and drop
 TODO: Document what events are fired when the reorg should happen</description>
			<type>Boolean</type>
		</property>
		<property name="printHtml" get="true">
			<description>This returns some HTML code that can be sent to a printer</description>
			<type>String</type>
		</property>
		<property name="allowTab" get="true">
			<description>Whether pressing the tab key should change the selected cell or navigate to the
 next component in the tab order.</description>
			<type>Boolean</type>
		</property>
	</properties>
	<events>
		<event name="dimensiondrop">
			<description>This is fired when a dimension
 												of the current grid is dropped
                                                 on another dimension. This can
                                                 only happen if <link>canReorganizeDimensions</link>
                                                 is <code>true</code>
			</description>
			<type>
				<link class="BiOlapGridDragEvent">BiOlapGridDragEvent</link>
			</type>
		</event>
	</events>
	<remarks>
	</remarks>
</class>