| <!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:12:02 CEST 2017 --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| OdfPackage (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="OdfPackage (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/OdfPackage.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/pkg/OdfNamespace.html" title="class in org.odftoolkit.odfdom.pkg"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.OdfFile.html" title="enum in org.odftoolkit.odfdom.pkg"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/odftoolkit/odfdom/pkg/OdfPackage.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="OdfPackage.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> | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.odftoolkit.odfdom.pkg</FONT> |
| <BR> |
| Class OdfPackage</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 "><B>org.odftoolkit.odfdom.pkg.OdfPackage</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> |
| <HR> |
| <DL> |
| <DT><PRE>public class <B>OdfPackage</B><DT>extends <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><DT>implements <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></DL> |
| </PRE> |
| |
| <P> |
| OdfPackage represents the package view to an OpenDocument document. The OdfPackage will be |
| created from an ODF document and represents a copy of the loaded document, where files can be |
| inserted and deleted. The changes take effect, when the OdfPackage is being made persisted by |
| save(). |
| <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/pkg/OdfPackage.OdfFile.html" title="enum in org.odftoolkit.odfdom.pkg">OdfPackage.OdfFile</A></B></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/pkg/OdfPackage.html#close()">close</A></B>()</CODE> |
| |
| <BR> |
| Close the OdfPackage after it is no longer needed.</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/odfdom/pkg/OdfPackage.html#contains(java.lang.String)">contains</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> internalPath)</CODE> |
| |
| <BR> |
| Check existence of a file in the package.</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/pkg/OdfPackage.html#getBaseURI()">getBaseURI</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> byte[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getBytes(java.lang.String)">getBytes</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> internalPath)</CODE> |
| |
| <BR> |
| Get package (sub-) content as byte array</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackageDocument</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getCachedDocument(java.lang.String)">getCachedDocument</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> internalPath)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>This method is only added temporary as workaround for the IBM fork using |
| different DOC classes. Until the registering of DOC documents to the PKG layer has been |
| finished.</I></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/Set.html?is-external=true" title="class or interface in java.util">Set</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>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getDocumentPaths()">getDocumentPaths</A></B>()</CODE> |
| |
| <BR> |
| Method returns the paths of all document within the package.</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/Set.html?is-external=true" title="class or interface in java.util">Set</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>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getDocumentPaths(java.lang.String)">getDocumentPaths</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> mediaTypeString)</CODE> |
| |
| <BR> |
| Method returns the paths of all document within the package matching the given criteria.</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/org/w3c/dom/Document.html?is-external=true" title="class or interface in org.w3c.dom">Document</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getDom(java.lang.String)">getDom</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> internalPath)</CODE> |
| |
| <BR> |
| Gets org.w3c.dom.Document for XML file contained in package.</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/org/xml/sax/EntityResolver.html?is-external=true" title="class or interface in org.xml.sax">EntityResolver</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getEntityResolver()">getEntityResolver</A></B>()</CODE> |
| |
| <BR> |
| Get EntityResolver to be used in XML Parsers which can resolve content inside the OdfPackage</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/org/xml/sax/ErrorHandler.html?is-external=true" title="class or interface in org.xml.sax">ErrorHandler</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getErrorHandler()">getErrorHandler</A></B>()</CODE> |
| |
| <BR> |
| Return the current error handler used for ODF validation.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/odftoolkit/odfdom/pkg/manifest/OdfFileEntry.html" title="class in org.odftoolkit.odfdom.pkg.manifest">OdfFileEntry</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getFileEntry(java.lang.String)">getFileEntry</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> internalPath)</CODE> |
| |
| <BR> |
| Get an OdfFileEntry for the internalPath NOTE: This method should be better moved to a DOM |
| inherited Manifest class</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/Set.html?is-external=true" title="class or interface in java.util">Set</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>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getFilePaths()">getFilePaths</A></B>()</CODE> |
| |
| <BR> |
| Get a OdfFileEntries from the manifest file (i.e.</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/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getInputStream()">getInputStream</A></B>()</CODE> |
| |
| <BR> |
| Gets the InputStream containing whole OdfPackage.</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/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getInputStream(java.lang.String)">getInputStream</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> internalPath)</CODE> |
| |
| <BR> |
| Get the latest version of package content as InputStream, as it would be saved.</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/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getInputStream(java.lang.String, boolean)">getInputStream</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> internalPath, |
| boolean useOriginal)</CODE> |
| |
| <BR> |
| Get the latest version of package content as InputStream, as it would be saved.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/odftoolkit/odfdom/pkg/manifest/OdfManifestDom.html" title="class in org.odftoolkit.odfdom.pkg.manifest">OdfManifestDom</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getManifestDom()">getManifestDom</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://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/pkg/OdfPackage.html#getMediaTypeString()">getMediaTypeString</A></B>()</CODE> |
| |
| <BR> |
| Get the media type of the ODF package (equal to media type of ODF root 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/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/pkg/OdfPackage.html#getMediaTypeString(java.lang.String)">getMediaTypeString</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> internalPath)</CODE> |
| |
| <BR> |
| Get the media type of the ODF file or document (ie.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackageDocument</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getRootDocument()">getRootDocument</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> long</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getSize(java.lang.String)">getSize</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> internalPath)</CODE> |
| |
| <BR> |
| Get the size of an internal file from the package.</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/javax/xml/transform/URIResolver.html?is-external=true" title="class or interface in javax.xml.transform">URIResolver</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getURIResolver()">getURIResolver</A></B>()</CODE> |
| |
| <BR> |
| Get URIResolver to be used in XSL Transformations which can resolve content inside the |
| OdfPackage</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/pkg/OdfPackage.html#insert(byte[], java.lang.String, java.lang.String)">insert</A></B>(byte[] fileBytes, |
| <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="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> mediaTypeString)</CODE> |
| |
| <BR> |
| Inserts a byte array into OdfPackage.</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/pkg/OdfPackage.html#insert(org.w3c.dom.Document, java.lang.String, java.lang.String)">insert</A></B>(<A HREF="http://docs.oracle.com/javase/8/docs/api/org/w3c/dom/Document.html?is-external=true" title="class or interface in org.w3c.dom">Document</A> fileDOM, |
| <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="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> mediaType)</CODE> |
| |
| <BR> |
| Insert DOM tree into OdfPackage.</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/pkg/OdfPackage.html#insert(java.io.InputStream, java.lang.String, java.lang.String)">insert</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> fileStream, |
| <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="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> mediaType)</CODE> |
| |
| <BR> |
| Inserts InputStream into an OdfPackage.</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/pkg/OdfPackage.html#insert(java.net.URI, java.lang.String, java.lang.String)">insert</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> sourceURI, |
| <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="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> mediaType)</CODE> |
| |
| <BR> |
| Inserts an external file into an OdfPackage.</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/pkg/OdfPackage.html#insertDocument(org.odftoolkit.odfdom.pkg.OdfPackageDocument, java.lang.String)">insertDocument</A></B>(<A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackageDocument</A> sourceDocument, |
| <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> destinationPath)</CODE> |
| |
| <BR> |
| Embed an OdfPackageDocument to the current OdfPackage.</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/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#insertOutputStream(java.lang.String)">insertOutputStream</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> internalPath)</CODE> |
| |
| <BR> |
| Insert the OutputStream for into OdfPackage.</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/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#insertOutputStream(java.lang.String, java.lang.String)">insertOutputStream</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> internalPath, |
| <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> mediaType)</CODE> |
| |
| <BR> |
| Insert the OutputStream - to be filled after method - when stream is closed into OdfPackage.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#isExternalReference(java.lang.String)">isExternalReference</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> internalPath)</CODE> |
| |
| <BR> |
| Checks if the given reference is a reference, which points outside the ODF package</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackageDocument</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.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> internalPath)</CODE> |
| |
| <BR> |
| Returns on ODF documents based a given mediatype.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackage</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#loadPackage(java.io.File)">loadPackage</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> pkgFile)</CODE> |
| |
| <BR> |
| Loads an OdfPackage from the OpenDocument 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/odfdom/pkg/OdfPackage.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackage</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#loadPackage(java.io.File, org.xml.sax.ErrorHandler)">loadPackage</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> pkgFile, |
| <A HREF="http://docs.oracle.com/javase/8/docs/api/org/xml/sax/ErrorHandler.html?is-external=true" title="class or interface in org.xml.sax">ErrorHandler</A> errorHandler)</CODE> |
| |
| <BR> |
| Loads an OdfPackage from the given 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/pkg/OdfPackage.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackage</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#loadPackage(java.io.File, java.lang.String)">loadPackage</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> pkgFile, |
| <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> password)</CODE> |
| |
| <BR> |
| Loads an OdfPackage from the given 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/pkg/OdfPackage.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackage</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#loadPackage(java.io.File, java.lang.String, org.xml.sax.ErrorHandler)">loadPackage</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> pkgFile, |
| <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> password, |
| <A HREF="http://docs.oracle.com/javase/8/docs/api/org/xml/sax/ErrorHandler.html?is-external=true" title="class or interface in org.xml.sax">ErrorHandler</A> errorHandler)</CODE> |
| |
| <BR> |
| Loads an OdfPackage from the given 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/pkg/OdfPackage.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackage</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#loadPackage(java.io.InputStream)">loadPackage</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> packageStream)</CODE> |
| |
| <BR> |
| Creates an OdfPackage from the given InputStream.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackage</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#loadPackage(java.io.InputStream, java.lang.String, org.xml.sax.ErrorHandler)">loadPackage</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> packageStream, |
| <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> baseURI, |
| <A HREF="http://docs.oracle.com/javase/8/docs/api/org/xml/sax/ErrorHandler.html?is-external=true" title="class or interface in org.xml.sax">ErrorHandler</A> errorHandler)</CODE> |
| |
| <BR> |
| Creates an OdfPackage from the given InputStream.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackage</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#loadPackage(java.lang.String)">loadPackage</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> path)</CODE> |
| |
| <BR> |
| Loads an OdfPackage from the given documentURL.</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/pkg/OdfPackage.html#remove(java.lang.String)">remove</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> internalPath)</CODE> |
| |
| <BR> |
| Removes a single file from the package.</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/pkg/OdfPackage.html#removeDocument(java.lang.String)">removeDocument</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> internalPath)</CODE> |
| |
| <BR> |
| Removes a document from the package via its path.</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/pkg/OdfPackage.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> pkgFile)</CODE> |
| |
| <BR> |
| Save package 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/pkg/OdfPackage.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> odfStream)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#save(java.lang.String)">save</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> odfPath)</CODE> |
| |
| <BR> |
| Save the package to given documentURL.</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/pkg/OdfPackage.html#setErrorHandler(org.xml.sax.ErrorHandler)">setErrorHandler</A></B>(<A HREF="http://docs.oracle.com/javase/8/docs/api/org/xml/sax/ErrorHandler.html?is-external=true" title="class or interface in org.xml.sax">ErrorHandler</A> handler)</CODE> |
| |
| <BR> |
| Allow an application to register an error event handler.</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/pkg/OdfPackage.html#setPassword(java.lang.String)">setPassword</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> password)</CODE> |
| |
| <BR> |
| Sets the password of this package.</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#toString()" title="class or interface in java.lang">toString</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> |
| |
| <!-- ============ 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="loadPackage(java.lang.String)"><!-- --></A><H3> |
| loadPackage</H3> |
| <PRE> |
| public static <A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackage</A> <B>loadPackage</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> path) |
| 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>, |
| <A HREF="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Loads an OdfPackage from the given documentURL. |
| <p> |
| OdfPackage relies on the file being available for read access over the whole lifecycle of |
| OdfPackage. |
| </p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>path</CODE> - - the documentURL to the ODF package |
| <DT><B>Returns:</B><DD>the OpenDocument document represented as an OdfPackage |
| <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> - if there's an XML- or validation-related error while loading the package |
| <DD><CODE><A HREF="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - if there's an I/O error while loading the package</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="loadPackage(java.io.File)"><!-- --></A><H3> |
| loadPackage</H3> |
| <PRE> |
| public static <A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackage</A> <B>loadPackage</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> pkgFile) |
| 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>, |
| <A HREF="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Loads an OdfPackage from the OpenDocument provided by a File. |
| <p> |
| OdfPackage relies on the file being available for read access over the whole lifecycle of |
| OdfPackage. |
| </p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>pkgFile</CODE> - - the ODF Package |
| <DT><B>Returns:</B><DD>the OpenDocument document represented as an OdfPackage |
| <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> - if there's an XML- or validation-related error while loading the package |
| <DD><CODE><A HREF="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - if there's an I/O error while loading the package</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="loadPackage(java.io.InputStream)"><!-- --></A><H3> |
| loadPackage</H3> |
| <PRE> |
| public static <A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackage</A> <B>loadPackage</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> packageStream) |
| 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>, |
| <A HREF="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Creates an OdfPackage from the given InputStream. |
| <p> |
| Since an InputStream does not provide the arbitrary (non sequential) read access needed by |
| OdfPackage, the InputStream is cached. This usually takes more time compared to the other |
| loadPackage methods. |
| </p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>packageStream</CODE> - - an inputStream representing the ODF package |
| <DT><B>Returns:</B><DD>the OpenDocument document represented as an OdfPackage |
| <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> - if there's an XML- or validation-related error while loading the package |
| <DD><CODE><A HREF="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - if there's an I/O error while loading the package</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="loadPackage(java.io.InputStream, java.lang.String, org.xml.sax.ErrorHandler)"><!-- --></A><H3> |
| loadPackage</H3> |
| <PRE> |
| public static <A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackage</A> <B>loadPackage</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> packageStream, |
| <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> baseURI, |
| <A HREF="http://docs.oracle.com/javase/8/docs/api/org/xml/sax/ErrorHandler.html?is-external=true" title="class or interface in org.xml.sax">ErrorHandler</A> errorHandler) |
| 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>, |
| <A HREF="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Creates an OdfPackage from the given InputStream. |
| <p> |
| OdfPackage relies on the file being available for read access over the whole lifecycle of |
| OdfPackage. |
| </p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>packageStream</CODE> - - an inputStream representing the ODF package<DD><CODE>baseURI</CODE> - allows to explicitly set the base URI from the document, As the URL can not be |
| derived from a stream. In addition it is possible to set the baseURI to any arbitrary URI, |
| e.g. an URN. One usage of the baseURI to describe the source of validation exception thrown |
| by the ErrorHandler.<DD><CODE>errorHandler</CODE> - - SAX ErrorHandler used for ODF validation |
| <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> - if there's an XML- or validation-related error while loading the package |
| <DD><CODE><A HREF="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - if there's an I/O error while loading the package<DT><B>See Also:</B><DD><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getErrorHandler()"><CODE>getErrorHandler()</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="loadPackage(java.io.File, org.xml.sax.ErrorHandler)"><!-- --></A><H3> |
| loadPackage</H3> |
| <PRE> |
| public static <A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackage</A> <B>loadPackage</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> pkgFile, |
| <A HREF="http://docs.oracle.com/javase/8/docs/api/org/xml/sax/ErrorHandler.html?is-external=true" title="class or interface in org.xml.sax">ErrorHandler</A> errorHandler) |
| 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>, |
| <A HREF="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Loads an OdfPackage from the given File. |
| <p> |
| OdfPackage relies on the file being available for read access over the whole lifecycle of |
| OdfPackage. |
| </p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>pkgFile</CODE> - - the ODF Package. A baseURL is being generated based on its location.<DD><CODE>errorHandler</CODE> - - SAX ErrorHandler used for ODF validation. |
| <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> - if there's an XML- or validation-related error while loading the package |
| <DD><CODE><A HREF="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - if there's an I/O error while loading the package<DT><B>See Also:</B><DD><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getErrorHandler()"><CODE>getErrorHandler()</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="loadPackage(java.io.File, java.lang.String)"><!-- --></A><H3> |
| loadPackage</H3> |
| <PRE> |
| public static <A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackage</A> <B>loadPackage</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> pkgFile, |
| <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> password) |
| 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>, |
| <A HREF="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Loads an OdfPackage from the given File. |
| <p> |
| OdfPackage relies on the file being available for read access over the whole lifecycle of |
| OdfPackage. |
| </p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>pkgFile</CODE> - - the ODF Package. A baseURL is being generated based on its location.<DD><CODE>password</CODE> - - the ODF Package password. |
| <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> - if there's an XML- or validation-related error while loading the package |
| <DD><CODE><A HREF="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - if there's an I/O error while loading the package<DT><B>See Also:</B><DD><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getErrorHandler()"><CODE>getErrorHandler()</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="loadPackage(java.io.File, java.lang.String, org.xml.sax.ErrorHandler)"><!-- --></A><H3> |
| loadPackage</H3> |
| <PRE> |
| public static <A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackage</A> <B>loadPackage</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> pkgFile, |
| <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> password, |
| <A HREF="http://docs.oracle.com/javase/8/docs/api/org/xml/sax/ErrorHandler.html?is-external=true" title="class or interface in org.xml.sax">ErrorHandler</A> errorHandler) |
| 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>, |
| <A HREF="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Loads an OdfPackage from the given File. |
| <p> |
| OdfPackage relies on the file being available for read access over the whole lifecycle of |
| OdfPackage. |
| </p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>pkgFile</CODE> - - the ODF Package. A baseURL is being generated based on its location.<DD><CODE>password</CODE> - - the ODF Package password.<DD><CODE>errorHandler</CODE> - - SAX ErrorHandler used for ODF validation. |
| <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> - if there's an XML- or validation-related error while loading the package |
| <DD><CODE><A HREF="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - if there's an I/O error while loading the package<DT><B>See Also:</B><DD><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getErrorHandler()"><CODE>getErrorHandler()</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getBaseURI()"><!-- --></A><H3> |
| getBaseURI</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>getBaseURI</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>The URI to the ODF package, usually the URL, where this ODF package is located. If |
| the package has not URI NULL is returned. This is the case if the package was new created |
| without an URI and not saved before.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="loadDocument(java.lang.String)"><!-- --></A><H3> |
| loadDocument</H3> |
| <PRE> |
| public <A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackageDocument</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> internalPath)</PRE> |
| <DL> |
| <DD>Returns on ODF documents based a given mediatype. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>internalPath</CODE> - path relative to the package root, where the document should be loaded. |
| <DT><B>Returns:</B><DD>The ODF document, which mediatype depends on the parameter or NULL if media type were |
| not supported.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCachedDocument(java.lang.String)"><!-- --></A><H3> |
| getCachedDocument</H3> |
| <PRE> |
| <FONT SIZE="-1"><A HREF="http://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</A> |
| </FONT>public <A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackageDocument</A> <B>getCachedDocument</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> internalPath)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>This method is only added temporary as workaround for the IBM fork using |
| different DOC classes. Until the registering of DOC documents to the PKG layer has been |
| finished.</I> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>internalPath</CODE> - path relative to the package root, where the document should be inserted. |
| <DT><B>Returns:</B><DD>an already open OdfPackageDocument via its path, otherwise NULL.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removeDocument(java.lang.String)"><!-- --></A><H3> |
| removeDocument</H3> |
| <PRE> |
| public void <B>removeDocument</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> internalPath)</PRE> |
| <DL> |
| <DD>Removes a document from the package via its path. Independent if it was already opened or |
| not. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>internalPath</CODE> - path relative to the package root, where the document should be removed.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getRootDocument()"><!-- --></A><H3> |
| getRootDocument</H3> |
| <PRE> |
| public <A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackageDocument</A> <B>getRootDocument</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getManifestDom()"><!-- --></A><H3> |
| getManifestDom</H3> |
| <PRE> |
| public <A HREF="../../../../org/odftoolkit/odfdom/pkg/manifest/OdfManifestDom.html" title="class in org.odftoolkit.odfdom.pkg.manifest">OdfManifestDom</A> <B>getManifestDom</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getMediaTypeString(java.lang.String)"><!-- --></A><H3> |
| getMediaTypeString</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>getMediaTypeString</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> internalPath)</PRE> |
| <DL> |
| <DD>Get the media type of the ODF file or document (ie. a directory). A directory with a |
| mediatype can be loaded as <code>OdfPackageDocument</code>. Note: A directoy is represented |
| by in the package as directory with media type |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>internalPath</CODE> - within the package of the file or document. |
| <DT><B>Returns:</B><DD>the mediaType for the resource of the given path</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getMediaTypeString()"><!-- --></A><H3> |
| getMediaTypeString</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>getMediaTypeString</B>()</PRE> |
| <DL> |
| <DD>Get the media type of the ODF package (equal to media type of ODF root document) |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the mediaType string of this ODF package</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFileEntry(java.lang.String)"><!-- --></A><H3> |
| getFileEntry</H3> |
| <PRE> |
| public <A HREF="../../../../org/odftoolkit/odfdom/pkg/manifest/OdfFileEntry.html" title="class in org.odftoolkit.odfdom.pkg.manifest">OdfFileEntry</A> <B>getFileEntry</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> internalPath)</PRE> |
| <DL> |
| <DD>Get an OdfFileEntry for the internalPath NOTE: This method should be better moved to a DOM |
| inherited Manifest class |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>internalPath</CODE> - The relative package path within the ODF package |
| <DT><B>Returns:</B><DD>The manifest file entry will be returned.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFilePaths()"><!-- --></A><H3> |
| getFilePaths</H3> |
| <PRE> |
| public <A HREF="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</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>> <B>getFilePaths</B>()</PRE> |
| <DL> |
| <DD>Get a OdfFileEntries from the manifest file (i.e. /META/manifest.xml") |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>The paths of the manifest file entries will be returned.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="contains(java.lang.String)"><!-- --></A><H3> |
| contains</H3> |
| <PRE> |
| public boolean <B>contains</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> internalPath)</PRE> |
| <DL> |
| <DD>Check existence of a file in the package. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>internalPath</CODE> - The relative package documentURL within the ODF package |
| <DT><B>Returns:</B><DD>True if there is an entry and a file for the given documentURL</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="save(java.lang.String)"><!-- --></A><H3> |
| save</H3> |
| <PRE> |
| public void <B>save</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> odfPath) |
| throws <A HREF="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Save the package to given documentURL. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>odfPath</CODE> - - the path to the ODF package destination |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - - if the package 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> pkgFile) |
| throws <A HREF="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Save package to a given File. After saving it is still necessary to close the package to have |
| again full access about the file. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>pkgFile</CODE> - - the File to save the ODF package to |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - - if the package could not be saved</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> odfStream) |
| 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><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <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></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setPassword(java.lang.String)"><!-- --></A><H3> |
| setPassword</H3> |
| <PRE> |
| public void <B>setPassword</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> password)</PRE> |
| <DL> |
| <DD>Sets the password of this package. if password is not null, package will be encrypted when |
| save. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>password</CODE> - password<DT><B>Since:</B></DT> |
| <DD>0.8.9</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="close()"><!-- --></A><H3> |
| close</H3> |
| <PRE> |
| public void <B>close</B>()</PRE> |
| <DL> |
| <DD>Close the OdfPackage after it is no longer needed. Even after saving it is still necessary to |
| close the package to have again full access about the file. Closing the OdfPackage will |
| release all temporary created data. 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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="insert(org.w3c.dom.Document, java.lang.String, java.lang.String)"><!-- --></A><H3> |
| insert</H3> |
| <PRE> |
| public void <B>insert</B>(<A HREF="http://docs.oracle.com/javase/8/docs/api/org/w3c/dom/Document.html?is-external=true" title="class or interface in org.w3c.dom">Document</A> fileDOM, |
| <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="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> mediaType)</PRE> |
| <DL> |
| <DD>Insert DOM tree into OdfPackage. An existing file will be replaced. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>fileDOM</CODE> - - XML DOM tree to be inserted as file.<DD><CODE>internalPath</CODE> - - relative documentURL where the DOM tree should be inserted as XML file<DD><CODE>mediaType</CODE> - - media type of stream. Set to null if unknown |
| <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> - when the DOM tree could not be inserted</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="../../../../org/odftoolkit/odfdom/pkg/OdfPackageDocument.html" title="class in org.odftoolkit.odfdom.pkg">OdfPackageDocument</A> sourceDocument, |
| <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> destinationPath)</PRE> |
| <DL> |
| <DD>Embed an OdfPackageDocument to the current OdfPackage. All the file entries of child document |
| will be inserted. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>sourceDocument</CODE> - the OdfPackageDocument to be embedded.<DD><CODE>destinationPath</CODE> - path to the directory the ODF document should be inserted (relative to |
| ODF package root).</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDocumentPaths()"><!-- --></A><H3> |
| getDocumentPaths</H3> |
| <PRE> |
| public <A HREF="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</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>> <B>getDocumentPaths</B>()</PRE> |
| <DL> |
| <DD>Method returns the paths of all document within the package. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>A set of paths of all documents of the package, including the root document.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDocumentPaths(java.lang.String)"><!-- --></A><H3> |
| getDocumentPaths</H3> |
| <PRE> |
| public <A HREF="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</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>> <B>getDocumentPaths</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> mediaTypeString)</PRE> |
| <DL> |
| <DD>Method returns the paths of all document within the package matching the given criteria. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>mediaTypeString</CODE> - limits the desired set of document paths to documents of the given |
| mediaType |
| <DT><B>Returns:</B><DD>A set of paths of all documents of the package, including the root document, that |
| match the given parameter.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDom(java.lang.String)"><!-- --></A><H3> |
| getDom</H3> |
| <PRE> |
| public <A HREF="http://docs.oracle.com/javase/8/docs/api/org/w3c/dom/Document.html?is-external=true" title="class or interface in org.w3c.dom">Document</A> <B>getDom</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> internalPath) |
| 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>, |
| <A HREF="http://docs.oracle.com/javase/8/docs/api/javax/xml/parsers/ParserConfigurationException.html?is-external=true" title="class or interface in javax.xml.parsers">ParserConfigurationException</A>, |
| <A HREF="http://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A>, |
| <A HREF="http://docs.oracle.com/javase/8/docs/api/javax/xml/transform/TransformerConfigurationException.html?is-external=true" title="class or interface in javax.xml.transform">TransformerConfigurationException</A>, |
| <A HREF="http://docs.oracle.com/javase/8/docs/api/javax/xml/transform/TransformerException.html?is-external=true" title="class or interface in javax.xml.transform">TransformerException</A>, |
| <A HREF="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Gets org.w3c.dom.Document for XML file contained in package. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>internalPath</CODE> - to a file within the Odf Package (eg. content.xml) |
| <DT><B>Returns:</B><DD>an org.w3c.dom.Document |
| <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> |
| <DD><CODE><A HREF="http://docs.oracle.com/javase/8/docs/api/javax/xml/parsers/ParserConfigurationException.html?is-external=true" title="class or interface in javax.xml.parsers">ParserConfigurationException</A></CODE> |
| <DD><CODE><A HREF="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> |
| <DD><CODE><A HREF="http://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> |
| <DD><CODE><A HREF="http://docs.oracle.com/javase/8/docs/api/javax/xml/transform/TransformerConfigurationException.html?is-external=true" title="class or interface in javax.xml.transform">TransformerConfigurationException</A></CODE> |
| <DD><CODE><A HREF="http://docs.oracle.com/javase/8/docs/api/javax/xml/transform/TransformerException.html?is-external=true" title="class or interface in javax.xml.transform">TransformerException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="insert(java.net.URI, java.lang.String, java.lang.String)"><!-- --></A><H3> |
| insert</H3> |
| <PRE> |
| public void <B>insert</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> sourceURI, |
| <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="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> mediaType) |
| 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>Inserts an external file into an OdfPackage. An existing file will be replaced. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>sourceURI</CODE> - - the source URI to the file to be inserted into the package.<DD><CODE>internalPath</CODE> - - relative documentURL where the tree should be inserted as XML file<DD><CODE>mediaType</CODE> - - media type of stream. Set to null if unknown |
| <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> - In case the file could not be saved</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="insert(java.io.InputStream, java.lang.String, java.lang.String)"><!-- --></A><H3> |
| insert</H3> |
| <PRE> |
| public void <B>insert</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> fileStream, |
| <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="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> mediaType) |
| 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>Inserts InputStream into an OdfPackage. An existing file will be replaced. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>fileStream</CODE> - - the stream of the file to be inserted into the ODF package.<DD><CODE>internalPath</CODE> - - relative documentURL where the tree should be inserted as XML file<DD><CODE>mediaType</CODE> - - media type of stream. Set to null if unknown |
| <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></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="insert(byte[], java.lang.String, java.lang.String)"><!-- --></A><H3> |
| insert</H3> |
| <PRE> |
| public void <B>insert</B>(byte[] fileBytes, |
| <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="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> mediaTypeString)</PRE> |
| <DL> |
| <DD>Inserts a byte array into OdfPackage. An existing file will be replaced. If the byte array is |
| NULL a directory with the given mimetype will be created. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>fileBytes</CODE> - - data of the file stream to be stored in package. If NULL a directory with |
| the given mimetype will be created.<DD><CODE>internalPath</CODE> - - path of the file or directory relative to the package root.<DD><CODE>mediaTypeString</CODE> - - media type of stream. If unknown null can be used.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getBytes(java.lang.String)"><!-- --></A><H3> |
| getBytes</H3> |
| <PRE> |
| public byte[] <B>getBytes</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> internalPath)</PRE> |
| <DL> |
| <DD>Get package (sub-) content as byte array |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>internalPath</CODE> - relative documentURL to the package content |
| <DT><B>Returns:</B><DD>the unzipped package content as byte array |
| <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></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getInputStream(java.lang.String)"><!-- --></A><H3> |
| getInputStream</H3> |
| <PRE> |
| public <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> <B>getInputStream</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> internalPath)</PRE> |
| <DL> |
| <DD>Get the latest version of package content as InputStream, as it would be saved. This might |
| not be the original version once loaded from the package. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>internalPath</CODE> - of the desired stream. |
| <DT><B>Returns:</B><DD>Inputstream of the ODF file within the package for the given path.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getInputStream(java.lang.String, boolean)"><!-- --></A><H3> |
| getInputStream</H3> |
| <PRE> |
| public <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> <B>getInputStream</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> internalPath, |
| boolean useOriginal)</PRE> |
| <DL> |
| <DD>Get the latest version of package content as InputStream, as it would be saved. This might |
| not be the original version once loaded from the package. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>internalPath</CODE> - of the desired stream.<DD><CODE>useOriginal</CODE> - true uses the stream as loaded from the ZIP. False will return even |
| modified file content as a stream. |
| <DT><B>Returns:</B><DD>Inputstream of the ODF file within the package for the given path.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getInputStream()"><!-- --></A><H3> |
| getInputStream</H3> |
| <PRE> |
| public <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> <B>getInputStream</B>() |
| throws <A HREF="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Gets the InputStream containing whole OdfPackage. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the ODF package as input stream |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - - if the package could not be read</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="insertOutputStream(java.lang.String)"><!-- --></A><H3> |
| insertOutputStream</H3> |
| <PRE> |
| public <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> <B>insertOutputStream</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> 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>Insert the OutputStream for into OdfPackage. An existing file will be replaced. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>internalPath</CODE> - - relative documentURL where the DOM tree should be inserted as XML file |
| <DT><B>Returns:</B><DD>outputstream for the data of the file to be stored in package |
| <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> - when the DOM tree could not be inserted</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="insertOutputStream(java.lang.String, java.lang.String)"><!-- --></A><H3> |
| insertOutputStream</H3> |
| <PRE> |
| public <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> <B>insertOutputStream</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> internalPath, |
| <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> mediaType) |
| throws <A HREF="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Insert the OutputStream - to be filled after method - when stream is closed into OdfPackage. |
| An existing file will be replaced. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>internalPath</CODE> - - relative documentURL where the DOM tree should be inserted as XML file<DD><CODE>mediaType</CODE> - - media type of stream |
| <DT><B>Returns:</B><DD>outputstream for the data of the file to be stored in package |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - when the DOM tree could not be inserted</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="remove(java.lang.String)"><!-- --></A><H3> |
| remove</H3> |
| <PRE> |
| public void <B>remove</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> internalPath)</PRE> |
| <DL> |
| <DD>Removes a single file from the package. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>internalPath</CODE> - of the file relative to the package root</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getSize(java.lang.String)"><!-- --></A><H3> |
| getSize</H3> |
| <PRE> |
| public long <B>getSize</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> internalPath)</PRE> |
| <DL> |
| <DD>Get the size of an internal file from the package. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>internalPath</CODE> - of the file relative to the package root |
| <DT><B>Returns:</B><DD>the size of the file in bytes or -1 if the size could not be received.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getEntityResolver()"><!-- --></A><H3> |
| getEntityResolver</H3> |
| <PRE> |
| public <A HREF="http://docs.oracle.com/javase/8/docs/api/org/xml/sax/EntityResolver.html?is-external=true" title="class or interface in org.xml.sax">EntityResolver</A> <B>getEntityResolver</B>()</PRE> |
| <DL> |
| <DD>Get EntityResolver to be used in XML Parsers which can resolve content inside the OdfPackage |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>a SAX EntityResolver</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getURIResolver()"><!-- --></A><H3> |
| getURIResolver</H3> |
| <PRE> |
| public <A HREF="http://docs.oracle.com/javase/8/docs/api/javax/xml/transform/URIResolver.html?is-external=true" title="class or interface in javax.xml.transform">URIResolver</A> <B>getURIResolver</B>()</PRE> |
| <DL> |
| <DD>Get URIResolver to be used in XSL Transformations which can resolve content inside the |
| OdfPackage |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>a TraX Resolver</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isExternalReference(java.lang.String)"><!-- --></A><H3> |
| isExternalReference</H3> |
| <PRE> |
| public static boolean <B>isExternalReference</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> internalPath)</PRE> |
| <DL> |
| <DD>Checks if the given reference is a reference, which points outside the ODF package |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>internalPath</CODE> - the file reference to be checked |
| <DT><B>Returns:</B><DD>true if the reference is an package external reference</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setErrorHandler(org.xml.sax.ErrorHandler)"><!-- --></A><H3> |
| setErrorHandler</H3> |
| <PRE> |
| public void <B>setErrorHandler</B>(<A HREF="http://docs.oracle.com/javase/8/docs/api/org/xml/sax/ErrorHandler.html?is-external=true" title="class or interface in org.xml.sax">ErrorHandler</A> handler)</PRE> |
| <DL> |
| <DD>Allow an application to register an error event handler. |
| <p> |
| If the application does not register an error handler, all error events reported by the |
| ODFDOM (e.g. the SAX Parser) will be silently ignored; however, normal processing may not |
| continue. It is highly recommended that all ODF applications implement an error handler to |
| avoid unexpected bugs. |
| </p> |
| <p> |
| Applications may register a new or different handler in the middle of a parse, and the ODFDOM |
| will begin using the new handler immediately. |
| </p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>handler</CODE> - The error handler.<DT><B>See Also:</B><DD><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#getErrorHandler()"><CODE>getErrorHandler()</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getErrorHandler()"><!-- --></A><H3> |
| getErrorHandler</H3> |
| <PRE> |
| public <A HREF="http://docs.oracle.com/javase/8/docs/api/org/xml/sax/ErrorHandler.html?is-external=true" title="class or interface in org.xml.sax">ErrorHandler</A> <B>getErrorHandler</B>()</PRE> |
| <DL> |
| <DD>Return the current error handler used for ODF validation. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>The current error handler, or null if none has been registered and validation is |
| disabled.<DT><B>See Also:</B><DD><A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.html#setErrorHandler(org.xml.sax.ErrorHandler)"><CODE>setErrorHandler(org.xml.sax.ErrorHandler)</CODE></A></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/OdfPackage.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/pkg/OdfNamespace.html" title="class in org.odftoolkit.odfdom.pkg"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/odftoolkit/odfdom/pkg/OdfPackage.OdfFile.html" title="enum in org.odftoolkit.odfdom.pkg"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/odftoolkit/odfdom/pkg/OdfPackage.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="OdfPackage.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> | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2008-2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |
