| <!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:11:02 CEST 2017 --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| OdfDocument (ODFDOM API v0.8.11-incubating - http://incubator.apache.org/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="OdfDocument (ODFDOM API v0.8.11-incubating - http://incubator.apache.org/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/OdfDocument.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/odfdom/doc/OdfChartDocument.OdfMediaType.html" title="enum in org.odftoolkit.odfdom.doc"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.OdfMediaType.html" title="enum in org.odftoolkit.odfdom.doc"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/odftoolkit/odfdom/doc/OdfDocument.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="OdfDocument.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.odfdom.doc</FONT> |
| <BR> |
| Class OdfDocument</H2> |
| <PRE> |
| <A HREF="http://docs.oracle.com/javase/8/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="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html" title="class in org.odftoolkit.odfdom.pkg">org.odftoolkit.odfdom.pkg.OdfPackageDocument</A> |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html" title="class in org.odftoolkit.odfdom.dom">org.odftoolkit.odfdom.dom.OdfSchemaDocument</A> |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.odftoolkit.odfdom.doc.OdfDocument</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</A></DD> |
| </DL> |
| <DL> |
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/odftoolkit/odfdom/doc/OdfChartDocument.html" title="class in org.odftoolkit.odfdom.doc">OdfChartDocument</A>, <A HREF="../../../../org/odftoolkit/odfdom/doc/OdfGraphicsDocument.html" title="class in org.odftoolkit.odfdom.doc">OdfGraphicsDocument</A>, <A HREF="../../../../org/odftoolkit/odfdom/doc/OdfImageDocument.html" title="class in org.odftoolkit.odfdom.doc">OdfImageDocument</A>, <A HREF="../../../../org/odftoolkit/odfdom/doc/OdfPresentationDocument.html" title="class in org.odftoolkit.odfdom.doc">OdfPresentationDocument</A>, <A HREF="../../../../org/odftoolkit/odfdom/doc/OdfSpreadsheetDocument.html" title="class in org.odftoolkit.odfdom.doc">OdfSpreadsheetDocument</A>, <A HREF="../../../../org/odftoolkit/odfdom/doc/OdfTextDocument.html" title="class in org.odftoolkit.odfdom.doc">OdfTextDocument</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public abstract class <B>OdfDocument</B><DT>extends <A HREF="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html" title="class in org.odftoolkit.odfdom.dom">OdfSchemaDocument</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/odfdom/doc/OdfDocument.OdfMediaType.html" title="enum in org.odftoolkit.odfdom.doc">OdfDocument.OdfMediaType</A></B></CODE> |
| |
| <BR> |
| This enum contains all possible media types of OpenDocument 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/odfdom/doc/OdfDocument.UnicodeGroup.html" title="enum in org.odftoolkit.odfdom.doc">OdfDocument.UnicodeGroup</A></B></CODE> |
| |
| <BR> |
| |
| Unicode characters are in general divided by office applications into |
| three different groups.</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="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html" title="class in org.odftoolkit.odfdom.dom">OdfSchemaDocument</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.OdfXMLFile.html" title="enum 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="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackageDocument</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.Resource.html" title="class 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="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html" title="class in org.odftoolkit.odfdom.dom">OdfSchemaDocument</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#mContentDom">mContentDom</A>, <A HREF="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#mDocumentStyles">mDocumentStyles</A>, <A HREF="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#mMetaDom">mMetaDom</A>, <A HREF="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#mSettingsDom">mSettingsDom</A>, <A HREF="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#mStylesDom">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="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackageDocument</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html#mDocumentMediaType">mDocumentMediaType</A>, <A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html#mDocumentPathInPackage">mDocumentPathInPackage</A>, <A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html#mPackage">mPackage</A>, <A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html#ROOT_DOCUMENT_PATH">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/odfdom/doc/OdfDocument.html#OdfDocument(org.odftoolkit.odfdom.pkg.OdfPackage, java.lang.String, org.odftoolkit.odfdom.doc.OdfDocument.OdfMediaType)">OdfDocument</A></B>(<A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackage</A> pkg, |
| <A HREF="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> internalPath, |
| <A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.OdfMediaType.html" title="enum in org.odftoolkit.odfdom.doc">OdfDocument.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> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.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> <A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfElement.html" title="class in org.odftoolkit.odfdom.pkg">OdfElement</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.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> <A HREF="http://docs.oracle.com/javase/8/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/odfdom/doc/OdfDocument.html#getLocale(org.odftoolkit.odfdom.doc.OdfDocument.UnicodeGroup)">getLocale</A></B>(<A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.UnicodeGroup.html" title="enum in org.odftoolkit.odfdom.doc">OdfDocument.UnicodeGroup</A> unicodeGroup)</CODE> |
| |
| <BR> |
| This method will return Locale, which presents the default |
| language and country information settings in this document</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.OdfMediaType.html" title="enum in org.odftoolkit.odfdom.doc">OdfDocument.OdfMediaType</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html#getOdfMediaType()">getOdfMediaType</A></B>()</CODE> |
| |
| <BR> |
| Gets the media type of the OdfDocument</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/odftoolkit/odfdom/incubator/meta/OdfOfficeMeta.html" title="class in org.odftoolkit.odfdom.incubator.meta">OdfOfficeMeta</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.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> <A HREF="../../../../org/odftoolkit/odfdom/doc/table/OdfTable.html" title="class in org.odftoolkit.odfdom.doc.table">OdfTable</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html#getTableByName(java.lang.String)">getTableByName</A></B>(<A HREF="http://docs.oracle.com/javase/8/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> <A HREF="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../org/odftoolkit/odfdom/doc/table/OdfTable.html" title="class in org.odftoolkit.odfdom.doc.table">OdfTable</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.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>static <A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.UnicodeGroup.html" title="enum in org.odftoolkit.odfdom.doc">OdfDocument.UnicodeGroup</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html#getUnicodeGroup(java.util.Locale)">getUnicodeGroup</A></B>(<A HREF="http://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</A> locale)</CODE> |
| |
| <BR> |
| Similar to OpenOffice.org, ODFDOM assumes that every Locale is related |
| to one of the three Unicodes Groups, either CJK, CTL or Western.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html" title="class in org.odftoolkit.odfdom.doc">OdfDocument</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html#loadDocument(java.io.File)">loadDocument</A></B>(<A HREF="http://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> file)</CODE> |
| |
| <BR> |
| Loads the ODF root document from the ODF package provided as 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/odfdom/doc/OdfDocument.html" title="class in org.odftoolkit.odfdom.doc">OdfDocument</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html#loadDocument(java.io.InputStream)">loadDocument</A></B>(<A HREF="http://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A> inStream)</CODE> |
| |
| <BR> |
| Loads the ODF root document from the ODF package provided by a Stream.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html" title="class in org.odftoolkit.odfdom.doc">OdfDocument</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html#loadDocument(org.odftoolkit.odfdom.pkg.OdfPackage)">loadDocument</A></B>(<A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackage</A> odfPackage)</CODE> |
| |
| <BR> |
| Loads the ODF root document from the 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/odfdom/doc/OdfDocument.html" title="class in org.odftoolkit.odfdom.doc">OdfDocument</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html#loadDocument(org.odftoolkit.odfdom.pkg.OdfPackage, java.lang.String)">loadDocument</A></B>(<A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackage</A> odfPackage, |
| <A HREF="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> internalPath)</CODE> |
| |
| <BR> |
| Creates an OdfDocument from the OpenDocument 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/odfdom/doc/OdfDocument.html" title="class in org.odftoolkit.odfdom.doc">OdfDocument</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html#loadDocument(java.lang.String)">loadDocument</A></B>(<A HREF="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> documentPath)</CODE> |
| |
| <BR> |
| Loads the ODF root document from the ODF package provided by its path.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html" title="class in org.odftoolkit.odfdom.doc">OdfDocument</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html#loadSubDocument(java.lang.String)">loadSubDocument</A></B>(<A HREF="http://docs.oracle.com/javase/8/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://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,<A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html" title="class in org.odftoolkit.odfdom.doc">OdfDocument</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html#loadSubDocuments()">loadSubDocuments</A></B>()</CODE> |
| |
| <BR> |
| Method returns all embedded OdfPackageDocuments, which match a valid OdfMediaType, |
| of the current OdfPackageDocument.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,<A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html" title="class in org.odftoolkit.odfdom.doc">OdfDocument</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html#loadSubDocuments(org.odftoolkit.odfdom.doc.OdfDocument.OdfMediaType)">loadSubDocuments</A></B>(<A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.OdfMediaType.html" title="enum in org.odftoolkit.odfdom.doc">OdfDocument.OdfMediaType</A> desiredMediaType)</CODE> |
| |
| <BR> |
| Method returns all embedded OdfPackageDocuments of sthe current OdfPackageDocument matching the |
| according MediaType.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected static <A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html" title="class in org.odftoolkit.odfdom.doc">OdfDocument</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html#loadTemplate(org.odftoolkit.odfdom.pkg.OdfPackageDocument.Resource, org.odftoolkit.odfdom.doc.OdfDocument.OdfMediaType)">loadTemplate</A></B>(<A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.Resource.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackageDocument.Resource</A> res, |
| <A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.OdfMediaType.html" title="enum in org.odftoolkit.odfdom.doc">OdfDocument.OdfMediaType</A> odfMediaType)</CODE> |
| |
| <BR> |
| Loads the ODF root 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://docs.oracle.com/javase/8/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/odfdom/doc/OdfDocument.html#newImage(java.net.URI)">newImage</A></B>(<A HREF="http://docs.oracle.com/javase/8/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 OdfDocument.</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/odfdom/doc/OdfDocument.html#save(java.io.File)">save</A></B>(<A HREF="http://docs.oracle.com/javase/8/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/odfdom/doc/OdfDocument.html#save(java.io.OutputStream)">save</A></B>(<A HREF="http://docs.oracle.com/javase/8/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/odfdom/doc/OdfDocument.html#setLocale(java.util.Locale)">setLocale</A></B>(<A HREF="http://docs.oracle.com/javase/8/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>protected void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html#setOdfMediaType(org.odftoolkit.odfdom.doc.OdfDocument.OdfMediaType)">setOdfMediaType</A></B>(<A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.OdfMediaType.html" title="enum in org.odftoolkit.odfdom.doc">OdfDocument.OdfMediaType</A> odfMediaType)</CODE> |
| |
| <BR> |
| Sets the media type of the OdfDocument</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://docs.oracle.com/javase/8/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/odfdom/doc/OdfDocument.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="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html" title="class in org.odftoolkit.odfdom.dom">OdfSchemaDocument</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getBaseURI()">getBaseURI</A>, <A HREF="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getBookmarkRDFMetadata()">getBookmarkRDFMetadata</A>, <A HREF="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getContentDom()">getContentDom</A>, <A HREF="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getContentStream()">getContentStream</A>, <A HREF="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getDocumentStyles()">getDocumentStyles</A>, <A HREF="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getFileDom(org.odftoolkit.odfdom.dom.OdfSchemaDocument.OdfXMLFile)">getFileDom</A>, <A HREF="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getInContentMetadata()">getInContentMetadata</A>, <A HREF="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getInContentMetadataFromCache()">getInContentMetadataFromCache</A>, <A HREF="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getManifestRDFMetadata()">getManifestRDFMetadata</A>, <A HREF="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getMasterPages()">getMasterPages</A>, <A HREF="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getMetaDom()">getMetaDom</A>, <A HREF="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getMetaStream()">getMetaStream</A>, <A HREF="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getOfficeMasterStyles()">getOfficeMasterStyles</A>, <A HREF="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getOrCreateDocumentStyles()">getOrCreateDocumentStyles</A>, <A HREF="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getRDFMetadata()">getRDFMetadata</A>, <A HREF="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getSettingsDom()">getSettingsDom</A>, <A HREF="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getSettingsStream()">getSettingsStream</A>, <A HREF="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getStylesDom()">getStylesDom</A>, <A HREF="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getStylesStream()">getStylesStream</A>, <A HREF="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getTables()">getTables</A>, <A HREF="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#getXMLFilePath(org.odftoolkit.odfdom.dom.OdfSchemaDocument.OdfXMLFile)">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="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackageDocument</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html#flushDoms()">flushDoms</A>, <A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html#getDocumentPath()">getDocumentPath</A>, <A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html#getFileDom(java.lang.String)">getFileDom</A>, <A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html#getMediaTypeString()">getMediaTypeString</A>, <A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html#getPackage()">getPackage</A>, <A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html#getXMLFileMetadata(java.lang.String)">getXMLFileMetadata</A>, <A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html#insertDocument(org.odftoolkit.odfdom.pkg.OdfPackageDocument, java.lang.String)">insertDocument</A>, <A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html#isExternalReference(java.lang.String)">isExternalReference</A>, <A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html#isRootDocument()">isRootDocument</A>, <A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html#normalizeDocumentPath(java.lang.String)">normalizeDocumentPath</A>, <A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html#removeDocument(java.lang.String)">removeDocument</A>, <A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html#save(java.lang.String)">save</A>, <A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html#setMediaTypeString(java.lang.String)">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://docs.oracle.com/javase/8/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://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://docs.oracle.com/javase/8/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://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://docs.oracle.com/javase/8/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> |
| |
| <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="OdfDocument(org.odftoolkit.odfdom.pkg.OdfPackage, java.lang.String, org.odftoolkit.odfdom.doc.OdfDocument.OdfMediaType)"><!-- --></A><H3> |
| OdfDocument</H3> |
| <PRE> |
| protected <B>OdfDocument</B>(<A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackage</A> pkg, |
| <A HREF="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> internalPath, |
| <A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.OdfMediaType.html" title="enum in org.odftoolkit.odfdom.doc">OdfDocument.OdfMediaType</A> mediaType) |
| throws <A HREF="http://docs.oracle.com/javase/8/docs/api/org/xml/sax/SAXException.html?is-external=true" title="class or interface in org.xml.sax">SAXException</A></PRE> |
| <DL> |
| <DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://docs.oracle.com/javase/8/docs/api/org/xml/sax/SAXException.html?is-external=true" title="class or interface in org.xml.sax">SAXException</A></CODE></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.odfdom.doc.OdfDocument.OdfMediaType)"><!-- --></A><H3> |
| loadTemplate</H3> |
| <PRE> |
| protected static <A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html" title="class in org.odftoolkit.odfdom.doc">OdfDocument</A> <B>loadTemplate</B>(<A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.Resource.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackageDocument.Resource</A> res, |
| <A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.OdfMediaType.html" title="enum in org.odftoolkit.odfdom.doc">OdfDocument.OdfMediaType</A> odfMediaType) |
| throws <A HREF="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE> |
| <DL> |
| <DD>Loads the ODF root document from the given Resource. |
| |
| NOTE: Initial meta data (like the document creation time) will be added in this method. |
| <P> |
| <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 OpenDocument document |
| or NULL if the media type is not supported by ODFDOM. |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://docs.oracle.com/javase/8/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)"><!-- --></A><H3> |
| loadDocument</H3> |
| <PRE> |
| public static <A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html" title="class in org.odftoolkit.odfdom.doc">OdfDocument</A> <B>loadDocument</B>(<A HREF="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> documentPath) |
| throws <A HREF="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE> |
| <DL> |
| <DD>Loads the ODF root document from the ODF package provided by its path. |
| |
| <p>OdfDocument relies on the file being available for read access over |
| the whole lifecycle of OdfDocument.</p> |
| <P> |
| <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 OpenDocument from the given path |
| or NULL if the media type is not supported by ODFDOM. |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://docs.oracle.com/javase/8/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/odfdom/doc/OdfDocument.html" title="class in org.odftoolkit.odfdom.doc">OdfDocument</A> <B>loadDocument</B>(<A HREF="http://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A> inStream) |
| throws <A HREF="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE> |
| <DL> |
| <DD>Loads the ODF root document from the ODF package provided by a Stream. |
| |
| <p>Since an InputStream does not provide the arbitrary (non sequentiell) |
| read access needed by OdfDocument, 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> |
| <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://docs.oracle.com/javase/8/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/odfdom/doc/OdfDocument.html" title="class in org.odftoolkit.odfdom.doc">OdfDocument</A> <B>loadDocument</B>(<A HREF="http://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> file) |
| throws <A HREF="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE> |
| <DL> |
| <DD>Loads the ODF root document from the ODF package provided as a File. |
| <P> |
| <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://docs.oracle.com/javase/8/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(org.odftoolkit.odfdom.pkg.OdfPackage)"><!-- --></A><H3> |
| loadDocument</H3> |
| <PRE> |
| public static <A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html" title="class in org.odftoolkit.odfdom.doc">OdfDocument</A> <B>loadDocument</B>(<A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackage</A> odfPackage) |
| throws <A HREF="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE> |
| <DL> |
| <DD>Loads the ODF root document from the ODF package. |
| <P> |
| <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://docs.oracle.com/javase/8/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/odfdom/doc/OdfDocument.html" title="class in org.odftoolkit.odfdom.doc">OdfDocument</A> <B>loadDocument</B>(<A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackage</A> odfPackage, |
| <A HREF="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> internalPath) |
| throws <A HREF="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE> |
| <DL> |
| <DD>Creates an OdfDocument from the OpenDocument provided by an ODF package. |
| <P> |
| <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, or an empty String for the root document. |
| <DT><B>Returns:</B><DD>the root document of the given OdfPackage |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://docs.oracle.com/javase/8/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="loadSubDocument(java.lang.String)"><!-- --></A><H3> |
| loadSubDocument</H3> |
| <PRE> |
| public <A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html" title="class in org.odftoolkit.odfdom.doc">OdfDocument</A> <B>loadSubDocument</B>(<A HREF="http://docs.oracle.com/javase/8/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> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html#loadSubDocument(java.lang.String)">loadSubDocument</A></CODE> in class <CODE><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackageDocument</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>documentPath</CODE> - to the ODF document within the package. The path is relative the current ODF document path. |
| <DT><B>Returns:</B><DD>an embedded OdfPackageDocument</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="loadSubDocuments()"><!-- --></A><H3> |
| loadSubDocuments</H3> |
| <PRE> |
| public <A HREF="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,<A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html" title="class in org.odftoolkit.odfdom.doc">OdfDocument</A>> <B>loadSubDocuments</B>()</PRE> |
| <DL> |
| <DD>Method returns all embedded OdfPackageDocuments, which match a valid OdfMediaType, |
| of the current OdfPackageDocument. Note: The root document is not part of the returned collection. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>a map with all embedded documents and their paths of the current OdfPackageDocument</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="loadSubDocuments(org.odftoolkit.odfdom.doc.OdfDocument.OdfMediaType)"><!-- --></A><H3> |
| loadSubDocuments</H3> |
| <PRE> |
| public <A HREF="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,<A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.html" title="class in org.odftoolkit.odfdom.doc">OdfDocument</A>> <B>loadSubDocuments</B>(<A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.OdfMediaType.html" title="enum in org.odftoolkit.odfdom.doc">OdfDocument.OdfMediaType</A> desiredMediaType)</PRE> |
| <DL> |
| <DD>Method returns all embedded OdfPackageDocuments of sthe current OdfPackageDocument matching the |
| according MediaType. This is done by matching the subfolder entries of the |
| manifest file with the given OdfMediaType. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>desiredMediaType</CODE> - media type of the documents to be returned (used as a filter). |
| <DT><B>Returns:</B><DD>embedded documents of the current OdfPackageDocument matching the given media type</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setOdfMediaType(org.odftoolkit.odfdom.doc.OdfDocument.OdfMediaType)"><!-- --></A><H3> |
| setOdfMediaType</H3> |
| <PRE> |
| protected void <B>setOdfMediaType</B>(<A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.OdfMediaType.html" title="enum in org.odftoolkit.odfdom.doc">OdfDocument.OdfMediaType</A> odfMediaType)</PRE> |
| <DL> |
| <DD>Sets the media type of the OdfDocument |
| <P> |
| <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/odfdom/doc/OdfDocument.OdfMediaType.html" title="enum in org.odftoolkit.odfdom.doc">OdfDocument.OdfMediaType</A> <B>getOdfMediaType</B>()</PRE> |
| <DL> |
| <DD>Gets the media type of the OdfDocument |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getOfficeMetadata()"><!-- --></A><H3> |
| getOfficeMetadata</H3> |
| <PRE> |
| public <A HREF="../../../../org/odftoolkit/odfdom/incubator/meta/OdfOfficeMeta.html" title="class in org.odftoolkit.odfdom.incubator.meta">OdfOfficeMeta</A> <B>getOfficeMetadata</B>()</PRE> |
| <DL> |
| <DD>Get the meta data feature instance of the current document |
| <P> |
| <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://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A> out) |
| throws <A HREF="http://docs.oracle.com/javase/8/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 OdfDocuments. |
| |
| <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> |
| <DT><B>Parameters:</B><DD><CODE>out</CODE> - - the OutputStream to write the file to |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://docs.oracle.com/javase/8/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://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> file) |
| throws <A HREF="http://docs.oracle.com/javase/8/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="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html#save(java.io.File)">save</A></CODE> in class <CODE><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html" title="class 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://docs.oracle.com/javase/8/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="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. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="http://docs.oracle.com/javase/8/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://docs.oracle.com/javase/8/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="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html#close()">close</A></CODE> in class <CODE><A HREF="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html" title="class in org.odftoolkit.odfdom.dom">OdfSchemaDocument</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getContentRoot()"><!-- --></A><H3> |
| getContentRoot</H3> |
| <PRE> |
| public <A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfElement.html" title="class in org.odftoolkit.odfdom.pkg">OdfElement</A> <B>getContentRoot</B>() |
| throws <A HREF="http://docs.oracle.com/javase/8/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 |
| OdfDocument. |
| <P> |
| <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://docs.oracle.com/javase/8/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://docs.oracle.com/javase/8/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://docs.oracle.com/javase/8/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://docs.oracle.com/javase/8/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://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>newImage</B>(<A HREF="http://docs.oracle.com/javase/8/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 OdfDocument. |
| <P> |
| <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="getTableByName(java.lang.String)"><!-- --></A><H3> |
| getTableByName</H3> |
| <PRE> |
| public <A HREF="../../../../org/odftoolkit/odfdom/doc/table/OdfTable.html" title="class in org.odftoolkit.odfdom.doc.table">OdfTable</A> <B>getTableByName</B>(<A HREF="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</PRE> |
| <DL> |
| <DD>Return an instance of table feature with the specific table name. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - of the table beeing 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://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../org/odftoolkit/odfdom/doc/table/OdfTable.html" title="class in org.odftoolkit.odfdom.doc.table">OdfTable</A>> <B>getTableList</B>()</PRE> |
| <DL> |
| <DD>Return a list of table features in this document. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>a list of table features in this document.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setLocale(java.util.Locale)"><!-- --></A><H3> |
| setLocale</H3> |
| <PRE> |
| public void <B>setLocale</B>(<A HREF="http://docs.oracle.com/javase/8/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> |
| <DT><B>Parameters:</B><DD><CODE>locale</CODE> - - an instance of Locale</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getUnicodeGroup(java.util.Locale)"><!-- --></A><H3> |
| getUnicodeGroup</H3> |
| <PRE> |
| public static <A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.UnicodeGroup.html" title="enum in org.odftoolkit.odfdom.doc">OdfDocument.UnicodeGroup</A> <B>getUnicodeGroup</B>(<A HREF="http://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</A> locale)</PRE> |
| <DL> |
| <DD>Similar to OpenOffice.org, ODFDOM assumes that every Locale is related |
| to one of the three Unicodes Groups, either CJK, CTL or Western. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>locale</CODE> - the UnicodeGroup is requested for |
| <DT><B>Returns:</B><DD>the related UnicodeGroup</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getLocale(org.odftoolkit.odfdom.doc.OdfDocument.UnicodeGroup)"><!-- --></A><H3> |
| getLocale</H3> |
| <PRE> |
| public <A HREF="http://docs.oracle.com/javase/8/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/odfdom/doc/OdfDocument.UnicodeGroup.html" title="enum in org.odftoolkit.odfdom.doc">OdfDocument.UnicodeGroup</A> unicodeGroup)</PRE> |
| <DL> |
| <DD>This method will return Locale, which presents the default |
| language and country information settings in this document |
| <p> |
| ODF allows to set a Locale for each of the three UnicodeGroups. |
| Therefore there might be three different Locale for the document. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>unicodeGroup</CODE> - - One of the three (CJK, CTL or Western). |
| <DT><B>Returns:</B><DD>the Locale for the given UnicodeGroup</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/OdfDocument.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/odfdom/doc/OdfChartDocument.OdfMediaType.html" title="enum in org.odftoolkit.odfdom.doc"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/odftoolkit/odfdom/doc/OdfDocument.OdfMediaType.html" title="enum in org.odftoolkit.odfdom.doc"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/odftoolkit/odfdom/doc/OdfDocument.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="OdfDocument.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 © 2008-2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |
