?? bitreeviewviewmanager.html
字號:
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"><html><!--
Generated using api.website.xsl version 2003-07-17
-->
<head>
<META http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>BiTreeViewViewManager</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link type="text/css" rel="stylesheet" href="api.css"><script type="text/javascript">
function showDerivedClasses() {
var ul = document.getElementById("api-derived-classes");
var lis = ul.childNodes;
var l = lis.length;
for (var i = 1; i < l; i++)
lis[i].style.display = "";
lis[0].style.display = "none";
}
</script></head>
<body>
<h1 id="BiTreeViewViewManager">BiTreeViewViewManager</h1>
<p>This class handles the visual properties of a <code><a href="BiTreeView.html">BiTreeView</a></code>
</p>
<p>This class extends
<code><a href="BiObject.html">BiObject</a></code>
and therefore all methods and fields available for
<code><a href="BiObject.html">BiObject</a></code>
are also available for <code>BiTreeViewViewManager</code>.</p>
<ul class="partial-class-tree">
<li><code><a href="BiObject.html">BiObject</a></code><ul>
<li><code>BiTreeViewViewManager</code><ul id="api-derived-classes"><li><code><a href="BiGrid2ViewManager.html">BiGrid2ViewManager</a></code></li><li><code><a href="BiTree2ViewManager.html">BiTree2ViewManager</a></code></li></ul></li></ul>
</li>
</ul>
<h2>Constructor</h2>
<p><code>
new BiTreeViewViewManager(<span class="methodArgument">oTreeView</span>)</code></p>
<h3>Parameters</h3>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>oTreeView</code></td>
<td><code class="type">
<code><a href="BiTreeView.html">BiTreeView</a></code>
</code></td>
<td class="optional-column"></td>
<td></td>
<td>The tree view this view manager is to be
used with</td>
</tr>
</tbody>
</table>
<h2>Properties</h2>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="get-header">get</td>
<td class="set-header">set</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><a name="ascendingIcon"></a><code>ascendingIcon</code></td>
<td><code class="type">Number</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"></td>
<td>The path to the arrow image to use for ascending sort</td>
</tr>
<tr>
<td><a name="cellPaddingX"></a><code>cellPaddingX</code></td>
<td><code class="type">Number</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"></td>
<td>This returns the amount of padding to take into account when sizing the cells This returns different values depending on the user agent.</td>
</tr>
<tr>
<td><a name="columnCount"></a><code>columnCount</code></td>
<td><code class="type">Number</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"></td>
<td>The number of columns to show</td>
</tr>
<tr>
<td><a name="columnOrders"></a><code>columnOrders</code></td>
<td><code class="type">Number[]</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"><img src="check.png" alt="checked"></td>
<td>The order of the columns in the visual representation</td>
</tr>
<tr>
<td><a name="dataModel"></a><code>dataModel</code></td>
<td><code class="type">
<code><a href="BiTreeViewDataModel.html">BiTreeViewDataModel</a></code>
</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"></td>
<td>The data model that is used with the tree view</td>
</tr>
<tr>
<td><a name="descendingIcon"></a><code>descendingIcon</code></td>
<td><code class="type">Number</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"></td>
<td>The path to the arrow image to use for descending sort</td>
</tr>
<tr>
<td><a name="firstVisibleColumn"></a><code>firstVisibleColumn</code></td>
<td><code class="type">Number</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"></td>
<td>The first visible column in the tree view viewport</td>
</tr>
<tr>
<td><a name="firstVisibleRow"></a><code>firstVisibleRow</code></td>
<td><code class="type">Number</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"></td>
<td>The first shown row in the viewport</td>
</tr>
<tr>
<td><a name="headerCellPaddingX"></a><code>headerCellPaddingX</code></td>
<td><code class="type">Number</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"></td>
<td>This returns the amount of padding to take into account when sizing the header cells This returns different values depending on the user agent.</td>
</tr>
<tr>
<td><a name="headersHeight"></a><code>headersHeight</code></td>
<td><code class="type">Number</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"></td>
<td>The height of the headers</td>
</tr>
<tr>
<td><a name="highlightSortColumn"></a><code>highlightSortColumn</code></td>
<td><code class="type">Boolean</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"></td>
<td>Whether to highlight the background of the sorted column</td>
</tr>
<tr>
<td><a name="indentColumn"></a><code>indentColumn</code></td>
<td><code class="type">Number</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"></td>
<td>The index of the column that should be indented. Use -1 to not show any indention</td>
</tr>
<tr>
<td><a name="pageCount"></a><code>pageCount</code></td>
<td><code class="type">Number</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"></td>
<td>The number of rows shown in the viewport</td>
</tr>
<tr>
<td><a name="rowHeadersWidth"></a><code>rowHeadersWidth</code></td>
<td><code class="type">Number</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"></td>
<td>The width of the row headers</td>
</tr>
<tr>
<td><a name="rowHeight"></a><code>rowHeight</code></td>
<td><code class="type">Number</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"></td>
<td>The height of a row in the tree view</td>
</tr>
<tr>
<td><a name="scrollLeft"></a><code>scrollLeft</code></td>
<td><code class="type">Number</code></td>
<td class="get-column"></td>
<td class="set-column"><img src="check.png" alt="checked"></td>
<td>Sets the scroll left to the view manager so that the view manager can figure out what column to start at</td>
</tr>
<tr>
<td><a name="scrollTop"></a><code>scrollTop</code></td>
<td><code class="type">Number</code></td>
<td class="get-column"></td>
<td class="set-column"><img src="check.png" alt="checked"></td>
<td>Sets the scroll top to the view manager so that the view manager can figure out what row to start at</td>
</tr>
<tr>
<td><a name="showGridLines"></a><code>showGridLines</code></td>
<td><code class="type">Boolean</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"></td>
<td>Whether to show grid lines between the cells in the tree view</td>
</tr>
<tr>
<td><a name="showHeaders"></a><code>showHeaders</code></td>
<td><code class="type">Boolean</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"></td>
<td>Whether to show the headers</td>
</tr>
<tr>
<td><a name="shownColumnsWidth"></a><code>shownColumnsWidth</code></td>
<td><code class="type">Number</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"></td>
<td>This is the sum of all the column widths</td>
</tr>
<tr>
<td><a name="showRowHeaders"></a><code>showRowHeaders</code></td>
<td><code class="type">Boolean</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"></td>
<td>Whether to show the row headers</td>
</tr>
<tr>
<td><a name="treeView"></a><code>treeView</code></td>
<td><code class="type">
<code><a href="BiTreeView.html">BiTreeView</a></code>
</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"></td>
<td>The tree view this view manager is to be used with</td>
</tr>
</tbody>
</table>
<h2>Methods</h2>
<table>
<thead>
<tr>
<td>Name</td>
<td>Description</td>
</tr>
</thead>
<tbody>
<tr>
<td><code><a href="#getCanResizeColumn">getCanResizeColumn</a></code></td>
<td>Whether the column at x can be resize</td>
</tr>
<tr>
<td><code><a href="#getCellBounds">getCellBounds</a></code></td>
<td>Returns the boundaries for the cell. This returns an object with left, top width and height fields describing the boundaries.</td>
</tr>
<tr>
<td><code><a href="#getColumnAt">getColumnAt</a></code></td>
<td>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</td>
</tr>
<tr>
<td><code><a href="#getColumnBounds">getColumnBounds</a></code></td>
<td>Returns the boundaries for the column. This returns an object with left, top width and height fields describing the boundaries.</td>
</tr>
<tr>
<td><code><a href="#getColumnLeft">getColumnLeft</a></code></td>
<td>Returns the left position for the column.</td>
</tr>
<tr>
<td><code><a href="#getColumnWidth">getColumnWidth</a></code></td>
<td>This returns the width of the xth column</td>
</tr>
<tr>
<td><code><a href="#getHeaderBounds">getHeaderBounds</a></code></td>
<td>Returns the boundaries for the header. This returns an object with left, top width and height fields describing the boundaries.</td>
</tr>
<tr>
<td><code><a href="#getModelColumn">getModelColumn</a></code></td>
<td>Returns the column index in the data model for the visual column index</td>
</tr>
<tr>
<td><code><a href="#getNextColumn">getNextColumn</a></code></td>
<td>Returns the index of the column coming after the given column</td>
</tr>
<tr>
<td><code><a href="#getPreviousColumn">getPreviousColumn</a></code></td>
<td>Returns the index of the column coming before the given column</td>
</tr>
<tr>
<td><code><a href="#getRowAt">getRowAt</a></code></td>
<td>Returns the row at the y position. y is the distance from the upper edge</td>
</tr>
<tr>
<td><code><a href="#getRowBounds">getRowBounds</a></code></td>
<td>Returns the boundaries for the row. This returns an object with left, top width and height fields describing the boundaries.</td>
</tr>
<tr>
<td><code><a href="#getViewColumn">getViewColumn</a></code></td>
<td>Returns the visual column index for the index in the data model</td>
</tr>
<tr>
<td><code><a href="#insertColumnBefore">insertColumnBefore</a></code></td>
<td>Inserts a column before another column</td>
</tr>
<tr>
<td><code><a href="#resetCache">resetCache</a></code></td>
<td>resets the cached properties. This is called after the columns are changed</td>
</tr>
<tr>
<td><code><a href="#rowCountChanged">rowCountChanged</a></code></td>
<td>This is called when the row count changes.</td>
</tr>
<tr>
<td><code><a href="#scrollCellIntoView">scrollCellIntoView</a></code></td>
<td>Scrolls the tree view so that the given cell becomes visible</td>
</tr>
<tr>
<td><code><a href="#scrollColumnIntoView">scrollColumnIntoView</a></code></td>
<td>Scrolls the tree view so that the given column becomes visible</td>
</tr>
<tr>
<td><code><a href="#scrollRowIntoView">scrollRowIntoView</a></code></td>
<td>Scrolls the tree view so that the given row becomes visible</td>
</tr>
<tr>
<td><code><a href="#scrollSubtreeIntoView">scrollSubtreeIntoView</a></code></td>
<td>Scrolls a subtree into view (if possible)</td>
</tr>
<tr>
<td><code><a href="#setColumnWidth">setColumnWidth</a></code></td>
<td>Sets the width of the xth column</td>
</tr>
</tbody>
</table>
<h2>Events</h2>
<p>None.</p>
<h2>Static Methods</h2>
<p>None.</p>
<h2>Static Fields</h2>
<p>None.</p>
<h2>Remarks</h2>
<p>None.</p>
<h2>Method Details</h2>
<h3><a name="getCanResizeColumn"></a>getCanResizeColumn</h3>
<p>Whether the column at x can be resize</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getCanResizeColumn(<span class="methodArgument">x</span>)</pre>
<h4>Parameters</h4>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>x</code></td>
<td><code class="type">Number</code></td>
<td class="optional-column"></td>
<td></td>
<td>The index of the column</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">Boolean</code></p>
<h3><a name="getCellBounds"></a>getCellBounds</h3>
<p>Returns the boundaries for the cell. This returns an object with left, top width and height fields describing the boundaries.</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getCellBounds(<span class="methodArgument">x</span>, <span class="methodArgument">y</span>)</pre>
<h4>Parameters</h4>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>x</code></td>
<td><code class="type">Number</code></td>
<td class="optional-column"></td>
<td></td>
<td>The column index of the cell</td>
</tr>
<tr>
<td><code>y</code></td>
<td><code class="type">Number</code></td>
<td class="optional-column"></td>
<td></td>
<td>The row index of the cell</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">Object</code></p>
<h3><a name="getColumnAt"></a>getColumnAt</h3>
<p>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</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getColumnAt(<span class="methodArgument">x</span>)</pre>
<h4>Parameters</h4>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>x</code></td>
<td><code class="type">Number</code></td>
<td class="optional-column"></td>
<td></td>
<td>The distance (in pixels) from the left edge.</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">Number</code></p>
<h3><a name="getColumnBounds"></a>getColumnBounds</h3>
<p>Returns the boundaries for the column. This returns an object with left, top width and height fields describing the boundaries.</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getColumnBounds(<span class="methodArgument">x</span>)</pre>
<h4>Parameters</h4>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>x</code></td>
<td><code class="type">Number</code></td>
<td class="optional-column"></td>
<td></td>
<td>The index of the column</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">Object</code></p>
<h3><a name="getColumnLeft"></a>getColumnLeft</h3>
<p>Returns the left position for the column.</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getColumnLeft(<span class="methodArgument">x</span>)</pre>
<h4>Parameters</h4>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
?? 快捷鍵說明
復制代碼
Ctrl + C
搜索代碼
Ctrl + F
全屏模式
F11
切換主題
Ctrl + Shift + D
顯示快捷鍵
?
增大字號
Ctrl + =
減小字號
Ctrl + -