001/* 002 * Copyright (c) 2000 World Wide Web Consortium, 003 * (Massachusetts Institute of Technology, Institut National de 004 * Recherche en Informatique et en Automatique, Keio University). All 005 * Rights Reserved. This program is distributed under the W3C's Software 006 * Intellectual Property License. This program is distributed in the 007 * hope that it will be useful, but WITHOUT ANY WARRANTY; without even 008 * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 009 * PURPOSE. 010 * See W3C License http://www.w3.org/Consortium/Legal/ for more details. 011 */ 012 013package org.w3c.dom.traversal; 014 015import org.w3c.dom.Node; 016import org.w3c.dom.DOMException; 017 018/** 019 * <code>DocumentTraversal</code> contains methods that create iterators and 020 * tree-walkers to traverse a node and its children in document order (depth 021 * first, pre-order traversal, which is equivalent to the order in which the 022 * start tags occur in the text representation of the document). In DOMs 023 * which support the Traversal feature, <code>DocumentTraversal</code> will 024 * be implemented by the same objects that implement the Document interface. 025 * <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>. 026 * @since DOM Level 2 027 */ 028public interface DocumentTraversal { 029 /** 030 * Create a new <code>NodeIterator</code> over the subtree rooted at the 031 * specified node. 032 * @param rootThe node which will be iterated together with its children. 033 * The iterator is initially positioned just before this node. The 034 * <code>whatToShow</code> flags and the filter, if any, are not 035 * considered when setting this position. The root must not be 036 * <code>null</code>. 037 * @param whatToShowThis flag specifies which node types may appear in 038 * the logical view of the tree presented by the iterator. See the 039 * description of <code>NodeFilter</code> for the set of possible 040 * <code>SHOW_</code> values.These flags can be combined using 041 * <code>OR</code>. 042 * @param filterThe <code>NodeFilter</code> to be used with this 043 * <code>TreeWalker</code>, or <code>null</code> to indicate no filter. 044 * @param entityReferenceExpansionThe value of this flag determines 045 * whether entity reference nodes are expanded. 046 * @return The newly created <code>NodeIterator</code>. 047 * @exception DOMException 048 * NOT_SUPPORTED_ERR: Raised if the specified <code>root</code> is 049 * <code>null</code>. 050 */ 051 public NodeIterator createNodeIterator(Node root, 052 int whatToShow, 053 NodeFilter filter, 054 boolean entityReferenceExpansion) 055 throws DOMException; 056 057 /** 058 * Create a new <code>TreeWalker</code> over the subtree rooted at the 059 * specified node. 060 * @param rootThe node which will serve as the <code>root</code> for the 061 * <code>TreeWalker</code>. The <code>whatToShow</code> flags and the 062 * <code>NodeFilter</code> are not considered when setting this value; 063 * any node type will be accepted as the <code>root</code>. The 064 * <code>currentNode</code> of the <code>TreeWalker</code> is 065 * initialized to this node, whether or not it is visible. The 066 * <code>root</code> functions as a stopping point for traversal 067 * methods that look upward in the document structure, such as 068 * <code>parentNode</code> and nextNode. The <code>root</code> must 069 * not be <code>null</code>. 070 * @param whatToShowThis flag specifies which node types may appear in 071 * the logical view of the tree presented by the tree-walker. See the 072 * description of <code>NodeFilter</code> for the set of possible 073 * SHOW_ values.These flags can be combined using <code>OR</code>. 074 * @param filterThe <code>NodeFilter</code> to be used with this 075 * <code>TreeWalker</code>, or <code>null</code> to indicate no filter. 076 * @param entityReferenceExpansionIf this flag is false, the contents of 077 * <code>EntityReference</code> nodes are not presented in the logical 078 * view. 079 * @return The newly created <code>TreeWalker</code>. 080 * @exception DOMException 081 * NOT_SUPPORTED_ERR: Raised if the specified <code>root</code> is 082 * <code>null</code>. 083 */ 084 public TreeWalker createTreeWalker(Node root, 085 int whatToShow, 086 NodeFilter filter, 087 boolean entityReferenceExpansion) 088 throws DOMException; 089 090}