---
title: NodeFilter
slug: Web/API/NodeFilter
tags:
  - API
  - DOM
  - DOM Reference
  - NeedsTranslation
translation_of: Web/API/NodeFilter
---
<div>{{APIRef("DOM")}}</div>

<p><strong><code>NodeFilter</code></strong> 接口表示一个对象，此对象用于过滤 {{ domxref("NodeIterator") }} 或 {{ domxref("TreeWalker") }} 中的节点。它既不能处理 DOM，也不能遍历节点；它只能根据提供的过滤器对单个节点进行判定。</p>

<div class="note">
<p><strong>注意：</strong>浏览器不提供任何实现该接口的对象。用户需要自己编写该对象，根据需要自行定制 <code>acceptNode()</code> 方法，以用于{{domxref("TreeWalker")}} 或 {{domxref("NodeIterator")}} 对象。</p>
</div>

<h2 id="属性">属性</h2>

<p><em>此接口没有实现或继承任何属性。</em></p>

<h2 id="方法">方法</h2>

<p><em>此接口不继承任何方法。</em></p>

<dl>
 <dt>{{domxref("NodeFilter.acceptNode()")}}</dt>
 <dd>返回一个 <code>unsigned short</code>，用于表示提供的{{domxref("Node")}} 是否需要被{{ domxref("NodeIterator") }} 或 {{ domxref("TreeWalker") }} 迭代算法所接受。这个方法应由使用 <code>NodeFilter</code> 的用户编写。可能的值如下：
 <table class="standard-table">
  <tbody>
   <tr>
    <td class="header">常量</td>
    <td class="header">描述</td>
   </tr>
   <tr>
    <td><code>FILTER_ACCEPT</code></td>
    <td>当需要接受一个节点时，{{ domxref("NodeFilter.acceptNode()") }}返回该值。</td>
   </tr>
   <tr>
    <td><code>FILTER_REJECT</code></td>
    <td>当需要拒绝一个节点时，{{ domxref("NodeFilter.acceptNode()") }}返回该值。对于 {{ domxref("TreeWalker") }}，这个节点的子节点也会被拒绝。对于 {{ domxref("NodeIterator") }}，这个常量的表现与<code>FILTER_SKIP</code>一样。</td>
   </tr>
   <tr>
    <td><code>FILTER_SKIP</code></td>
    <td>当{{ domxref("NodeIterator") }} 或 {{ domxref("TreeWalker") }} 对象需要跳过一个节点时，{{ domxref("NodeFilter.acceptNode()") }}返回该值。但被跳过节点的子节点仍会被考虑，意即“跳过该节点但不包括其子节点”。</td>
   </tr>
  </tbody>
 </table>
 </dd>
</dl>

<h2 id="示例">示例</h2>

<pre class="brush: js">var nodeIterator = document.createNodeIterator(
  // 用作根节点的节点
  document.getElementById('someId'),

  // 只筛选文本节点（即节点类型3）
  NodeFilter.SHOW_TEXT,

  // 用作 NodeFilter 的对象，其中包含 acceptNode 方法
    { acceptNode: function(node) {
      // 接受、拒绝或跳过的逻辑
      // 下述例子只接受除了空格以外的内容
      if ( ! /^\s*$/.test(node.data) ) {
        return NodeFilter.FILTER_ACCEPT;
      }
    }
  },
  false
);

// 显示根节点下每个非空的文本节点
var node;

while ((node = nodeIterator.nextNode())) {
  alert(node.data);
}
</pre>

<h2 id="规范">规范</h2>

<table class="standard-table">
 <tbody>
  <tr>
   <th scope="col">规范</th>
   <th scope="col">状态</th>
   <th scope="col">备注</th>
  </tr>
  <tr>
   <td>{{SpecName('DOM WHATWG', '#interface-nodefilter', 'NodeFilter')}}</td>
   <td>{{Spec2('DOM WHATWG')}}</td>
   <td></td>
  </tr>
  <tr>
   <td>{{SpecName('DOM2 Traversal_Range', 'traversal.html#Traversal-NodeFilter', 'NodeFilter')}}</td>
   <td>{{Spec2('DOM2 Traversal_Range')}}</td>
   <td>Initial definition.</td>
  </tr>
 </tbody>
</table>

<h2 id="浏览器兼容性">浏览器兼容性</h2>



<p>{{Compat("api.NodeFilter")}}</p>

<h2 id="参见">参见</h2>

<ul>
 <li>相关接口：{{domxref("TreeWalker")}}、{{domxref("NodeIterator")}}。</li>
</ul>