+++ /dev/null
-/*\r
- * Copyright (c) 2000 World Wide Web Consortium,\r
- * (Massachusetts Institute of Technology, Institut National de\r
- * Recherche en Informatique et en Automatique, Keio University). All\r
- * Rights Reserved. This program is distributed under the W3C's Software\r
- * Intellectual Property License. This program is distributed in the\r
- * hope that it will be useful, but WITHOUT ANY WARRANTY; without even\r
- * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR\r
- * PURPOSE.\r
- * See W3C License http://www.w3.org/Consortium/Legal/ for more details.\r
- */\r
-\r
-package org.w3c.dom.traversal;\r
-\r
-import org.w3c.dom.Node;\r
-import org.w3c.dom.DOMException;\r
-\r
-/**\r
- * <code>DocumentTraversal</code> contains methods that create iterators and \r
- * tree-walkers to traverse a node and its children in document order (depth \r
- * first, pre-order traversal, which is equivalent to the order in which the \r
- * start tags occur in the text representation of the document). In DOMs \r
- * which support the Traversal feature, <code>DocumentTraversal</code> will \r
- * be implemented by the same objects that implement the Document interface.\r
- * <p>See also the <a href='http://www.w3.org/TR/2000/REC-DOM-Level-2-Traversal-Range-20001113'>Document Object Model (DOM) Level 2 Traversal and Range Specification</a>.\r
- * @since DOM Level 2\r
- */\r
-public interface DocumentTraversal {\r
- /**\r
- * Create a new <code>NodeIterator</code> over the subtree rooted at the \r
- * specified node.\r
- * @param rootThe node which will be iterated together with its children. \r
- * The iterator is initially positioned just before this node. The \r
- * <code>whatToShow</code> flags and the filter, if any, are not \r
- * considered when setting this position. The root must not be \r
- * <code>null</code>.\r
- * @param whatToShowThis flag specifies which node types may appear in \r
- * the logical view of the tree presented by the iterator. See the \r
- * description of <code>NodeFilter</code> for the set of possible \r
- * <code>SHOW_</code> values.These flags can be combined using \r
- * <code>OR</code>.\r
- * @param filterThe <code>NodeFilter</code> to be used with this \r
- * <code>TreeWalker</code>, or <code>null</code> to indicate no filter.\r
- * @param entityReferenceExpansionThe value of this flag determines \r
- * whether entity reference nodes are expanded.\r
- * @return The newly created <code>NodeIterator</code>.\r
- * @exception DOMException\r
- * NOT_SUPPORTED_ERR: Raised if the specified <code>root</code> is \r
- * <code>null</code>.\r
- */\r
- public NodeIterator createNodeIterator(Node root, \r
- int whatToShow, \r
- NodeFilter filter, \r
- boolean entityReferenceExpansion)\r
- throws DOMException;\r
-\r
- /**\r
- * Create a new <code>TreeWalker</code> over the subtree rooted at the \r
- * specified node.\r
- * @param rootThe node which will serve as the <code>root</code> for the \r
- * <code>TreeWalker</code>. The <code>whatToShow</code> flags and the \r
- * <code>NodeFilter</code> are not considered when setting this value; \r
- * any node type will be accepted as the <code>root</code>. The \r
- * <code>currentNode</code> of the <code>TreeWalker</code> is \r
- * initialized to this node, whether or not it is visible. The \r
- * <code>root</code> functions as a stopping point for traversal \r
- * methods that look upward in the document structure, such as \r
- * <code>parentNode</code> and nextNode. The <code>root</code> must \r
- * not be <code>null</code>.\r
- * @param whatToShowThis flag specifies which node types may appear in \r
- * the logical view of the tree presented by the tree-walker. See the \r
- * description of <code>NodeFilter</code> for the set of possible \r
- * SHOW_ values.These flags can be combined using <code>OR</code>.\r
- * @param filterThe <code>NodeFilter</code> to be used with this \r
- * <code>TreeWalker</code>, or <code>null</code> to indicate no filter.\r
- * @param entityReferenceExpansionIf this flag is false, the contents of \r
- * <code>EntityReference</code> nodes are not presented in the logical \r
- * view.\r
- * @return The newly created <code>TreeWalker</code>.\r
- * @exception DOMException\r
- * NOT_SUPPORTED_ERR: Raised if the specified <code>root</code> is \r
- * <code>null</code>.\r
- */\r
- public TreeWalker createTreeWalker(Node root, \r
- int whatToShow, \r
- NodeFilter filter, \r
- boolean entityReferenceExpansion)\r
- throws DOMException;\r
-\r
-}\r