old/xalan-j/apidocs/org/w3c/dom/traversal/DocumentTraversal.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">  <HTML> <HEAD>  <TITLE> Xalan-Java 2.7.1: Interface DocumentTraversal </TITLE> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> </HEAD> <BODY BGCOLOR="white">  <A NAME="navbar_top"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_top_firstrow"></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html">Overview</A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html">Package</A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  Class </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DocumentTraversal.html">Use</A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html">Tree</A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html">Deprecated</A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html">Index</A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html">Help</A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2">  PREV CLASS   <A HREF="../../../../org/w3c/dom/traversal/NodeFilter.html">NEXT CLASS</A></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"> <A HREF="../../../../index.html" TARGET="_top">FRAMES</A>    <A HREF="DocumentTraversal.html" TARGET="_top">NO FRAMES</A></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"> SUMMARY:  INNER | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></TD> <TD VALIGN="top" CLASS="NavBarCell3"> DETAIL:  FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></TD> </TR> </TABLE>  <HR>  <H2> org.w3c.dom.traversal Interface DocumentTraversal</H2> <HR> <DL> <DT>public interface DocumentTraversal</DL> <code>DocumentTraversal</code> contains methods that create <code>NodeIterators</code> and <code>TreeWalkers</code> to traverse a node and its children in document order (depth first, pre-order traversal, which is equivalent to the order in which the start tags occur in the text representation of the document). In DOMs which support the Traversal feature, <code>DocumentTraversal</code> will be implemented by the same objects that implement the Document interface. 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>. <DL> <DT>Since: <DD>DOM Level 2</DD> </DL> <HR>     <A NAME="method_summary"></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=2> Method Summary</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <CODE> <A HREF="../../../../org/w3c/dom/traversal/NodeIterator.html">NodeIterator</A></CODE></TD> <TD><CODE><A HREF="../../../../org/w3c/dom/traversal/DocumentTraversal.html#createNodeIterator(org.w3c.dom.Node, int, org.w3c.dom.traversal.NodeFilter, boolean)">createNodeIterator</A>(<A HREF="../../../../org/w3c/dom/Node.html">Node</A> root, int whatToShow, <A HREF="../../../../org/w3c/dom/traversal/NodeFilter.html">NodeFilter</A> filter, boolean entityReferenceExpansion)</CODE>           Create a new <code>NodeIterator</code> over the subtree rooted at the specified node.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <CODE> <A HREF="../../../../org/w3c/dom/traversal/TreeWalker.html">TreeWalker</A></CODE></TD> <TD><CODE><A HREF="../../../../org/w3c/dom/traversal/DocumentTraversal.html#createTreeWalker(org.w3c.dom.Node, int, org.w3c.dom.traversal.NodeFilter, boolean)">createTreeWalker</A>(<A HREF="../../../../org/w3c/dom/Node.html">Node</A> root, int whatToShow, <A HREF="../../../../org/w3c/dom/traversal/NodeFilter.html">NodeFilter</A> filter, boolean entityReferenceExpansion)</CODE>           Create a new <code>TreeWalker</code> over the subtree rooted at the specified node.</TD> </TR> </TABLE>      <A NAME="method_detail"></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=1> Method Detail</TD> </TR> </TABLE> <A NAME="createNodeIterator(org.w3c.dom.Node, int, org.w3c.dom.traversal.NodeFilter, boolean)"></A><H3> createNodeIterator</H3> <PRE> public <A HREF="../../../../org/w3c/dom/traversal/NodeIterator.html">NodeIterator</A> createNodeIterator(<A HREF="../../../../org/w3c/dom/Node.html">Node</A> root, int whatToShow, <A HREF="../../../../org/w3c/dom/traversal/NodeFilter.html">NodeFilter</A> filter, boolean entityReferenceExpansion) throws <A HREF="../../../../org/w3c/dom/DOMException.html">DOMException</A></PRE> <DL> <DD>Create a new <code>NodeIterator</code> over the subtree rooted at the specified node.<DD><DL> <DT>Parameters:<DD><CODE>root</CODE> - The node which will be iterated together with its children. The <code>NodeIterator</code> is initially positioned just before this node. The <code>whatToShow</code> flags and the filter, if any, are not considered when setting this position. The root must not be <code>null</code>.<DD><CODE>whatToShow</CODE> - This flag specifies which node types may appear in the logical view of the tree presented by the <code>NodeIterator</code>. See the description of <code>NodeFilter</code> for the set of possible <code>SHOW_</code> values.These flags can be combined using <code>OR</code>.<DD><CODE>filter</CODE> - The <code>NodeFilter</code> to be used with this <code>NodeIterator</code>, or <code>null</code> to indicate no filter.<DD><CODE>entityReferenceExpansion</CODE> - The value of this flag determines whether entity reference nodes are expanded.<DT>Returns:<DD>The newly created <code>NodeIterator</code>.<DT>Throws:<DD><A HREF="../../../../org/w3c/dom/DOMException.html">DOMException</A> - NOT_SUPPORTED_ERR: Raised if the specified <code>root</code> is <code>null</code>.</DL> </DD> </DL> <HR> <A NAME="createTreeWalker(org.w3c.dom.Node, int, org.w3c.dom.traversal.NodeFilter, boolean)"></A><H3> createTreeWalker</H3> <PRE> public <A HREF="../../../../org/w3c/dom/traversal/TreeWalker.html">TreeWalker</A> createTreeWalker(<A HREF="../../../../org/w3c/dom/Node.html">Node</A> root, int whatToShow, <A HREF="../../../../org/w3c/dom/traversal/NodeFilter.html">NodeFilter</A> filter, boolean entityReferenceExpansion) throws <A HREF="../../../../org/w3c/dom/DOMException.html">DOMException</A></PRE> <DL> <DD>Create a new <code>TreeWalker</code> over the subtree rooted at the specified node.<DD><DL> <DT>Parameters:<DD><CODE>root</CODE> - The node which will serve as the <code>root</code> for the <code>TreeWalker</code>. The <code>whatToShow</code> flags and the <code>NodeFilter</code> are not considered when setting this value; any node type will be accepted as the <code>root</code>. The <code>currentNode</code> of the <code>TreeWalker</code> is initialized to this node, whether or not it is visible. The <code>root</code> functions as a stopping point for traversal methods that look upward in the document structure, such as <code>parentNode</code> and nextNode. The <code>root</code> must not be <code>null</code>.<DD><CODE>whatToShow</CODE> - This flag specifies which node types may appear in the logical view of the tree presented by the <code>TreeWalker</code>. See the description of <code>NodeFilter</code> for the set of possible <code>SHOW_</code> values.These flags can be combined using <code>OR</code>.<DD><CODE>filter</CODE> - The <code>NodeFilter</code> to be used with this <code>TreeWalker</code>, or <code>null</code> to indicate no filter.<DD><CODE>entityReferenceExpansion</CODE> - If this flag is false, the contents of <code>EntityReference</code> nodes are not presented in the logical view.<DT>Returns:<DD>The newly created <code>TreeWalker</code>.<DT>Throws:<DD><A HREF="../../../../org/w3c/dom/DOMException.html">DOMException</A> - NOT_SUPPORTED_ERR: Raised if the specified <code>root</code> is <code>null</code>.</DL> </DD> </DL>  <HR>  <A NAME="navbar_bottom"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_bottom_firstrow"></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html">Overview</A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html">Package</A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  Class </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DocumentTraversal.html">Use</A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html">Tree</A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html">Deprecated</A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html">Index</A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html">Help</A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2">  PREV CLASS   <A HREF="../../../../org/w3c/dom/traversal/NodeFilter.html">NEXT CLASS</A></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"> <A HREF="../../../../index.html" TARGET="_top">FRAMES</A>    <A HREF="DocumentTraversal.html" TARGET="_top">NO FRAMES</A></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"> SUMMARY:  INNER | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></TD> <TD VALIGN="top" CLASS="NavBarCell3"> DETAIL:  FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></TD> </TR> </TABLE>  <HR> Copyright � 2006 Apache XML Project. All Rights Reserved. </BODY> </HTML>

old/xalan-j/apidocs/org/w3c/dom/traversal/DocumentTraversal.html (208 lines of code) (raw):