112 lines
14 KiB
HTML
112 lines
14 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en"><!-- use theme color or fallback -->
|
||
<!--use textcolor from settings, otherwise create a contrasting color to theme color-->
|
||
<head><meta charset="utf-8"/><link href="../../bootstrap/css/bootstrap.min.css" rel="stylesheet"/><link href="../../bootstrap/css/bootstrap-responsive.min.css" rel="stylesheet"/><link href="../../bootstrap/css/bootstrap-select.min.css" rel="stylesheet"/><link href="http://fonts.googleapis.com/css?family=Open+Sans:400,700,700italic,400italic" rel="stylesheet" type="text/css"/><link href="http://fonts.googleapis.com/css?family=Source+Sans+Pro:200,600,600italic,400" rel="stylesheet" type="text/css"/><link href="http://netdna.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.css" rel="stylesheet" type="text/css"/><script src="../../jquery-1.9.1.min.js"></script><script src="../../bootstrap/js/bootstrap.min.js"></script><script src="../../bootstrap/js/bootstrap-select.min.js"></script><link href="../../styles.css" rel="stylesheet"/><link href="../../haxe-nav.css" rel="stylesheet"/><script type="text/javascript">var dox = {rootPath: "../../",platforms: ["Neko","Android","Flash","iOS","macOS","Linux","HTML5","Windows"]};</script><script type="text/javascript" src="../../nav.js"></script><script type="text/javascript" src="../../index.js"></script><link rel="icon" href="../../favicon.ico" type="image/x-icon"></link><title>js.html.TreeWalker - API Reference</title><meta name="description" content="The <code><a href="../../js/html/TreeWalker.html">TreeWalker</a></code> object represents the nodes of a document subtree and a position within them."/></head><body><style>
|
||
a, code .type {
|
||
color: #24afc4;
|
||
}
|
||
.navbar .brand {
|
||
display: inline-block;
|
||
float: none;
|
||
text-shadow: 0 0 0 transparent;
|
||
}
|
||
.nav-list>.active>a.treeLink, .nav-list>.active>a.treeLink:hover, .nav-list>.active>a.treeLink:focus {
|
||
background: #24afc4;
|
||
color: #ffffff;
|
||
text-shadow: 0 0 0 transparent;
|
||
}
|
||
.navbar .container {
|
||
width: 940px ;
|
||
}
|
||
@media (max-width: 767px) {
|
||
.navbar .container {
|
||
width: auto;
|
||
}
|
||
}
|
||
@media (max-width: 979px) and (min-width: 768px) {
|
||
.navbar .container {
|
||
width: 724px;
|
||
}
|
||
}
|
||
@media (min-width: 1200px) {
|
||
.navbar .container {
|
||
width: 1170px;
|
||
}
|
||
}
|
||
.navbar .container img {
|
||
margin: 5px 0 0 4px;
|
||
}
|
||
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#FAFAFA; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" href="http://www.openfl.org"><img alt="" src="http://www.openfl.org/images/logo.png"/></a><a class="brand" style="color:#777777" href="../../">API Reference</a></div></div></div></nav><div class="container main-content"><div class="row-fluid"><div class="span3"><div class="well sidebar-nav"><form class="form-search" id="searchForm"><div class="input-prepend input-block-level"><span class="add-on"><i class="icon-search"></i></span><input id="search" type="text" placeholder="Search" autocomplete="off"/></div></form><div class="dropdown"><select id="select-platform" class="selectpicker" title="Filter by platform" data-width="100%"><option value="all" selected="true">All Platforms</option><option>Neko</option><option>Android</option><option>Flash</option><option>iOS</option><option>macOS</option><option>Linux</option><option>HTML5</option><option>Windows</option></select></div></div><div class="well sidebar-nav"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>class</small> TreeWalker</h1><h4><small>package <a href="../../js/html/index.html">js.html</a></small></h4> <p class="availability"><hr/><em>Available on HTML5</em></p></div><div class="body"><div class="doc doc-main"><div class="indent"><p>The <code><a href="../../js/html/TreeWalker.html">TreeWalker</a></code> object represents the nodes of a document subtree and a position within them.</p>
|
||
<p>Documentation <a href="https://developer.mozilla.org/en-US/docs/Web/API/TreeWalker">TreeWalker</a> by <a href="https://developer.mozilla.org/en-US/docs/Web/API/TreeWalker$history">Mozilla Contributors</a>, licensed under <a href="https://creativecommons.org/licenses/by-sa/2.5/">CC-BY-SA 2.5</a>.</p><p class="javadoc">See:</p><div class="indent inline-content"><p><a href="https://developer.mozilla.org/en-US/docs/Web/API/TreeWalker">https://developer.mozilla.org/en-US/docs/Web/API/TreeWalker</a></p></div></div></div><h3 class="section">Variables</h3><div class="fields"><div class="field "><a name="currentNode"></a><h3><p><code><a href="../../js/html/TreeWalker.html#currentNode"><span class="identifier">currentNode</span></a>:<a class="type" title="A Node is an interface from which a number of DOM types inherit, and allows these various types to be treated (or tested) similarly." href="../../js/html/Node.html">Node</a></code></p></h3><div class="doc"><p>Is the <code><a href="../../js/html/Node.html">Node</a></code> on which the <code><a href="../../js/html/TreeWalker.html">TreeWalker</a></code> is currently pointing at.</p></div></div><div class="field "><a name="filter"></a><h3><p><code><span class="label">read only</span><a href="../../js/html/TreeWalker.html#filter"><span class="identifier">filter</span></a>:<a class="type" title="A NodeFilter interface represents an object used to filter the nodes in a NodeIterator or TreeWalker." href="../../js/html/NodeFilter.html">NodeFilter</a></code></p></h3><div class="doc"><p>Returns a <code><a href="../../js/html/NodeFilter.html">NodeFilter</a></code> used to select the relevant nodes.</p></div></div><div class="field "><a name="root"></a><h3><p><code><span class="label">read only</span><a href="../../js/html/TreeWalker.html#root"><span class="identifier">root</span></a>:<a class="type" title="A Node is an interface from which a number of DOM types inherit, and allows these various types to be treated (or tested) similarly." href="../../js/html/Node.html">Node</a></code></p></h3><div class="doc"><p>Returns a <code><a href="../../js/html/Node.html">Node</a></code> representing the root node as specified when the <code><a href="../../js/html/TreeWalker.html">TreeWalker</a></code> was created.</p></div></div><div class="field "><a name="whatToShow"></a><h3><p><code><span class="label">read only</span><a href="../../js/html/TreeWalker.html#whatToShow"><span class="identifier">whatToShow</span></a>:<a class="type" title="The standard Int type." href="../../Int.html">Int</a></code></p></h3><div class="doc"><p>Returns an <code>unsigned long</code> being a bitmask made of constants describing the types of <code>Node</code> that must to be presented. Non-matching nodes are skipped, but their children may be included, if relevant. The possible values are:
|
||
<table class="standard-table"></p>
|
||
<p><tr>
|
||
<td class="header">Constant</td>
|
||
<td class="header">Numerical value</td>
|
||
<td class="header">Description</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>NodeFilter.SHOW_ALL</code></td>
|
||
<td><code>-1</code> (that is the max value of <code>unsigned long</code>)</td>
|
||
<td>Shows all nodes.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>NodeFilter.SHOW_ATTRIBUTE</code> {{deprecated_inline}}</td>
|
||
<td><code>2</code></td>
|
||
<td>Shows attribute <code>Attr</code> nodes. This is meaningful only when creating a <code>TreeWalker</code> with an <code>Attr</code> node as its root; in this case, it means that the attribute node will appear in the first position of the iteration or traversal. Since attributes are never children of other nodes, they do not appear when traversing over the document tree.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>NodeFilter.SHOW_CDATA_SECTION</code> {{deprecated_inline}}</td>
|
||
<td><code>8</code></td>
|
||
<td>Shows <code>CDATASection</code> nodes.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>NodeFilter.SHOW_COMMENT</code></td>
|
||
<td><code>128</code></td>
|
||
<td>Shows <code>Comment</code> nodes.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>NodeFilter.SHOW_DOCUMENT</code></td>
|
||
<td><code>256</code></td>
|
||
<td>Shows <code>Document</code> nodes.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>NodeFilter.SHOW_DOCUMENT_FRAGMENT</code></td>
|
||
<td><code>1024</code></td>
|
||
<td>Shows <code>DocumentFragment</code> nodes.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>NodeFilter.SHOW_DOCUMENT_TYPE</code></td>
|
||
<td><code>512</code></td>
|
||
<td>Shows <code>DocumentType</code> nodes.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>NodeFilter.SHOW_ELEMENT</code></td>
|
||
<td><code>1</code></td>
|
||
<td>Shows <code>Element</code> nodes.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>NodeFilter.SHOW_ENTITY</code> {{deprecated_inline}}</td>
|
||
<td><code>32</code></td>
|
||
<td>Shows <code>Entity</code> nodes. This is meaningful only when creating a <code>TreeWalker</code> with an <code>Entity</code> node as its root; in this case, it means that the <code>Entity</code> node will appear in the first position of the traversal. Since entities are not part of the document tree, they do not appear when traversing over the document tree.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>NodeFilter.SHOW_ENTITY_REFERENCE</code> {{deprecated_inline}}</td>
|
||
<td><code>16</code></td>
|
||
<td>Shows <code>EntityReference</code> nodes.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>NodeFilter.SHOW_NOTATION</code> {{deprecated_inline}}</td>
|
||
<td><code>2048</code></td>
|
||
<td>Shows <code>Notation</code> nodes. This is meaningful only when creating a <code>TreeWalker</code> with a <code>Notation</code> node as its root; in this case, it means that the <code>Notation</code> node will appear in the first position of the traversal. Since entities are not part of the document tree, they do not appear when traversing over the document tree.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>NodeFilter.SHOW_PROCESSING_INSTRUCTION</code></td>
|
||
<td><code>64</code></td>
|
||
<td>Shows <code>ProcessingInstruction</code> nodes.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>NodeFilter.SHOW_TEXT</code></td>
|
||
<td><code>4</code></td>
|
||
<td>Shows <code>Text</code> nodes.</td>
|
||
</tr></p>
|
||
<p></table></p></div></div></div><h3 class="section">Methods</h3><div class="fields"><div class="field "><a name="firstChild"></a><h3><p><code><a href="#firstChild"><span class="identifier">firstChild</span></a> ():<a class="type" title="A Node is an interface from which a number of DOM types inherit, and allows these various types to be treated (or tested) similarly." href="../../js/html/Node.html">Node</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div><div class="field "><a name="lastChild"></a><h3><p><code><a href="#lastChild"><span class="identifier">lastChild</span></a> ():<a class="type" title="A Node is an interface from which a number of DOM types inherit, and allows these various types to be treated (or tested) similarly." href="../../js/html/Node.html">Node</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div><div class="field "><a name="nextNode"></a><h3><p><code><a href="#nextNode"><span class="identifier">nextNode</span></a> ():<a class="type" title="A Node is an interface from which a number of DOM types inherit, and allows these various types to be treated (or tested) similarly." href="../../js/html/Node.html">Node</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div><div class="field "><a name="nextSibling"></a><h3><p><code><a href="#nextSibling"><span class="identifier">nextSibling</span></a> ():<a class="type" title="A Node is an interface from which a number of DOM types inherit, and allows these various types to be treated (or tested) similarly." href="../../js/html/Node.html">Node</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div><div class="field "><a name="parentNode"></a><h3><p><code><a href="#parentNode"><span class="identifier">parentNode</span></a> ():<a class="type" title="A Node is an interface from which a number of DOM types inherit, and allows these various types to be treated (or tested) similarly." href="../../js/html/Node.html">Node</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div><div class="field "><a name="previousNode"></a><h3><p><code><a href="#previousNode"><span class="identifier">previousNode</span></a> ():<a class="type" title="A Node is an interface from which a number of DOM types inherit, and allows these various types to be treated (or tested) similarly." href="../../js/html/Node.html">Node</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div><div class="field "><a name="previousSibling"></a><h3><p><code><a href="#previousSibling"><span class="identifier">previousSibling</span></a> ():<a class="type" title="A Node is an interface from which a number of DOM types inherit, and allows these various types to be treated (or tested) similarly." href="../../js/html/Node.html">Node</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div></div></div></div></div></div><footer class="section site-footer" style="background:#FAFAFA"><div class="container"><div class="copyright"><p style="color:#777777">© 2017 <a style="color:#777777" href="http://www.openfl.org">http://www.openfl.org</a></p></div></div></footer><script src="../..//highlighter.js"></script><link href="../../highlighter.css" rel="stylesheet"/></body></html> |