| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> | |
| <!--NewPage--> | |
| <HTML> | |
| <HEAD> | |
| <!-- Generated by javadoc (build 1.5.0_18) on Sun Apr 01 21:18:17 PDT 2012 --> | |
| <TITLE> | |
| TransformState | |
| </TITLE> | |
| <META NAME="keywords" CONTENT="org.apache.xalan.transformer.TransformState interface"> | |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> | |
| <SCRIPT type="text/javascript"> | |
| function windowTitle() | |
| { | |
| parent.document.title="TransformState"; | |
| } | |
| </SCRIPT> | |
| <NOSCRIPT> | |
| </NOSCRIPT> | |
| </HEAD> | |
| <BODY BGCOLOR="white" onload="windowTitle();"> | |
| <!-- ========= START OF TOP NAVBAR ======= --> | |
| <A NAME="navbar_top"><!-- --></A> | |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> | |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
| <TR> | |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
| <A NAME="navbar_top_firstrow"><!-- --></A> | |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
| <TR ALIGN="center" VALIGN="top"> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/TransformState.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> | |
| </TR> | |
| </TABLE> | |
| </TD> | |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> | |
| </EM> | |
| </TD> | |
| </TR> | |
| <TR> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../org/apache/xalan/transformer/TransformSnapshotImpl.html" title="class in org.apache.xalan.transformer"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../org/apache/xalan/transformer/TrAXFilter.html" title="class in org.apache.xalan.transformer"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../index.html?org/apache/xalan/transformer/TransformState.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="TransformState.html" target="_top"><B>NO FRAMES</B></A> | |
| <SCRIPT type="text/javascript"> | |
| <!-- | |
| if(window==top) { | |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
| } | |
| //--> | |
| </SCRIPT> | |
| <NOSCRIPT> | |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> | |
| </NOSCRIPT> | |
| </FONT></TD> | |
| </TR> | |
| <TR> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="skip-navbar_top"></A> | |
| <!-- ========= END OF TOP NAVBAR ========= --> | |
| <HR> | |
| <!-- ======== START OF CLASS DATA ======== --> | |
| <H2> | |
| <FONT SIZE="-1"> | |
| org.apache.xalan.transformer</FONT> | |
| <BR> | |
| Interface TransformState</H2> | |
| <DL> | |
| <DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../org/apache/xml/serializer/TransformStateSetter.html" title="interface in org.apache.xml.serializer">TransformStateSetter</A></DD> | |
| </DL> | |
| <DL> | |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/xalan/transformer/XalanTransformState.html" title="class in org.apache.xalan.transformer">XalanTransformState</A></DD> | |
| </DL> | |
| <HR> | |
| <DL> | |
| <DT><PRE>public interface <A HREF="../../../../src-html/org/apache/xalan/transformer/TransformState.html#line.52"><B>TransformState</B></A><DT>extends <A HREF="../../../../org/apache/xml/serializer/TransformStateSetter.html" title="interface in org.apache.xml.serializer">TransformStateSetter</A></DL> | |
| </PRE> | |
| <P> | |
| This interface is meant to be used by a consumer of | |
| SAX2 events produced by Xalan, and enables the consumer | |
| to get information about the state of the transform. It | |
| is primarily intended as a tooling interface. A content | |
| handler can get a reference to a TransformState by implementing | |
| the TransformerClient interface. Xalan will check for | |
| that interface before it calls startDocument, and, if it | |
| is implemented, pass in a TransformState reference to the | |
| setTransformState method. | |
| <p>Note that the current stylesheet and root stylesheet can | |
| be retrieved from the ElemTemplateElement obtained from | |
| either getCurrentElement() or getCurrentTemplate().</p> | |
| This interface contains only getter methods, any setters are in the interface | |
| TransformStateSetter which this interface extends. | |
| <P> | |
| <P> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xml/serializer/TransformStateSetter.html" title="interface in org.apache.xml.serializer"><CODE>TransformStateSetter</CODE></A></DL> | |
| <HR> | |
| <P> | |
| <!-- ========== METHOD SUMMARY =========== --> | |
| <A NAME="method_summary"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
| <B>Method Summary</B></FONT></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> org.w3c.dom.traversal.NodeIterator</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xalan/transformer/TransformState.html#getContextNodeList()">getContextNodeList</A></B>()</CODE> | |
| <BR> | |
| Get the current context node list.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../../../../org/apache/xalan/templates/ElemTemplateElement.html" title="class in org.apache.xalan.templates">ElemTemplateElement</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xalan/transformer/TransformState.html#getCurrentElement()">getCurrentElement</A></B>()</CODE> | |
| <BR> | |
| Retrieves the stylesheet element that produced | |
| the SAX event.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> org.w3c.dom.Node</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xalan/transformer/TransformState.html#getCurrentNode()">getCurrentNode</A></B>()</CODE> | |
| <BR> | |
| This method retrieves the current context node | |
| in the source tree.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../../../../org/apache/xalan/templates/ElemTemplate.html" title="class in org.apache.xalan.templates">ElemTemplate</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xalan/transformer/TransformState.html#getCurrentTemplate()">getCurrentTemplate</A></B>()</CODE> | |
| <BR> | |
| This method retrieves the xsl:template | |
| that is in effect, which may be a matched template | |
| or a named template.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> org.w3c.dom.Node</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xalan/transformer/TransformState.html#getMatchedNode()">getMatchedNode</A></B>()</CODE> | |
| <BR> | |
| Retrieves the node in the source tree that matched | |
| the template obtained via getMatchedTemplate().</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../../../../org/apache/xalan/templates/ElemTemplate.html" title="class in org.apache.xalan.templates">ElemTemplate</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xalan/transformer/TransformState.html#getMatchedTemplate()">getMatchedTemplate</A></B>()</CODE> | |
| <BR> | |
| This method retrieves the xsl:template | |
| that was matched.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> javax.xml.transform.Transformer</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xalan/transformer/TransformState.html#getTransformer()">getTransformer</A></B>()</CODE> | |
| <BR> | |
| Get the TrAX Transformer object in effect.</TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="methods_inherited_from_class_org.apache.xml.serializer.TransformStateSetter"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
| <TH ALIGN="left"><B>Methods inherited from interface org.apache.xml.serializer.<A HREF="../../../../org/apache/xml/serializer/TransformStateSetter.html" title="interface in org.apache.xml.serializer">TransformStateSetter</A></B></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD><CODE><A HREF="../../../../org/apache/xml/serializer/TransformStateSetter.html#resetState(javax.xml.transform.Transformer)">resetState</A>, <A HREF="../../../../org/apache/xml/serializer/TransformStateSetter.html#setCurrentNode(org.w3c.dom.Node)">setCurrentNode</A></CODE></TD> | |
| </TR> | |
| </TABLE> | |
| | |
| <P> | |
| <!-- ============ METHOD DETAIL ========== --> | |
| <A NAME="method_detail"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
| <B>Method Detail</B></FONT></TH> | |
| </TR> | |
| </TABLE> | |
| <A NAME="getCurrentElement()"><!-- --></A><H3> | |
| getCurrentElement</H3> | |
| <PRE> | |
| <A HREF="../../../../org/apache/xalan/templates/ElemTemplateElement.html" title="class in org.apache.xalan.templates">ElemTemplateElement</A> <A HREF="../../../../src-html/org/apache/xalan/transformer/TransformState.html#line.65"><B>getCurrentElement</B></A>()</PRE> | |
| <DL> | |
| <DD>Retrieves the stylesheet element that produced | |
| the SAX event. | |
| <p>Please note that the ElemTemplateElement returned may | |
| be in a default template, and thus may not be | |
| defined in the stylesheet.</p> | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>the stylesheet element that produced the SAX event.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getCurrentNode()"><!-- --></A><H3> | |
| getCurrentNode</H3> | |
| <PRE> | |
| org.w3c.dom.Node <A HREF="../../../../src-html/org/apache/xalan/transformer/TransformState.html#line.73"><B>getCurrentNode</B></A>()</PRE> | |
| <DL> | |
| <DD>This method retrieves the current context node | |
| in the source tree. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>the current context node in the source tree.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getCurrentTemplate()"><!-- --></A><H3> | |
| getCurrentTemplate</H3> | |
| <PRE> | |
| <A HREF="../../../../org/apache/xalan/templates/ElemTemplate.html" title="class in org.apache.xalan.templates">ElemTemplate</A> <A HREF="../../../../src-html/org/apache/xalan/transformer/TransformState.html#line.86"><B>getCurrentTemplate</B></A>()</PRE> | |
| <DL> | |
| <DD>This method retrieves the xsl:template | |
| that is in effect, which may be a matched template | |
| or a named template. | |
| <p>Please note that the ElemTemplate returned may | |
| be a default template, and thus may not have a template | |
| defined in the stylesheet.</p> | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>the xsl:template that is in effect</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getMatchedTemplate()"><!-- --></A><H3> | |
| getMatchedTemplate</H3> | |
| <PRE> | |
| <A HREF="../../../../org/apache/xalan/templates/ElemTemplate.html" title="class in org.apache.xalan.templates">ElemTemplate</A> <A HREF="../../../../src-html/org/apache/xalan/transformer/TransformState.html#line.101"><B>getMatchedTemplate</B></A>()</PRE> | |
| <DL> | |
| <DD>This method retrieves the xsl:template | |
| that was matched. Note that this may not be | |
| the same thing as the current template (which | |
| may be from getCurrentElement()), since a named | |
| template may be in effect. | |
| <p>Please note that the ElemTemplate returned may | |
| be a default template, and thus may not have a template | |
| defined in the stylesheet.</p> | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>the xsl:template that was matched.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getMatchedNode()"><!-- --></A><H3> | |
| getMatchedNode</H3> | |
| <PRE> | |
| org.w3c.dom.Node <A HREF="../../../../src-html/org/apache/xalan/transformer/TransformState.html#line.110"><B>getMatchedNode</B></A>()</PRE> | |
| <DL> | |
| <DD>Retrieves the node in the source tree that matched | |
| the template obtained via getMatchedTemplate(). | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>the node in the source tree that matched | |
| the template obtained via getMatchedTemplate().</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getContextNodeList()"><!-- --></A><H3> | |
| getContextNodeList</H3> | |
| <PRE> | |
| org.w3c.dom.traversal.NodeIterator <A HREF="../../../../src-html/org/apache/xalan/transformer/TransformState.html#line.117"><B>getContextNodeList</B></A>()</PRE> | |
| <DL> | |
| <DD>Get the current context node list. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>the current context node list.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getTransformer()"><!-- --></A><H3> | |
| getTransformer</H3> | |
| <PRE> | |
| javax.xml.transform.Transformer <A HREF="../../../../src-html/org/apache/xalan/transformer/TransformState.html#line.124"><B>getTransformer</B></A>()</PRE> | |
| <DL> | |
| <DD>Get the TrAX Transformer object in effect. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>the TrAX Transformer object in effect.</DL> | |
| </DD> | |
| </DL> | |
| <!-- ========= END OF CLASS DATA ========= --> | |
| <HR> | |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> | |
| <A NAME="navbar_bottom"><!-- --></A> | |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> | |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
| <TR> | |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> | |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
| <TR ALIGN="center" VALIGN="top"> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/TransformState.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> | |
| </TR> | |
| </TABLE> | |
| </TD> | |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> | |
| </EM> | |
| </TD> | |
| </TR> | |
| <TR> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../org/apache/xalan/transformer/TransformSnapshotImpl.html" title="class in org.apache.xalan.transformer"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../org/apache/xalan/transformer/TrAXFilter.html" title="class in org.apache.xalan.transformer"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../index.html?org/apache/xalan/transformer/TransformState.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="TransformState.html" target="_top"><B>NO FRAMES</B></A> | |
| <SCRIPT type="text/javascript"> | |
| <!-- | |
| if(window==top) { | |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
| } | |
| //--> | |
| </SCRIPT> | |
| <NOSCRIPT> | |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> | |
| </NOSCRIPT> | |
| </FONT></TD> | |
| </TR> | |
| <TR> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="skip-navbar_bottom"></A> | |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> | |
| <HR> | |
| </BODY> | |
| </HTML> |