📄 bitreeiterator.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>BiTreeIterator</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="BiTreeIterator">BiTreeIterator</h1>
<p>This class is used for iterating over rows and subtrees in a tree</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>BiTreeIterator</code>.</p>
<ul class="partial-class-tree">
<li><code><a href="BiObject.html">BiObject</a></code><ul>
<li><code>BiTreeIterator</code><ul id="api-derived-classes"></ul></li></ul>
</li>
</ul>
<h2>Constructor</h2>
<p><code>
new BiTreeIterator([<span class="methodArgument">oIterator</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>oIterator</code></td>
<td><code class="type">
<code><a href="BiTreeIterator.html">BiTreeIterator</a></code>
</code></td>
<td class="optional-column"><img src="check.png" alt="checked"></td>
<td></td>
<td>optional parameter. If provided then the new
iterator will be a copy of the old one</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="childIndex"></a><code>childIndex</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 child index of the item that the iterator is currently at</td>
</tr>
<tr>
<td><a name="depth"></a><code>depth</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 depth of the item the iterator is currently at</td>
</tr>
<tr>
<td><a name="node"></a><code>node</code></td>
<td><code class="type">Object</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"></td>
<td>The current node object</td>
</tr>
<tr>
<td><a name="parent"></a><code>parent</code></td>
<td><code class="type">
<code><a href="BiSubtree.html">BiSubtree</a></code>
</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"></td>
<td>the parent of the current item</td>
</tr>
<tr>
<td><a name="rowIndex"></a><code>rowIndex</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 row index that the iterator is currently at</td>
</tr>
<tr>
<td><a name="subtree"></a><code>subtree</code></td>
<td><code class="type">
<code><a href="BiSubtree.html">BiSubtree</a></code>
</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"></td>
<td>The current subtree</td>
</tr>
</tbody>
</table>
<h2>Methods</h2>
<table>
<thead>
<tr>
<td>Name</td>
<td>Description</td>
</tr>
</thead>
<tbody>
<tr>
<td><code><a href="#append">append</a></code></td>
<td>Descends into a subtree</td>
</tr>
<tr>
<td><code><a href="#next">next</a></code></td>
<td>this increments the iterator a step</td>
</tr>
<tr>
<td><code><a href="#pop">pop</a></code></td>
<td>Pops the iterator up one level</td>
</tr>
<tr>
<td><code><a href="#previous">previous</a></code></td>
<td>this decrements the iterator a step</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="append"></a>append</h3>
<p>Descends into a subtree</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.append(<span class="methodArgument">oSubtree</span>, <span class="methodArgument">nChildIndex</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>oSubtree</code></td>
<td><code class="type">
<code><a href="BiSubtree.html">BiSubtree</a></code>
</code></td>
<td class="optional-column"></td>
<td></td>
<td>The subtree to descend into</td>
</tr>
<tr>
<td><code>nChildIndex</code></td>
<td><code class="type">Number</code></td>
<td class="optional-column"></td>
<td></td>
<td>The child index of the current tree</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="next"></a>next</h3>
<p>this increments the iterator a step</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.next()</pre>
<h4>Parameters</h4>
<p>No arguments.</p>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="pop"></a>pop</h3>
<p>Pops the iterator up one level</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.pop()</pre>
<h4>Parameters</h4>
<p>No arguments.</p>
<h4>Return Type</h4>
<p><code class="type">
<code><a href="BiTreeIterator.html">BiTreeIterator</a></code>
</code></p>
<h3><a name="previous"></a>previous</h3>
<p>this decrements the iterator a step</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.previous()</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 + -