bitreeviewviewmanager.xml

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

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiTreeViewViewManager" extends="BiObject">
	<description>This class handles the visual properties of a<link class="BiTreeView">BiTreeView</link>
	</description>
	<arguments>
		<argument name="oTreeView" optional="true">
			<description>The tree view this view manager is to be used with</description>
			<type>
				<link class="BiTreeView">BiTreeView</link>
			</type>
		</argument>
	</arguments>
	<staticMethods>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
		<method name="resetCache">
			<description>resets the cached properties. This is called after the columns are changed</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="scrollColumnIntoView">
			<description>Scrolls the tree view so that the given column becomes visible</description>
			<arguments>
				<argument name="x">
					<description>The index of the column to scroll into view</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="scrollRowIntoView">
			<description>Scrolls the tree view so that the given row becomes visible</description>
			<arguments>
				<argument name="y">
					<description>The index of the row to scroll into view</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="scrollCellIntoView">
			<description>Scrolls the tree view so that the given cell becomes visible</description>
			<arguments>
				<argument name="x">
					<description>The column index of the cell to scroll into view</description>
					<type>Number</type>
				</argument>
				<argument name="y">
					<description>The row index of the cell to scroll into view</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="scrollSubtreeIntoView">
			<description>Scrolls a subtree into view (if possible)</description>
			<arguments>
				<argument name="y">
					<description>The row index of the row whos subtree should be						scrolled into view</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="getColumnVisible">
			<description>Whether the column at x is visible or hidden</description>
			<arguments>
				<argument name="x">
					<description>The column index</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="setColumnVisible">
			<description>Sets whether a column should be visible or not</description>
			<arguments>
				<argument name="x">
					<description>The column index (in the data model) that should be hidden or shown</description>
					<type>Number</type>
				</argument>
				<argument name="b">
					<description>Whether to hide or show the colunm</description>
					<type>Booleab</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="getCanResizeColumn">
			<description>Whether the column at x can be resize</description>
			<arguments>
				<argument name="x">
					<description>The index of the column</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="getCanMoveColumn">
			<description>Whether the user can drag the column header to reorder the columns</description>
			<arguments>
				<argument name="x">
					<description>The index of the column</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="getShowExpandIcon">
			<description>Whether to show the expand icon (plus/minus icon) for the given row</description>
			<arguments>
				<argument name="y">
					<description>The row index</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="getColumnBounds">
			<description>Returns the boundaries for the column. This returns an object with left, top
 width and height fields describing the boundaries.</description>
			<arguments>
				<argument name="x">
					<description>The index of the column</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Object</type>
			</returns>
		</method>
		<method name="getColumnLeft">
			<description>Returns the left position for the column.</description>
			<arguments>
				<argument name="x">
					<description>The index of the column</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Number</type>
			</returns>
		</method>
		<method name="getNextColumn">
			<description>Returns the index of the column coming after the given column</description>
			<arguments>
				<argument name="mx">
					<description>The index of the column</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Number</type>
			</returns>
		</method>
		<method name="getPreviousColumn">
			<description>Returns the index of the column coming before the given column</description>
			<arguments>
				<argument name="mx">
					<description>The index of the column</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Number</type>
			</returns>
		</method>
		<method name="insertColumnBefore">
			<description>Inserts a column before another column</description>
			<arguments>
				<argument name="x">
					<description>The index of the column to insert</description>
					<type>Number</type>
				</argument>
				<argument name="beforeX">
					<description>The index of the column to insert before</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="getColumnAt">
			<description>Returns the column at the x position. x is the distance from the left edge
 (if row headers visible left edge is to the left edge of the row headers</description>
			<arguments>
				<argument name="x">
					<description>The distance (in pixels) from the left edge.</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Number</type>
			</returns>
		</method>
		<method name="getColumnWidth">
			<description>This returns the width of the xth column</description>
			<arguments>
				<argument name="x">
					<description>The index of the column to get the width for</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Number</type>
			</returns>
		</method>
		<method name="setColumnWidth">
			<description>Sets the width of the xth column</description>
			<arguments>
				<argument name="x">
					<description>The index of the column to set the width for</description>
					<type>Number</type>
				</argument>
				<argument name="w">
					<description>The new width</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="getModelColumn">
			<description>Returns the column index in the data model for the visual column index</description>
			<arguments>
				<argument name="vx">
					<description>The visual column index</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Number</type>
			</returns>
		</method>
		<method name="getViewColumn">
			<description>Returns the visual column index for the index in the data model</description>
			<arguments>
				<argument name="mx">
					<description>The index in the data model</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Number</type>
			</returns>
		</method>
		<method name="getCellHeight">
			<description>Returns the row height for the row. For a<link class="BiTreeView">BiTreeView</link> this should be the same
 for all rows.</description>
			<arguments>
				<argument name="y">
					<description>The row to get the height for</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Number</type>
			</returns>
		</method>
		<method name="getCellWidth">
			<description>Returns the width for a column. (Same as getColumnWidth)</description>
			<arguments>
				<argument name="x">
					<description>The column to get the width for</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Number</type>
			</returns>
		</method>
		<method name="getRowBounds">
			<description>Returns the boundaries for the row. This returns an object with left, top width and height fields describing the boundaries.</description>
			<arguments>
				<argument name="y">
					<description>The index of the row</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Object</type>
			</returns>
		</method>
		<method name="getRowAt">
			<description>Returns the row at the y position. y is the distance from the upper edge in pixels</description>
			<arguments>
				<argument name="y">
					<description>The distance (in pixels) from the upper edge.</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Number</type>
			</returns>
		</method>
		<method name="rowCountChanged">
			<description>This is called when the row count changes.</description>
			<arguments>
				<argument name="nRow">
					<description>The row that change starts at</description>
					<type>Number</type>
				</argument>
				<argument name="nCount">
					<description>The rows that was added or removed</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="getCellBounds">
			<description>Returns the boundaries for the cell. This returns an object with left, top width and height fields describing the boundaries.</description>
			<arguments>
				<argument name="x">
					<description>The column index of the cell</description>
					<type>Number</type>
				</argument>
				<argument name="y">
					<description>The row index of the cell</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Object</type>
			</returns>
		</method>
		<method name="getHeaderBounds">
			<description>Returns the boundaries for the header. This returns an object with left, top width and height fields describing the boundaries.</description>
			<arguments>
				<argument name="x">
					<description>The column index of the header cell</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Object</type>
			</returns>
		</method>
	</methods>
	<properties>
		<property name="treeView" get="true" set="true">
			<description>The tree view this view manager is to be used with</description>
			<type>
				<link class="BiTreeView">BiTreeView</link>
			</type>
		</property>
		<property name="dataModel" get="true">
			<description>The data model that is used with the tree view</description>
			<type>
				<link class="BiTreeViewDataModel">BiTreeViewDataModel</link>
			</type>
		</property>
		<property name="showGridLines" get="true" set="true">
			<description>Whether to show grid lines between the cells in the tree view</description>
			<type>Boolean</type>
		</property>
		<property name="scrollLeft" set="true">
			<description>Sets the scroll left to the view manager so that the view manager can figure out what column to start at</description>
			<type>Number</type>
		</property>
		<property name="scrollTop" set="true">
			<description>Sets the scroll top to the view manager so that the view manager can figure out what row to start at</description>
			<type>Number</type>
		</property>
		<property name="columnCount" get="true">
			<description>The number of columns to show</description>
			<type>Number</type>
		</property>
		<property name="indentColumn" get="true" set="true">
			<description>The index of the column that should be indented. Use -1 to not show any
 indention</description>
			<type>Number</type>
		</property>
		<property name="highlightSortColumn" get="true" set="true">
			<description>Whether to highlight the background of the sorted column</description>
			<type>Boolean</type>
		</property>
		<property name="firstVisibleColumn" get="true">
			<description>The first visible column in the tree view viewport</description>
			<type>Number</type>
		</property>
		<property name="shownColumnsWidth" get="true">
			<description>This is the sum of all the column widths</description>
			<type>Number</type>
		</property>
		<property name="columnOrders" get="true" set="true">
			<description>The order of the columns in the visual representation</description>
			<type>Number[]</type>
		</property>
		<property name="rowHeight" get="true" set="true">
			<description>The height of a row in the tree view</description>
			<type>Number</type>
		</property>
		<property name="firstVisibleRow" get="true">
			<description>The first shown row in the viewport</description>
			<type>Number</type>
		</property>
		<property name="pageCount" get="true">
			<description>The number of rows shown in the viewport</description>
			<type>Number</type>
		</property>
		<property name="cellPaddingX" get="true">
			<description>This returns the amount of padding to take into account when sizing the cells This returns different values depending on the user agent.</description>
			<type>Number</type>
		</property>
		<property name="showHeaders" get="true" set="true">
			<description>Whether to show the headers</description>
			<type>Boolean</type>
		</property>
		<property name="headersHeight" get="true" set="true">
			<description>The height of the headers</description>
			<type>Number</type>
		</property>
		<property name="ascendingIcon" get="true" set="true">
			<description>The path to the arrow image to use for ascending sort</description>
			<type>String</type>
		</property>
		<property name="descendingIcon" get="true" set="true">
			<description>The path to the arrow image to use for descending sort</description>
			<type>String</type>
		</property>
		<property name="headerCellPaddingX" get="true">
			<description>This returns the amount of padding to take into account when sizing the header cells This returns different values depending on the user agent.</description>
			<type>Number</type>
		</property>
		<property name="showRowHeaders" get="true" set="true">
			<description>Whether to show the row headers</description>
			<type>Boolean</type>
		</property>
		<property name="rowHeadersWidth" get="true" set="true">
			<description>The width of the row headers</description>
			<type>Number</type>
		</property>
	</properties>
	<events>
	</events>
	<remarks>
	</remarks>
</class>