| <!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_12) on Fri May 30 11:16:05 CDT 2008 --> |
| <TITLE> |
| IJsTranslator |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.eclipse.wst.jsdt.web.core.javascript.IJsTranslator interface"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="IJsTranslator"; |
| } |
| </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/IJsTranslator.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-files/index-1.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/eclipse/wst/jsdt/web/core/javascript/IJsTranslation.html" title="interface in org.eclipse.wst.jsdt.web.core.javascript"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../../org/eclipse/wst/jsdt/web/core/javascript/JsDataTypes.html" title="interface in org.eclipse.wst.jsdt.web.core.javascript"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../../index.html?org/eclipse/wst/jsdt/web/core/javascript/IJsTranslator.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="IJsTranslator.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.eclipse.wst.jsdt.web.core.javascript</FONT> |
| <BR> |
| Interface IJsTranslator</H2> |
| <DL> |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../../../org/eclipse/wst/jsdt/web/core/javascript/JsTranslator.html" title="class in org.eclipse.wst.jsdt.web.core.javascript">JsTranslator</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>IJsTranslator</B></DL> |
| </PRE> |
| |
| <P> |
| Provisional API: This class/interface is part of an interim API that is still under development and expected to |
| change significantly before reaching stability. It is being made available at this early stage to solicit feedback |
| from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken |
| (repeatedly) as the API evolves. |
| <P> |
| |
| <P> |
| <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> Position[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/eclipse/wst/jsdt/web/core/javascript/IJsTranslator.html#getHtmlLocations()">getHtmlLocations</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> Position[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/eclipse/wst/jsdt/web/core/javascript/IJsTranslator.html#getImportHtmlRanges()">getImportHtmlRanges</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/eclipse/wst/jsdt/web/core/javascript/IJsTranslator.html#getJsText()">getJsText</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/eclipse/wst/jsdt/web/core/javascript/IJsTranslator.html#getMissingEndTagRegionStart()">getMissingEndTagRegionStart</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/eclipse/wst/jsdt/web/core/javascript/IJsTranslator.html#getRawImports()">getRawImports</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/eclipse/wst/jsdt/web/core/javascript/IJsTranslator.html#release()">release</A></B>()</CODE> |
| |
| <BR> |
| release any resources the translation is holding onto.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/eclipse/wst/jsdt/web/core/javascript/IJsTranslator.html#setBuffer(org.eclipse.wst.jsdt.core.IBuffer)">setBuffer</A></B>(<A HREF="../../../../../../../org/eclipse/wst/jsdt/core/IBuffer.html" title="interface in org.eclipse.wst.jsdt.core">IBuffer</A> buffer)</CODE> |
| |
| <BR> |
| sets the javascript unit buffer</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/eclipse/wst/jsdt/web/core/javascript/IJsTranslator.html#translate()">translate</A></B>()</CODE> |
| |
| <BR> |
| begin translating the document.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/eclipse/wst/jsdt/web/core/javascript/IJsTranslator.html#translateInlineJSNode(IStructuredDocumentRegion)">translateInlineJSNode</A></B>(IStructuredDocumentRegion container)</CODE> |
| |
| <BR> |
| translates an inline (event="..") js container region and adds it to the document text.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/eclipse/wst/jsdt/web/core/javascript/IJsTranslator.html#translateJSNode(IStructuredDocumentRegion)">translateJSNode</A></B>(IStructuredDocumentRegion container)</CODE> |
| |
| <BR> |
| translates a script block.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/eclipse/wst/jsdt/web/core/javascript/IJsTranslator.html#translateScriptImportNode(IStructuredDocumentRegion)">translateScriptImportNode</A></B>(IStructuredDocumentRegion region)</CODE> |
| |
| <BR> |
| translates a <script src="</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="getJsText()"><!-- --></A><H3> |
| getJsText</H3> |
| <PRE> |
| java.lang.String <B>getJsText</B>()</PRE> |
| <DL> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>string of javascript from the document</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setBuffer(org.eclipse.wst.jsdt.core.IBuffer)"><!-- --></A><H3> |
| setBuffer</H3> |
| <PRE> |
| void <B>setBuffer</B>(<A HREF="../../../../../../../org/eclipse/wst/jsdt/core/IBuffer.html" title="interface in org.eclipse.wst.jsdt.core">IBuffer</A> buffer)</PRE> |
| <DL> |
| <DD>sets the javascript unit buffer |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>buffer</CODE> - </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getHtmlLocations()"><!-- --></A><H3> |
| getHtmlLocations</H3> |
| <PRE> |
| Position[] <B>getHtmlLocations</B>()</PRE> |
| <DL> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>a list of html locations within the docuemnt.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getMissingEndTagRegionStart()"><!-- --></A><H3> |
| getMissingEndTagRegionStart</H3> |
| <PRE> |
| int <B>getMissingEndTagRegionStart</B>()</PRE> |
| <DL> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the region of a missing </script> tag</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getImportHtmlRanges()"><!-- --></A><H3> |
| getImportHtmlRanges</H3> |
| <PRE> |
| Position[] <B>getImportHtmlRanges</B>()</PRE> |
| <DL> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>position array of <script src=".."> within the doc.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getRawImports()"><!-- --></A><H3> |
| getRawImports</H3> |
| <PRE> |
| java.lang.String[] <B>getRawImports</B>()</PRE> |
| <DL> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>raw/unresolved <script imports></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="translate()"><!-- --></A><H3> |
| translate</H3> |
| <PRE> |
| void <B>translate</B>()</PRE> |
| <DL> |
| <DD>begin translating the document. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="translateInlineJSNode(IStructuredDocumentRegion)"><!-- --></A><H3> |
| translateInlineJSNode</H3> |
| <PRE> |
| void <B>translateInlineJSNode</B>(IStructuredDocumentRegion container)</PRE> |
| <DL> |
| <DD>translates an inline (event="..") js container region and adds it to the document text. must be called in order |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>container</CODE> - </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="translateJSNode(IStructuredDocumentRegion)"><!-- --></A><H3> |
| translateJSNode</H3> |
| <PRE> |
| void <B>translateJSNode</B>(IStructuredDocumentRegion container)</PRE> |
| <DL> |
| <DD>translates a script block. must be called in the order it appears within the document. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>container</CODE> - </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="translateScriptImportNode(IStructuredDocumentRegion)"><!-- --></A><H3> |
| translateScriptImportNode</H3> |
| <PRE> |
| void <B>translateScriptImportNode</B>(IStructuredDocumentRegion region)</PRE> |
| <DL> |
| <DD>translates a <script src=".."> element, parsing out an import. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>region</CODE> - </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="release()"><!-- --></A><H3> |
| release</H3> |
| <PRE> |
| void <B>release</B>()</PRE> |
| <DL> |
| <DD>release any resources the translation is holding onto. |
| <P> |
| <DD><DL> |
| </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/IJsTranslator.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-files/index-1.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/eclipse/wst/jsdt/web/core/javascript/IJsTranslation.html" title="interface in org.eclipse.wst.jsdt.web.core.javascript"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../../org/eclipse/wst/jsdt/web/core/javascript/JsDataTypes.html" title="interface in org.eclipse.wst.jsdt.web.core.javascript"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../../index.html?org/eclipse/wst/jsdt/web/core/javascript/IJsTranslator.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="IJsTranslator.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> |
