Module java.xml

Package org.w3c.dom.traversal

Interface DocumentTraversal

       public interface DocumentTraversal
      

DocumentTraversal 包含创建 NodeIterators 和 TreeWalkers 的方法，用于按文档顺序（深度优先，前序遍历，等同于文档的文本表示中开始标签出现的顺序）遍历节点及其子节点。在支持遍历功能的DOM中，DocumentTraversal 将由实现 Document 接口的相同对象实现。

另请参阅 文档对象模型（DOM）Level 2 遍历和范围规范。

自从:

9, DOM Level 2

Method Summary

Modifier and Type	Method	Description
NodeIterator	createNodeIterator(Node root, int whatToShow, NodeFilter filter, boolean entityReferenceExpansion)	在指定节点为根的子树上创建一个新的 NodeIterator。
TreeWalker	createTreeWalker(Node root, int whatToShow, NodeFilter filter, boolean entityReferenceExpansion)	在指定节点为根的子树上创建一个新的 TreeWalker。

Method Details

createNodeIterator

             NodeIterator createNodeIterator(Node root, int whatToShow, NodeFilter filter, boolean entityReferenceExpansion) throws DOMException
            

在指定节点为根的子树上创建一个新的 NodeIterator。

参数:

root - 将与其子节点一起迭代的节点。 NodeIterator 最初定位在此节点之前。 设置此位置时不考虑 whatToShow 标志和过滤器（如果有）。 根节点不得为 null。

whatToShow - 此标志指定可能出现在 NodeIterator 展示的树的逻辑视图中的节点类型。 有关可能的 SHOW_ 值集的描述，请参阅 NodeFilter 的说明。 这些标志可以使用 OR 组合。

filter - 用于此 NodeIterator 的 NodeFilter，或 null 表示无过滤器。

entityReferenceExpansion - 此标志的值确定是否展开实体引用节点。

返回:

新创建的 NodeIterator。

抛出:

DOMException - NOT_SUPPORTED_ERR: 如果指定的 root 为 null，则引发异常。

createTreeWalker

             TreeWalker createTreeWalker(Node root, int whatToShow, NodeFilter filter, boolean entityReferenceExpansion) throws DOMException
            

在指定节点为根的子树上创建一个新的 TreeWalker。

参数:

root - 将作为 TreeWalker 的 root 的节点。 设置此值时不考虑 whatToShow 标志和 NodeFilter；任何节点类型都将被接受为 root。 TreeWalker 的 currentNode 初始化为此节点，无论其是否可见。 root 作为向上查找文档结构的遍历方法的停止点，例如 parentNode 和 nextNode。 根节点不得为 null。

whatToShow - 此标志指定可能出现在 TreeWalker 展示的树的逻辑视图中的节点类型。 有关可能的 SHOW_ 值集的描述，请参阅 NodeFilter 的说明。 这些标志可以使用 OR 组合。

filter - 用于此 TreeWalker 的 NodeFilter，或 null 表示无过滤器。

entityReferenceExpansion - 如果此标志为 false，则不会在逻辑视图中呈现 EntityReference 节点的内容。

返回:

新创建的 TreeWalker。

抛出:

DOMException - NOT_SUPPORTED_ERR: 如果指定的 root 为 null，则引发异常。