📄 bitreeview.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>BiTreeView</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="BiTreeView">BiTreeView</h1>
<p>This class is the base for <code><a href="BiGrid2.html">BiGrid2</a></code> and <code><a href="BiTree2.html">BiTree2.</a></code> It can be used directly
with a data model.</p>
<p>This class extends
<code><a href="BiComponent.html">BiComponent</a></code>
and therefore all methods and fields available for
<code><a href="BiComponent.html">BiComponent</a></code>
are also available for <code>BiTreeView</code>.</p>
<ul class="partial-class-tree">
<li><code><a href="BiObject.html">BiObject</a></code><ul>
<li><code><a href="BiEventTarget.html">BiEventTarget</a></code><ul><li><code><a href="BiComponent.html">BiComponent</a></code><ul><li><code>BiTreeView</code><ul id="api-derived-classes"><li><code><a href="BiGrid2.html">BiGrid2</a></code></li><li><code><a href="BiTree2.html">BiTree2</a></code></li></ul></li></ul></li></ul></li></ul>
</li>
</ul>
<h2>Constructor</h2>
<p><code>
new BiTreeView()</code></p>
<h3>Parameters</h3>
<p>No parameters.</p>
<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="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"><img src="check.png" alt="checked"></td>
<td>The data model describes the data to be shown in the tree</td>
</tr>
<tr>
<td><a name="scrollLeftExact"></a><code>scrollLeftExact</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 exact scroll position. scrollLeft on the other hand returns the scroll position where the first visible row starts at</td>
</tr>
<tr>
<td><a name="scrollTopExact"></a><code>scrollTopExact</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 exact scroll position. scrollTop on the other hand returns the scroll position where the first visible row starts at</td>
</tr>
<tr>
<td><a name="selectionModel"></a><code>selectionModel</code></td>
<td><code class="type">
<code><a href="BiTreeViewSelectionModel.html">BiTreeViewSelectionModel</a></code>
</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 selection model handling the selected rows in the tree</td>
</tr>
<tr>
<td><a name="viewManager"></a><code>viewManager</code></td>
<td><code class="type">
<code><a href="BiTreeViewViewManager.html">BiTreeViewViewManager</a></code>
</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 view manager handles visual aspects that are not directly related to the data model</td>
</tr>
</tbody>
</table>
<h2>Methods</h2>
<table>
<thead>
<tr>
<td>Name</td>
<td>Description</td>
</tr>
</thead>
<tbody>
<tr>
<td><code><a href="#getExpandIconHtml">getExpandIconHtml</a></code></td>
<td>this returns the HTML code for the expand icon</td>
</tr>
<tr>
<td><code><a href="#getHeaderHtmlCode">getHeaderHtmlCode</a></code></td>
<td>This returns the HTML code for header of the tree view</td>
</tr>
<tr>
<td><code><a href="#getHtmlCode">getHtmlCode</a></code></td>
<td>This returns the HTML code for the body of the tree view</td>
</tr>
<tr>
<td><code><a href="#getRowHeaderHtmlCode">getRowHeaderHtmlCode</a></code></td>
<td>This returns the HTML code for the row headers.</td>
</tr>
<tr>
<td><code><a href="#update">update</a></code></td>
<td>This updates the tree view</td>
</tr>
<tr>
<td><code><a href="#updateContentSize">updateContentSize</a></code></td>
<td>this is called when the size of the content has changed. This happens for
example when a row is added/removed and when subtrees are collapsed/expanded</td>
</tr>
<tr>
<td><code><a href="#updateSize">updateSize</a></code></td>
<td>this updates the sizes of different parts of the sub controls</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="getExpandIconHtml"></a>getExpandIconHtml</h3>
<p>this returns the HTML code for the expand icon</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getExpandIconHtml(<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</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</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">String</code></p>
<h3><a name="getHeaderHtmlCode"></a>getHeaderHtmlCode</h3>
<p>This returns the HTML code for header of the tree view</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getHeaderHtmlCode(<span class="methodArgument">nScrollLeft</span>, <span class="methodArgument">nWidth</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>nScrollLeft</code></td>
<td><code class="type">Number</code></td>
<td class="optional-column"></td>
<td></td>
<td>The distance from the left to start painting at</td>
</tr>
<tr>
<td><code>nWidth</code></td>
<td><code class="type">Number</code></td>
<td class="optional-column"></td>
<td></td>
<td>The width of the viewport</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">String</code></p>
<h3><a name="getHtmlCode"></a>getHtmlCode</h3>
<p>This returns the HTML code for the body of the tree view</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getHtmlCode(<span class="methodArgument">nScrollLeft</span>, <span class="methodArgument">nScrollTop</span>, <span class="methodArgument">nWidth</span>, <span class="methodArgument">nHeight</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>nScrollLeft</code></td>
<td><code class="type">Number</code></td>
<td class="optional-column"></td>
<td></td>
<td>the distance from the left to start painting at</td>
</tr>
<tr>
<td><code>nScrollTop</code></td>
<td><code class="type">Number</code></td>
<td class="optional-column"></td>
<td></td>
<td>the distance from the top to start painting at</td>
</tr>
<tr>
<td><code>nWidth</code></td>
<td><code class="type">Number</code></td>
<td class="optional-column"></td>
<td></td>
<td>the width of the viewport</td>
</tr>
<tr>
<td><code>nHeight</code></td>
<td><code class="type">Number</code></td>
<td class="optional-column"></td>
<td></td>
<td>the height of the viewport</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">String</code></p>
<h3><a name="getRowHeaderHtmlCode"></a>getRowHeaderHtmlCode</h3>
<p>This returns the HTML code for the row headers.</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getRowHeaderHtmlCode(<span class="methodArgument">nScrollTop</span>, <span class="methodArgument">nHeight</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>nScrollTop</code></td>
<td><code class="type">Number</code></td>
<td class="optional-column"></td>
<td></td>
<td>The distance from the top to start painting at</td>
</tr>
<tr>
<td><code>nHeight</code></td>
<td><code class="type">Number</code></td>
<td class="optional-column"></td>
<td></td>
<td>The height of the viewport</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">String</code></p>
<h3><a name="update"></a>update</h3>
<p>This updates the tree view</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.update()</pre>
<h4>Parameters</h4>
<p>No arguments.</p>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="updateContentSize"></a>updateContentSize</h3>
<p>this is called when the size of the content has changed. This happens for
example when a row is added/removed and when subtrees are collapsed/expanded</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.updateContentSize()</pre>
<h4>Parameters</h4>
<p>No arguments.</p>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="updateSize"></a>updateSize</h3>
<p>this updates the sizes of different parts of the sub controls</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.updateSize()</pre>
<h4>Parameters</h4>
<p>No arguments.</p>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
</body>
</html>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -