| <!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.6.0_45) on Tue Mar 28 22:15:30 CEST 2017 --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| Document (Simple ODF v0.8.2-incubating - http://odftoolkit) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2017-03-28"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Document (Simple ODF v0.8.2-incubating - http://odftoolkit)"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= 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/Document.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/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple"><B>PREV CLASS</B></A> |
| <A HREF="../../../org/odftoolkit/simple/Document.OdfMediaType.html" title="enum in org.odftoolkit.simple"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../index.html?org/odftoolkit/simple/Document.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="Document.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: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#fields_inherited_from_class_org.odftoolkit.odfdom.dom.OdfSchemaDocument">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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.odftoolkit.simple</FONT> |
| <BR> |
| Class Document</H2> |
| <PRE> |
| <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> |
| <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfPackageDocument.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.pkg">org.odftoolkit.odfdom.pkg.OdfPackageDocument</A> |
| <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/OdfSchemaDocument.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.dom">org.odftoolkit.odfdom.dom.OdfSchemaDocument</A> |
| <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.odftoolkit.simple.Document</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</A>, <A HREF="../../../org/odftoolkit/simple/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</A></DD> |
| </DL> |
| <DL> |
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../org/odftoolkit/simple/ChartDocument.html" title="class in org.odftoolkit.simple">ChartDocument</A>, <A HREF="../../../org/odftoolkit/simple/GraphicsDocument.html" title="class in org.odftoolkit.simple">GraphicsDocument</A>, <A HREF="../../../org/odftoolkit/simple/PresentationDocument.html" title="class in org.odftoolkit.simple">PresentationDocument</A>, <A HREF="../../../org/odftoolkit/simple/SpreadsheetDocument.html" title="class in org.odftoolkit.simple">SpreadsheetDocument</A>, <A HREF="../../../org/odftoolkit/simple/TextDocument.html" title="class in org.odftoolkit.simple">TextDocument</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public abstract class <B>Document</B><DT>extends <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/OdfSchemaDocument.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.dom">OdfSchemaDocument</A><DT>implements <A HREF="../../../org/odftoolkit/simple/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</A></DL> |
| </PRE> |
| |
| <P> |
| This abstract class is representing one of the possible ODF documents |
| <P> |
| |
| <P> |
| <HR> |
| |
| <P> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| |
| <A NAME="nested_class_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>Nested Class Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static class</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/odftoolkit/simple/Document.OdfMediaType.html" title="enum in org.odftoolkit.simple">Document.OdfMediaType</A></B></CODE> |
| |
| <BR> |
| This enum contains all possible media types of Document documents.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static class</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/odftoolkit/simple/Document.ScriptType.html" title="enum in org.odftoolkit.simple">Document.ScriptType</A></B></CODE> |
| |
| <BR> |
| |
| Unicode characters are in general divided by office applications into |
| three different types:</TD> |
| </TR> |
| </TABLE> |
| <A NAME="nested_classes_inherited_from_class_org.odftoolkit.odfdom.dom.OdfSchemaDocument"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Nested classes/interfaces inherited from class org.odftoolkit.odfdom.dom.<A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/OdfSchemaDocument.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.dom">OdfSchemaDocument</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/OdfSchemaDocument.OdfXMLFile.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.dom">OdfSchemaDocument.OdfXMLFile</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="nested_classes_inherited_from_class_org.odftoolkit.odfdom.pkg.OdfPackageDocument"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Nested classes/interfaces inherited from class org.odftoolkit.odfdom.pkg.<A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfPackageDocument.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.pkg">OdfPackageDocument</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfPackageDocument.Resource.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.pkg">OdfPackageDocument.Resource</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_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>Field Summary</B></FONT></TH> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.odftoolkit.odfdom.dom.OdfSchemaDocument"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Fields inherited from class org.odftoolkit.odfdom.dom.<A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/OdfSchemaDocument.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.dom">OdfSchemaDocument</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/OdfSchemaDocument.html?is-external=true#mContentDom" title="class or interface in org.odftoolkit.odfdom.dom">mContentDom</A>, <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/OdfSchemaDocument.html?is-external=true#mDocumentStyles" title="class or interface in org.odftoolkit.odfdom.dom">mDocumentStyles</A>, <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/OdfSchemaDocument.html?is-external=true#mMetaDom" title="class or interface in org.odftoolkit.odfdom.dom">mMetaDom</A>, <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/OdfSchemaDocument.html?is-external=true#mSettingsDom" title="class or interface in org.odftoolkit.odfdom.dom">mSettingsDom</A>, <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/OdfSchemaDocument.html?is-external=true#mStylesDom" title="class or interface in org.odftoolkit.odfdom.dom">mStylesDom</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.odftoolkit.odfdom.pkg.OdfPackageDocument"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Fields inherited from class org.odftoolkit.odfdom.pkg.<A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfPackageDocument.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.pkg">OdfPackageDocument</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfPackageDocument.html?is-external=true#mDocumentMediaType" title="class or interface in org.odftoolkit.odfdom.pkg">mDocumentMediaType</A>, <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfPackageDocument.html?is-external=true#mDocumentPathInPackage" title="class or interface in org.odftoolkit.odfdom.pkg">mDocumentPathInPackage</A>, <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfPackageDocument.html?is-external=true#mPackage" title="class or interface in org.odftoolkit.odfdom.pkg">mPackage</A>, <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfPackageDocument.html?is-external=true#ROOT_DOCUMENT_PATH" title="class or interface in org.odftoolkit.odfdom.pkg">ROOT_DOCUMENT_PATH</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_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>Constructor Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected </CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/odftoolkit/simple/Document.html#Document(org.odftoolkit.odfdom.pkg.OdfPackage, java.lang.String, org.odftoolkit.simple.Document.OdfMediaType)">Document</A></B>(<A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfPackage.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.pkg">OdfPackage</A> pkg, |
| <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> internalPath, |
| <A HREF="../../../org/odftoolkit/simple/Document.OdfMediaType.html" title="enum in org.odftoolkit.simple">Document.OdfMediaType</A> mediaType)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== 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> <A HREF="../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/odftoolkit/simple/Document.html#addTable()">addTable</A></B>()</CODE> |
| |
| <BR> |
| Add a new Table to this container.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/odftoolkit/simple/Document.html#addTable(int, int)">addTable</A></B>(int numRows, |
| int numCols)</CODE> |
| |
| <BR> |
| Add a new Table to this container with a specified row number and column |
| number.</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/odftoolkit/simple/Document.html#close()">close</A></B>()</CODE> |
| |
| <BR> |
| Close the OdfPackage and release all temporary created data.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/IdentityHashMap.html?is-external=true" title="class or interface in java.util">IdentityHashMap</A><<A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfElement.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.pkg">OdfElement</A>,<A HREF="../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">Component</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/odftoolkit/simple/Document.html#getComponentMap()">getComponentMap</A></B>()</CODE> |
| |
| <BR> |
| Return the component repository of this document.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfElement.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.pkg">OdfElement</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/odftoolkit/simple/Document.html#getContentRoot()">getContentRoot</A></B>()</CODE> |
| |
| <BR> |
| Get the content root of a document.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> |
| <TR ALIGN="right" VALIGN=""> |
| <TD NOWRAP><FONT SIZE="-1"> |
| <CODE><T extends <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfElement.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.pkg">OdfElement</A>> |
| <BR> |
| T</CODE></FONT></TD> |
| </TR> |
| </TABLE> |
| </CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/odftoolkit/simple/Document.html#getContentRoot(java.lang.Class)">getContentRoot</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><T> clazz)</CODE> |
| |
| <BR> |
| Get the content root of a document.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/odftoolkit/simple/Document.html#getEmbeddedDocument(java.lang.String)">getEmbeddedDocument</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> documentPath)</CODE> |
| |
| <BR> |
| Returns an embedded OdfPackageDocument from the given package path.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/odftoolkit/simple/Document.html#getEmbeddedDocuments()">getEmbeddedDocuments</A></B>()</CODE> |
| |
| <BR> |
| Method returns all embedded OdfPackageDocuments, which match a valid |
| OdfMediaType, of the root OdfPackageDocument.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/odftoolkit/simple/Document.html#getEmbeddedDocuments(org.odftoolkit.simple.Document.OdfMediaType)">getEmbeddedDocuments</A></B>(<A HREF="../../../org/odftoolkit/simple/Document.OdfMediaType.html" title="enum in org.odftoolkit.simple">Document.OdfMediaType</A> mediaType)</CODE> |
| |
| <BR> |
| Method returns all embedded OdfPackageDocuments of the root |
| OdfPackageDocument matching the according MediaType.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/odftoolkit/simple/Document.html#getLocale(org.odftoolkit.simple.Document.ScriptType)">getLocale</A></B>(<A HREF="../../../org/odftoolkit/simple/Document.ScriptType.html" title="enum in org.odftoolkit.simple">Document.ScriptType</A> scriptType)</CODE> |
| |
| <BR> |
| |
| Get a locale information of a specific script type.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="../../../org/odftoolkit/simple/Document.OdfMediaType.html" title="enum in org.odftoolkit.simple">Document.OdfMediaType</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/odftoolkit/simple/Document.html#getOdfMediaType()">getOdfMediaType</A></B>()</CODE> |
| |
| <BR> |
| Gets the media type of the Document</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../org/odftoolkit/simple/meta/Meta.html" title="class in org.odftoolkit.simple.meta">Meta</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/odftoolkit/simple/Document.html#getOfficeMetadata()">getOfficeMetadata</A></B>()</CODE> |
| |
| <BR> |
| Get the meta data feature instance of the current document</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../org/odftoolkit/simple/Document.ScriptType.html" title="enum in org.odftoolkit.simple">Document.ScriptType</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/odftoolkit/simple/Document.html#getScriptType(java.util.Locale)">getScriptType</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</A> locale)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../org/odftoolkit/simple/text/Section.html" title="class in org.odftoolkit.simple.text">Section</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/odftoolkit/simple/Document.html#getSectionByName(java.lang.String)">getSectionByName</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</CODE> |
| |
| <BR> |
| This method will search both the document content and header/footer, |
| return a section with a specific name.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<A HREF="../../../org/odftoolkit/simple/text/Section.html" title="class in org.odftoolkit.simple.text">Section</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/odftoolkit/simple/Document.html#getSectionIterator()">getSectionIterator</A></B>()</CODE> |
| |
| <BR> |
| This method will search both the document content and header/footer, |
| return an iterator of section objects.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../org/odftoolkit/simple/table/Table.TableBuilder.html" title="class in org.odftoolkit.simple.table">Table.TableBuilder</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/odftoolkit/simple/Document.html#getTableBuilder()">getTableBuilder</A></B>()</CODE> |
| |
| <BR> |
| Return the table builder of this document.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/odftoolkit/simple/Document.html#getTableByName(java.lang.String)">getTableByName</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</CODE> |
| |
| <BR> |
| Return an instance of table feature with the specific table name.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="../../../org/odftoolkit/simple/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/odftoolkit/simple/Document.html#getTableContainerImpl()">getTableContainerImpl</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/odftoolkit/simple/Document.html#getTableList()">getTableList</A></B>()</CODE> |
| |
| <BR> |
| Return a list of table features in this 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/odftoolkit/simple/Document.html#insertDocument(org.odftoolkit.odfdom.pkg.OdfPackageDocument, java.lang.String)">insertDocument</A></B>(<A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfPackageDocument.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.pkg">OdfPackageDocument</A> sourceDocument, |
| <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> documentPath)</CODE> |
| |
| <BR> |
| Embed an OdfPackageDocument to the current OdfPackageDocument.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/odftoolkit/simple/Document.html#loadDocument(java.io.File)">loadDocument</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> file)</CODE> |
| |
| <BR> |
| Creates a Document from the Document provided by a File.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/odftoolkit/simple/Document.html#loadDocument(java.io.File, java.lang.String)">loadDocument</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> file, |
| <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> password)</CODE> |
| |
| <BR> |
| Creates a Document from the Document provided by a File.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/odftoolkit/simple/Document.html#loadDocument(java.io.InputStream)">loadDocument</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A> inStream)</CODE> |
| |
| <BR> |
| Creates a Document from the Document provided by a resource Stream.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/odftoolkit/simple/Document.html#loadDocument(org.odftoolkit.odfdom.pkg.OdfPackage)">loadDocument</A></B>(<A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfPackage.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.pkg">OdfPackage</A> odfPackage)</CODE> |
| |
| <BR> |
| Creates a Document from the Document provided by an ODF package.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/odftoolkit/simple/Document.html#loadDocument(org.odftoolkit.odfdom.pkg.OdfPackage, java.lang.String)">loadDocument</A></B>(<A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfPackage.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.pkg">OdfPackage</A> odfPackage, |
| <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> internalPath)</CODE> |
| |
| <BR> |
| Creates a Document from the Document provided by an ODF package.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/odftoolkit/simple/Document.html#loadDocument(java.lang.String)">loadDocument</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> documentPath)</CODE> |
| |
| <BR> |
| Loads a Document from the provided path.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/odftoolkit/simple/Document.html#loadDocument(java.lang.String, java.lang.String)">loadDocument</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> documentPath, |
| <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> password)</CODE> |
| |
| <BR> |
| Loads a Document from the provided path.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../org/odftoolkit/simple/table/TableTemplate.html" title="class in org.odftoolkit.simple.table">TableTemplate</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/odftoolkit/simple/Document.html#LoadTableTemplateFromForeignTable(java.io.InputStream, java.lang.String)">LoadTableTemplateFromForeignTable</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A> templateFileInputStream, |
| <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> tableName)</CODE> |
| |
| <BR> |
| Construct a |
| |
| |
| <code>TableTemplate<code> feature by extracting style template from an pre-defined table in a foreign document.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected static <A HREF="../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/odftoolkit/simple/Document.html#loadTemplate(org.odftoolkit.odfdom.pkg.OdfPackageDocument.Resource, org.odftoolkit.simple.Document.OdfMediaType)">loadTemplate</A></B>(<A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfPackageDocument.Resource.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.pkg">OdfPackageDocument.Resource</A> res, |
| <A HREF="../../../org/odftoolkit/simple/Document.OdfMediaType.html" title="enum in org.odftoolkit.simple">Document.OdfMediaType</A> odfMediaType)</CODE> |
| |
| <BR> |
| Loads an Document from the given resource.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/odftoolkit/simple/Document.html#newImage(java.net.URI)">newImage</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</A> imageUri)</CODE> |
| |
| <BR> |
| Insert an Image from the specified uri to the end of the Document.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/odftoolkit/simple/Document.html#removeElementLinkedResource(org.odftoolkit.odfdom.pkg.OdfElement)">removeElementLinkedResource</A></B>(<A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfElement.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.pkg">OdfElement</A> odfElement)</CODE> |
| |
| <BR> |
| Remove an ODF element from 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/odftoolkit/simple/Document.html#save(java.io.File)">save</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> file)</CODE> |
| |
| <BR> |
| Save the document to a given file.</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/odftoolkit/simple/Document.html#save(java.io.File, java.lang.String)">save</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> file, |
| <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> password)</CODE> |
| |
| <BR> |
| Save the document to a given file with given password.</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/odftoolkit/simple/Document.html#save(java.io.OutputStream)">save</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A> out)</CODE> |
| |
| <BR> |
| Save the document to an OutputStream.</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/odftoolkit/simple/Document.html#setLocale(java.util.Locale)">setLocale</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</A> locale)</CODE> |
| |
| <BR> |
| |
| Set a locale information.</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/odftoolkit/simple/Document.html#setLocale(java.util.Locale, org.odftoolkit.simple.Document.ScriptType)">setLocale</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</A> locale, |
| <A HREF="../../../org/odftoolkit/simple/Document.ScriptType.html" title="enum in org.odftoolkit.simple">Document.ScriptType</A> scriptType)</CODE> |
| |
| <BR> |
| |
| Set a locale of a specific script type.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/odftoolkit/simple/Document.html#setOdfMediaType(org.odftoolkit.simple.Document.OdfMediaType)">setOdfMediaType</A></B>(<A HREF="../../../org/odftoolkit/simple/Document.OdfMediaType.html" title="enum in org.odftoolkit.simple">Document.OdfMediaType</A> odfMediaType)</CODE> |
| |
| <BR> |
| Sets the media type of 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/odftoolkit/simple/Document.html#setPassword(java.lang.String)">setPassword</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> password)</CODE> |
| |
| <BR> |
| Sets password of this document.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/odftoolkit/simple/Document.html#toString()">toString</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.odftoolkit.odfdom.dom.OdfSchemaDocument"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class org.odftoolkit.odfdom.dom.<A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/OdfSchemaDocument.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.dom">OdfSchemaDocument</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/OdfSchemaDocument.html?is-external=true#getBaseURI()" title="class or interface in org.odftoolkit.odfdom.dom">getBaseURI</A>, <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/OdfSchemaDocument.html?is-external=true#getBookmarkRDFMetadata()" title="class or interface in org.odftoolkit.odfdom.dom">getBookmarkRDFMetadata</A>, <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/OdfSchemaDocument.html?is-external=true#getContentDom()" title="class or interface in org.odftoolkit.odfdom.dom">getContentDom</A>, <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/OdfSchemaDocument.html?is-external=true#getContentStream()" title="class or interface in org.odftoolkit.odfdom.dom">getContentStream</A>, <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/OdfSchemaDocument.html?is-external=true#getDocumentStyles()" title="class or interface in org.odftoolkit.odfdom.dom">getDocumentStyles</A>, <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/OdfSchemaDocument.html?is-external=true#getFileDom(org.odftoolkit.odfdom.dom.OdfSchemaDocument.OdfXMLFile)" title="class or interface in org.odftoolkit.odfdom.dom">getFileDom</A>, <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/OdfSchemaDocument.html?is-external=true#getInContentMetadata()" title="class or interface in org.odftoolkit.odfdom.dom">getInContentMetadata</A>, <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/OdfSchemaDocument.html?is-external=true#getInContentMetadataFromCache()" title="class or interface in org.odftoolkit.odfdom.dom">getInContentMetadataFromCache</A>, <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/OdfSchemaDocument.html?is-external=true#getManifestRDFMetadata()" title="class or interface in org.odftoolkit.odfdom.dom">getManifestRDFMetadata</A>, <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/OdfSchemaDocument.html?is-external=true#getMasterPages()" title="class or interface in org.odftoolkit.odfdom.dom">getMasterPages</A>, <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/OdfSchemaDocument.html?is-external=true#getMetaDom()" title="class or interface in org.odftoolkit.odfdom.dom">getMetaDom</A>, <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/OdfSchemaDocument.html?is-external=true#getMetaStream()" title="class or interface in org.odftoolkit.odfdom.dom">getMetaStream</A>, <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/OdfSchemaDocument.html?is-external=true#getOfficeMasterStyles()" title="class or interface in org.odftoolkit.odfdom.dom">getOfficeMasterStyles</A>, <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/OdfSchemaDocument.html?is-external=true#getOrCreateDocumentStyles()" title="class or interface in org.odftoolkit.odfdom.dom">getOrCreateDocumentStyles</A>, <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/OdfSchemaDocument.html?is-external=true#getRDFMetadata()" title="class or interface in org.odftoolkit.odfdom.dom">getRDFMetadata</A>, <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/OdfSchemaDocument.html?is-external=true#getSettingsDom()" title="class or interface in org.odftoolkit.odfdom.dom">getSettingsDom</A>, <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/OdfSchemaDocument.html?is-external=true#getSettingsStream()" title="class or interface in org.odftoolkit.odfdom.dom">getSettingsStream</A>, <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/OdfSchemaDocument.html?is-external=true#getStylesDom()" title="class or interface in org.odftoolkit.odfdom.dom">getStylesDom</A>, <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/OdfSchemaDocument.html?is-external=true#getStylesStream()" title="class or interface in org.odftoolkit.odfdom.dom">getStylesStream</A>, <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/OdfSchemaDocument.html?is-external=true#getTables()" title="class or interface in org.odftoolkit.odfdom.dom">getTables</A>, <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/OdfSchemaDocument.html?is-external=true#getXMLFilePath(org.odftoolkit.odfdom.dom.OdfSchemaDocument.OdfXMLFile)" title="class or interface in org.odftoolkit.odfdom.dom">getXMLFilePath</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.odftoolkit.odfdom.pkg.OdfPackageDocument"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class org.odftoolkit.odfdom.pkg.<A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfPackageDocument.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.pkg">OdfPackageDocument</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfPackageDocument.html?is-external=true#flushDoms()" title="class or interface in org.odftoolkit.odfdom.pkg">flushDoms</A>, <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfPackageDocument.html?is-external=true#getDocumentPath()" title="class or interface in org.odftoolkit.odfdom.pkg">getDocumentPath</A>, <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfPackageDocument.html?is-external=true#getFileDom(java.lang.String)" title="class or interface in org.odftoolkit.odfdom.pkg">getFileDom</A>, <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfPackageDocument.html?is-external=true#getMediaTypeString()" title="class or interface in org.odftoolkit.odfdom.pkg">getMediaTypeString</A>, <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfPackageDocument.html?is-external=true#getPackage()" title="class or interface in org.odftoolkit.odfdom.pkg">getPackage</A>, <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfPackageDocument.html?is-external=true#getXMLFileMetadata(java.lang.String)" title="class or interface in org.odftoolkit.odfdom.pkg">getXMLFileMetadata</A>, <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfPackageDocument.html?is-external=true#isExternalReference(java.lang.String)" title="class or interface in org.odftoolkit.odfdom.pkg">isExternalReference</A>, <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfPackageDocument.html?is-external=true#isRootDocument()" title="class or interface in org.odftoolkit.odfdom.pkg">isRootDocument</A>, <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfPackageDocument.html?is-external=true#loadSubDocument(java.lang.String)" title="class or interface in org.odftoolkit.odfdom.pkg">loadSubDocument</A>, <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfPackageDocument.html?is-external=true#normalizeDocumentPath(java.lang.String)" title="class or interface in org.odftoolkit.odfdom.pkg">normalizeDocumentPath</A>, <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfPackageDocument.html?is-external=true#removeDocument(java.lang.String)" title="class or interface in org.odftoolkit.odfdom.pkg">removeDocument</A>, <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfPackageDocument.html?is-external=true#save(java.lang.String)" title="class or interface in org.odftoolkit.odfdom.pkg">save</A>, <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfPackageDocument.html?is-external=true#setMediaTypeString(java.lang.String)" title="class or interface in org.odftoolkit.odfdom.pkg">setMediaTypeString</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.odftoolkit.simple.table.TableContainer"><!-- --></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.odftoolkit.simple.table.<A HREF="../../../org/odftoolkit/simple/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../org/odftoolkit/simple/table/TableContainer.html#getTableContainerElement()">getTableContainerElement</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_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>Constructor Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="Document(org.odftoolkit.odfdom.pkg.OdfPackage, java.lang.String, org.odftoolkit.simple.Document.OdfMediaType)"><!-- --></A><H3> |
| Document</H3> |
| <PRE> |
| protected <B>Document</B>(<A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfPackage.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.pkg">OdfPackage</A> pkg, |
| <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> internalPath, |
| <A HREF="../../../org/odftoolkit/simple/Document.OdfMediaType.html" title="enum in org.odftoolkit.simple">Document.OdfMediaType</A> mediaType)</PRE> |
| <DL> |
| </DL> |
| |
| <!-- ============ 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="loadTemplate(org.odftoolkit.odfdom.pkg.OdfPackageDocument.Resource, org.odftoolkit.simple.Document.OdfMediaType)"><!-- --></A><H3> |
| loadTemplate</H3> |
| <PRE> |
| protected static <A HREF="../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</A> <B>loadTemplate</B>(<A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfPackageDocument.Resource.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.pkg">OdfPackageDocument.Resource</A> res, |
| <A HREF="../../../org/odftoolkit/simple/Document.OdfMediaType.html" title="enum in org.odftoolkit.simple">Document.OdfMediaType</A> odfMediaType) |
| throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE> |
| <DL> |
| <DD>Loads an Document from the given resource. NOTE: Initial meta data will |
| be added in this method. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>res</CODE> - a resource containing a package with a root document<DD><CODE>odfMediaType</CODE> - the media type of the root document |
| <DT><B>Returns:</B><DD>the Document document or NULL if the media type is not supported |
| by SIMPLE. |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE> - - if the document could not be created.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="loadDocument(java.lang.String, java.lang.String)"><!-- --></A><H3> |
| loadDocument</H3> |
| <PRE> |
| public static <A HREF="../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</A> <B>loadDocument</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> documentPath, |
| <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> password) |
| throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE> |
| <DL> |
| <DD>Loads a Document from the provided path. |
| |
| <p> |
| Document relies on the file being available for read access over the |
| whole life cycle of Document. |
| </p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>documentPath</CODE> - - the path from where the document can be loaded<DD><CODE>password</CODE> - - file password. |
| <DT><B>Returns:</B><DD>the Document from the given path or NULL if the media type is not |
| supported by SIMPLE. |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE> - - if the document could not be created.<DT><B>Since:</B></DT> |
| <DD>0.8</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="loadDocument(java.lang.String)"><!-- --></A><H3> |
| loadDocument</H3> |
| <PRE> |
| public static <A HREF="../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</A> <B>loadDocument</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> documentPath) |
| throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE> |
| <DL> |
| <DD>Loads a Document from the provided path. |
| |
| <p> |
| Document relies on the file being available for read access over the |
| whole life cycle of Document. |
| </p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>documentPath</CODE> - - the path from where the document can be loaded |
| <DT><B>Returns:</B><DD>the Document from the given path or NULL if the media type is not |
| supported by SIMPLE. |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE> - - if the document could not be created.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="loadDocument(java.io.InputStream)"><!-- --></A><H3> |
| loadDocument</H3> |
| <PRE> |
| public static <A HREF="../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</A> <B>loadDocument</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A> inStream) |
| throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE> |
| <DL> |
| <DD>Creates a Document from the Document provided by a resource Stream. |
| |
| <p> |
| Since an InputStream does not provide the arbitrary (non sequentiell) |
| read access needed by Document, the InputStream is cached. This usually |
| takes more time compared to the other createInternalDocument methods. An |
| advantage of caching is that there are no problems overwriting an input |
| file. |
| </p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>inStream</CODE> - - the InputStream of the ODF document. |
| <DT><B>Returns:</B><DD>the document created from the given InputStream |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE> - - if the document could not be created.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="loadDocument(java.io.File)"><!-- --></A><H3> |
| loadDocument</H3> |
| <PRE> |
| public static <A HREF="../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</A> <B>loadDocument</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> file) |
| throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE> |
| <DL> |
| <DD>Creates a Document from the Document provided by a File. |
| |
| <p> |
| Document relies on the file being available for read access over the |
| whole lifecycle of Document. |
| </p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>file</CODE> - - a file representing the ODF document. |
| <DT><B>Returns:</B><DD>the document created from the given File |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE> - - if the document could not be created.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="loadDocument(java.io.File, java.lang.String)"><!-- --></A><H3> |
| loadDocument</H3> |
| <PRE> |
| public static <A HREF="../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</A> <B>loadDocument</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> file, |
| <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> password) |
| throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE> |
| <DL> |
| <DD>Creates a Document from the Document provided by a File. |
| |
| <p> |
| Document relies on the file being available for read access over the |
| whole lifecycle of Document. |
| </p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>file</CODE> - - a file representing the ODF document.<DD><CODE>password</CODE> - - file password. |
| <DT><B>Returns:</B><DD>the document created from the given File |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE> - - if the document could not be created.<DT><B>Since:</B></DT> |
| <DD>0.7</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="loadDocument(org.odftoolkit.odfdom.pkg.OdfPackage)"><!-- --></A><H3> |
| loadDocument</H3> |
| <PRE> |
| public static <A HREF="../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</A> <B>loadDocument</B>(<A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfPackage.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.pkg">OdfPackage</A> odfPackage) |
| throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE> |
| <DL> |
| <DD>Creates a Document from the Document provided by an ODF package. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>odfPackage</CODE> - - the ODF package containing the ODF document. |
| <DT><B>Returns:</B><DD>the root document of the given OdfPackage |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE> - - if the ODF document could not be created.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="loadDocument(org.odftoolkit.odfdom.pkg.OdfPackage, java.lang.String)"><!-- --></A><H3> |
| loadDocument</H3> |
| <PRE> |
| public static <A HREF="../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</A> <B>loadDocument</B>(<A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfPackage.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.pkg">OdfPackage</A> odfPackage, |
| <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> internalPath) |
| throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE> |
| <DL> |
| <DD>Creates a Document from the Document provided by an ODF package. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>odfPackage</CODE> - - the ODF package containing the ODF document.<DD><CODE>internalPath</CODE> - - the path to the ODF document relative to the |
| package root. |
| <DT><B>Returns:</B><DD>the root document of the given OdfPackage |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE> - - if the ODF document could not be created.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setPassword(java.lang.String)"><!-- --></A><H3> |
| setPassword</H3> |
| <PRE> |
| public void <B>setPassword</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> password)</PRE> |
| <DL> |
| <DD>Sets password of this document. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>password</CODE> - the password of this document.<DT><B>Since:</B></DT> |
| <DD>0.8</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getEmbeddedDocument(java.lang.String)"><!-- --></A><H3> |
| getEmbeddedDocument</H3> |
| <PRE> |
| public <A HREF="../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</A> <B>getEmbeddedDocument</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> documentPath)</PRE> |
| <DL> |
| <DD>Returns an embedded OdfPackageDocument from the given package path. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>documentPath</CODE> - path to the ODF document within the package. The path |
| is relative to the current document. |
| <DT><B>Returns:</B><DD>an embedded Document</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getEmbeddedDocuments()"><!-- --></A><H3> |
| getEmbeddedDocuments</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</A>> <B>getEmbeddedDocuments</B>()</PRE> |
| <DL> |
| <DD>Method returns all embedded OdfPackageDocuments, which match a valid |
| OdfMediaType, of the root OdfPackageDocument. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>a list with all embedded documents of the root OdfPackageDocument</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getEmbeddedDocuments(org.odftoolkit.simple.Document.OdfMediaType)"><!-- --></A><H3> |
| getEmbeddedDocuments</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/odftoolkit/simple/Document.html" title="class in org.odftoolkit.simple">Document</A>> <B>getEmbeddedDocuments</B>(<A HREF="../../../org/odftoolkit/simple/Document.OdfMediaType.html" title="enum in org.odftoolkit.simple">Document.OdfMediaType</A> mediaType)</PRE> |
| <DL> |
| <DD>Method returns all embedded OdfPackageDocuments of the root |
| OdfPackageDocument matching the according MediaType. This is done by |
| matching the subfolder entries of the manifest file with the given |
| OdfMediaType. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>mediaType</CODE> - media type which is used as a filter |
| <DT><B>Returns:</B><DD>embedded documents of the root OdfPackageDocument matching the |
| given media type</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="insertDocument(org.odftoolkit.odfdom.pkg.OdfPackageDocument, java.lang.String)"><!-- --></A><H3> |
| insertDocument</H3> |
| <PRE> |
| public void <B>insertDocument</B>(<A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfPackageDocument.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.pkg">OdfPackageDocument</A> sourceDocument, |
| <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> documentPath)</PRE> |
| <DL> |
| <DD>Embed an OdfPackageDocument to the current OdfPackageDocument. All the |
| file entries of child document will be embedded as well to the current |
| document package. |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfPackageDocument.html?is-external=true#insertDocument(org.odftoolkit.odfdom.pkg.OdfPackageDocument, java.lang.String)" title="class or interface in org.odftoolkit.odfdom.pkg">insertDocument</A></CODE> in class <CODE><A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfPackageDocument.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.pkg">OdfPackageDocument</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>documentPath</CODE> - to the directory the ODF document should be inserted |
| (relative to the current document).<DD><CODE>sourceDocument</CODE> - the OdfPackageDocument to be embedded.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setOdfMediaType(org.odftoolkit.simple.Document.OdfMediaType)"><!-- --></A><H3> |
| setOdfMediaType</H3> |
| <PRE> |
| protected void <B>setOdfMediaType</B>(<A HREF="../../../org/odftoolkit/simple/Document.OdfMediaType.html" title="enum in org.odftoolkit.simple">Document.OdfMediaType</A> odfMediaType)</PRE> |
| <DL> |
| <DD>Sets the media type of the Document |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>odfMediaType</CODE> - media type to be set</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getOdfMediaType()"><!-- --></A><H3> |
| getOdfMediaType</H3> |
| <PRE> |
| protected <A HREF="../../../org/odftoolkit/simple/Document.OdfMediaType.html" title="enum in org.odftoolkit.simple">Document.OdfMediaType</A> <B>getOdfMediaType</B>()</PRE> |
| <DL> |
| <DD>Gets the media type of the Document |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getOfficeMetadata()"><!-- --></A><H3> |
| getOfficeMetadata</H3> |
| <PRE> |
| public <A HREF="../../../org/odftoolkit/simple/meta/Meta.html" title="class in org.odftoolkit.simple.meta">Meta</A> <B>getOfficeMetadata</B>()</PRE> |
| <DL> |
| <DD>Get the meta data feature instance of the current document |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the meta data feature instance which represent |
| <code>office:meta</code> in the meta.xml</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="save(java.io.OutputStream)"><!-- --></A><H3> |
| save</H3> |
| <PRE> |
| public void <B>save</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A> out) |
| throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE> |
| <DL> |
| <DD>Save the document to an OutputStream. Delegate to the root document and |
| save possible embedded Documents. |
| |
| <p> |
| If the input file has been cached (this is the case when loading from an |
| InputStream), the input file can be overwritten. |
| </p> |
| |
| <p> |
| If not, the OutputStream may not point to the input file! Otherwise this |
| will result in unwanted behaviour and broken files. |
| </p> |
| |
| <p> |
| When save the embedded document to a stand alone document, all the file |
| entries of the embedded document will be copied to a new document |
| package. If the embedded document is outside of the current document |
| directory, you have to embed it to the sub directory and refresh the link |
| of the embedded document. you should reload it from the stream to get the |
| saved embedded document. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>out</CODE> - - the OutputStream to write the file to |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE> - if the document could not be saved</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="save(java.io.File)"><!-- --></A><H3> |
| save</H3> |
| <PRE> |
| public void <B>save</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> file) |
| throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE> |
| <DL> |
| <DD>Save the document to a given file. |
| |
| <p> |
| If the input file has been cached (this is the case when loading from an |
| InputStream), the input file can be overwritten. |
| </p> |
| |
| <p> |
| Otherwise it's allowed to overwrite the input file as long as the same |
| path name is used that was used for loading (no symbolic link foo2.odt |
| pointing to the loaded file foo1.odt, no network path X:\foo.odt pointing |
| to the loaded file D:\foo.odt). |
| </p> |
| |
| <p> |
| When saving the embedded document to a stand alone document, all files of |
| the embedded document will be copied to a new document package. If the |
| embedded document is outside of the current document directory, you have |
| to embed it to the sub directory and refresh the link of the embedded |
| document. You should reload it from the given file to get the saved |
| embedded document. |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfPackageDocument.html?is-external=true#save(java.io.File)" title="class or interface in org.odftoolkit.odfdom.pkg">save</A></CODE> in class <CODE><A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfPackageDocument.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.pkg">OdfPackageDocument</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>file</CODE> - - the file to save the document |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE> - if the document could not be saved</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="save(java.io.File, java.lang.String)"><!-- --></A><H3> |
| save</H3> |
| <PRE> |
| public void <B>save</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> file, |
| <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> password) |
| throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE> |
| <DL> |
| <DD>Save the document to a given file with given password. |
| |
| <p> |
| If the input file has been cached (this is the case when loading from an |
| InputStream), the input file can be overwritten. |
| </p> |
| |
| <p> |
| Otherwise it's allowed to overwrite the input file as long as the same |
| path name is used that was used for loading (no symbolic link foo2.odt |
| pointing to the loaded file foo1.odt, no network path X:\foo.odt pointing |
| to the loaded file D:\foo.odt). |
| </p> |
| |
| <p> |
| When saving the embedded document to a stand alone document, all files of |
| the embedded document will be copied to a new document package. If the |
| embedded document is outside of the current document directory, you have |
| to embed it to the sub directory and refresh the link of the embedded |
| document. You should reload it from the given file to get the saved |
| embedded document. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>file</CODE> - the file to save the document.<DD><CODE>file</CODE> - the password of this document. |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE> - if the document could not be saved<DT><B>Since:</B></DT> |
| <DD>0.8</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="close()"><!-- --></A><H3> |
| close</H3> |
| <PRE> |
| public void <B>close</B>()</PRE> |
| <DL> |
| <DD>Close the OdfPackage and release all temporary created data. Acter |
| execution of this method, this class is no longer usable. Do this as the |
| last action to free resources. Closing an already closed document has no |
| effect. Note that this will not close any cached documents. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true#close()" title="class or interface in java.io">close</A></CODE> in interface <CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/OdfSchemaDocument.html?is-external=true#close()" title="class or interface in org.odftoolkit.odfdom.dom">close</A></CODE> in class <CODE><A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/OdfSchemaDocument.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.dom">OdfSchemaDocument</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getContentRoot(java.lang.Class)"><!-- --></A><H3> |
| getContentRoot</H3> |
| <PRE> |
| protected <T extends <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfElement.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.pkg">OdfElement</A>> T <B>getContentRoot</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><T> clazz) |
| throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE> |
| <DL> |
| <DD>Get the content root of a document. |
| |
| You may prefer to use the getContentRoot methods of subclasses of |
| Document. Their return parameters are already casted to respective |
| subclasses of OdfElement. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>clazz</CODE> - the type of the content root, depend on the document type |
| <DT><B>Returns:</B><DD>the child element of office:body, e.g. office:text for text docs |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE> - if the file DOM could not be created.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getContentRoot()"><!-- --></A><H3> |
| getContentRoot</H3> |
| <PRE> |
| public <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfElement.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.pkg">OdfElement</A> <B>getContentRoot</B>() |
| throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE> |
| <DL> |
| <DD>Get the content root of a document. |
| |
| You may prefer to use the getContentRoot methods of subclasses of |
| Document. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the child element of office:body, e.g. office:text for text docs |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE> - if the file DOM could not be created.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="toString()"><!-- --></A><H3> |
| toString</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>toString</B>()</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A></CODE> in class <CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="newImage(java.net.URI)"><!-- --></A><H3> |
| newImage</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>newImage</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</A> imageUri)</PRE> |
| <DL> |
| <DD>Insert an Image from the specified uri to the end of the Document. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>imageUri</CODE> - The URI of the image that will be added to the document, |
| add image stream to the package, in the 'Pictures/' graphic directory |
| with the same image file name as in the URI. If the imageURI is relative |
| first the user.dir is taken to make it absolute. |
| <DT><B>Returns:</B><DD>Returns the internal package path of the image, which was created |
| based on the given URI.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setLocale(java.util.Locale)"><!-- --></A><H3> |
| setLocale</H3> |
| <PRE> |
| public void <B>setLocale</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</A> locale)</PRE> |
| <DL> |
| <DD><p> |
| Set a locale information. |
| <p> |
| The locale information will affect the language and country setting of |
| the document. Thus the font settings, the spell checkings and etc will be |
| affected. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>locale</CODE> - - an instance of Locale</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getScriptType(java.util.Locale)"><!-- --></A><H3> |
| getScriptType</H3> |
| <PRE> |
| public static <A HREF="../../../org/odftoolkit/simple/Document.ScriptType.html" title="enum in org.odftoolkit.simple">Document.ScriptType</A> <B>getScriptType</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</A> locale)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setLocale(java.util.Locale, org.odftoolkit.simple.Document.ScriptType)"><!-- --></A><H3> |
| setLocale</H3> |
| <PRE> |
| public void <B>setLocale</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</A> locale, |
| <A HREF="../../../org/odftoolkit/simple/Document.ScriptType.html" title="enum in org.odftoolkit.simple">Document.ScriptType</A> scriptType)</PRE> |
| <DL> |
| <DD><p> |
| Set a locale of a specific script type. |
| <p> |
| If the locale is not belone to the script type, nothing will happen. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>locale</CODE> - - Locale information<DD><CODE>scriptType</CODE> - - The script type</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getLocale(org.odftoolkit.simple.Document.ScriptType)"><!-- --></A><H3> |
| getLocale</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</A> <B>getLocale</B>(<A HREF="../../../org/odftoolkit/simple/Document.ScriptType.html" title="enum in org.odftoolkit.simple">Document.ScriptType</A> scriptType)</PRE> |
| <DL> |
| <DD><p> |
| Get a locale information of a specific script type. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>scriptType</CODE> - - The script type |
| <DT><B>Returns:</B><DD>the Locale information</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getSectionIterator()"><!-- --></A><H3> |
| getSectionIterator</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<A HREF="../../../org/odftoolkit/simple/text/Section.html" title="class in org.odftoolkit.simple.text">Section</A>> <B>getSectionIterator</B>()</PRE> |
| <DL> |
| <DD>This method will search both the document content and header/footer, |
| return an iterator of section objects. |
| <p> |
| The sections defined in embed document won't be covered. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>an iterator of Section objects</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getSectionByName(java.lang.String)"><!-- --></A><H3> |
| getSectionByName</H3> |
| <PRE> |
| public <A HREF="../../../org/odftoolkit/simple/text/Section.html" title="class in org.odftoolkit.simple.text">Section</A> <B>getSectionByName</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</PRE> |
| <DL> |
| <DD>This method will search both the document content and header/footer, |
| return a section with a specific name. |
| <p> |
| This method won't search in the embed document. |
| <p> |
| Null will be returned if there is no section found. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - - the name of a section |
| <DT><B>Returns:</B><DD>a section object with a specific name</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removeElementLinkedResource(org.odftoolkit.odfdom.pkg.OdfElement)"><!-- --></A><H3> |
| removeElementLinkedResource</H3> |
| <PRE> |
| public boolean <B>removeElementLinkedResource</B>(<A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfElement.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.pkg">OdfElement</A> odfElement)</PRE> |
| <DL> |
| <DD>Remove an ODF element from the document. All the resources that are only |
| related with this element will be removed at the same time. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>odfElement</CODE> - - the odf element that would be moved.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addTable()"><!-- --></A><H3> |
| addTable</H3> |
| <PRE> |
| public <A HREF="../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</A> <B>addTable</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../org/odftoolkit/simple/table/TableContainer.html#addTable()">TableContainer</A></CODE></B></DD> |
| <DD>Add a new Table to this container. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/odftoolkit/simple/table/TableContainer.html#addTable()">addTable</A></CODE> in interface <CODE><A HREF="../../../org/odftoolkit/simple/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>added table.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addTable(int, int)"><!-- --></A><H3> |
| addTable</H3> |
| <PRE> |
| public <A HREF="../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</A> <B>addTable</B>(int numRows, |
| int numCols)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../org/odftoolkit/simple/table/TableContainer.html#addTable(int, int)">TableContainer</A></CODE></B></DD> |
| <DD>Add a new Table to this container with a specified row number and column |
| number. |
| <p> |
| The table will be inserted at the end of the tableContainer. An unique |
| table name will be given, you may set a custom table name using the |
| <code>setTableName</code> method. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/odftoolkit/simple/table/TableContainer.html#addTable(int, int)">addTable</A></CODE> in interface <CODE><A HREF="../../../org/odftoolkit/simple/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>numRows</CODE> - the row number<DD><CODE>numCols</CODE> - the column number |
| <DT><B>Returns:</B><DD>a new instance of <code>Table</code></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getTableByName(java.lang.String)"><!-- --></A><H3> |
| getTableByName</H3> |
| <PRE> |
| public <A HREF="../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</A> <B>getTableByName</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../org/odftoolkit/simple/table/TableContainer.html#getTableByName(java.lang.String)">TableContainer</A></CODE></B></DD> |
| <DD>Return an instance of table feature with the specific table name. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/odftoolkit/simple/table/TableContainer.html#getTableByName(java.lang.String)">getTableByName</A></CODE> in interface <CODE><A HREF="../../../org/odftoolkit/simple/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - of the table being searched for. |
| <DT><B>Returns:</B><DD>an instance of table feature with the specific table name.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getTableList()"><!-- --></A><H3> |
| getTableList</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/odftoolkit/simple/table/Table.html" title="class in org.odftoolkit.simple.table">Table</A>> <B>getTableList</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../org/odftoolkit/simple/table/TableContainer.html#getTableList()">TableContainer</A></CODE></B></DD> |
| <DD>Return a list of table features in this document. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/odftoolkit/simple/table/TableContainer.html#getTableList()">getTableList</A></CODE> in interface <CODE><A HREF="../../../org/odftoolkit/simple/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>a list of table features in this document.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getTableBuilder()"><!-- --></A><H3> |
| getTableBuilder</H3> |
| <PRE> |
| public <A HREF="../../../org/odftoolkit/simple/table/Table.TableBuilder.html" title="class in org.odftoolkit.simple.table">Table.TableBuilder</A> <B>getTableBuilder</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../org/odftoolkit/simple/table/TableContainer.html#getTableBuilder()">TableContainer</A></CODE></B></DD> |
| <DD>Return the table builder of this document. Every document has a table |
| builder, which supplies all of the table creation realization, for |
| example newTable(). |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/odftoolkit/simple/table/TableContainer.html#getTableBuilder()">getTableBuilder</A></CODE> in interface <CODE><A HREF="../../../org/odftoolkit/simple/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the table builder of this document.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getTableContainerImpl()"><!-- --></A><H3> |
| getTableContainerImpl</H3> |
| <PRE> |
| protected <A HREF="../../../org/odftoolkit/simple/table/TableContainer.html" title="interface in org.odftoolkit.simple.table">TableContainer</A> <B>getTableContainerImpl</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getComponentMap()"><!-- --></A><H3> |
| getComponentMap</H3> |
| <PRE> |
| protected <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/IdentityHashMap.html?is-external=true" title="class or interface in java.util">IdentityHashMap</A><<A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfElement.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.pkg">OdfElement</A>,<A HREF="../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">Component</A>> <B>getComponentMap</B>()</PRE> |
| <DL> |
| <DD>Return the component repository of this document. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the component repository of this document.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="LoadTableTemplateFromForeignTable(java.io.InputStream, java.lang.String)"><!-- --></A><H3> |
| LoadTableTemplateFromForeignTable</H3> |
| <PRE> |
| public <A HREF="../../../org/odftoolkit/simple/table/TableTemplate.html" title="class in org.odftoolkit.simple.table">TableTemplate</A> <B>LoadTableTemplateFromForeignTable</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A> templateFileInputStream, |
| <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> tableName) |
| throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE> |
| <DL> |
| <DD>Construct a |
| |
| |
| <code>TableTemplate<code> feature by extracting style template from an pre-defined table in a foreign document. The styles loaded by the template will be copied into the document as well and can be referenced by table directly. |
| <p> |
| The imported table need to be at least a 5*5 table (e.g. A1E5). Each type |
| of style in the template will be set according to the style reference in |
| a specific table cell, as following: |
| <br>first column - A2 |
| <br>last column - E2 |
| <br>first row - A2 |
| <br>last row - E2 |
| <br>even rows - B3 |
| <br>odd rows - B2 |
| <br>even columns - C2 |
| <br>odd columns - B2 |
| <br>body - B2 |
| <br>first-row-start-column -A1 |
| <br>first-row-end-column -E1 |
| <br>last-row-start-column -A5 |
| <br>last-row-end-column -E5 |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>templateFileInputStream</CODE> - - the InputStream of the ODF document.<DD><CODE>tableName</CODE> - - the table name which will be used to load styles as |
| template |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE> - - if content DOM could not be initialized</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/Document.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/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple"><B>PREV CLASS</B></A> |
| <A HREF="../../../org/odftoolkit/simple/Document.OdfMediaType.html" title="enum in org.odftoolkit.simple"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../index.html?org/odftoolkit/simple/Document.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="Document.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: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#fields_inherited_from_class_org.odftoolkit.odfdom.dom.OdfSchemaDocument">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2010-2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |
