writer2latex.epub

Class EPUBWriter

java.lang.Object

writer2latex.epub.EPUBWriter

All Implemented Interfaces:

OutputFile

public class EPUBWriter
extends java.lang.Object
implements OutputFile

This class repackages an XHTML document into EPUB format. Some filenames are hard wired in this implementation: The main directory is OEBPS and the OPF and NCX files are book.opf and book.ncx respectively; finally the EPUB 3 navigation document is nav.xhtml

Constructor Summary

Constructors

Constructor and Description
EPUBWriter(ConverterResult xhtmlResult, java.lang.String sFileName, int nVersion, XhtmlConfig config) Create a new EPUBWriter based on a ConverterResult.

Method Summary

Modifier and Type	Method and Description
boolean	containsMath() Test whether this document contains mathematical formulas
java.lang.String	getFileName() Returns the file name of the OutputFile.
java.lang.String	getMIMEType() Get the MIME type of the OutputFile.
boolean	isMasterDocument() Test whether this document is part of the main document flow (master documents) or an auxiliary document
void	write(java.io.OutputStream os) Writes the OutputFile to an OutputStream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EPUBWriter

public EPUBWriter(ConverterResult xhtmlResult,
                  java.lang.String sFileName,
                  int nVersion,
                  XhtmlConfig config)

Create a new EPUBWriter based on a ConverterResult.

Parameters:

xhtmlResult - the converter result to repackage

sFileName - the file name to use for the result

nVersion - the EPUB version number. Can be either 2 or 3, other values are interpreted as 2.

config - the configuration to use

Method Detail

getFileName

public java.lang.String getFileName()

Description copied from interface: OutputFile

Returns the file name of the OutputFile. This includes the file extension and may also include a relative path, always using / as separator.

Specified by:

getFileName in interface OutputFile

Returns:

the file name of this OutputFile

getMIMEType

public java.lang.String getMIMEType()

Description copied from interface: OutputFile

Get the MIME type of the OutputFile.

Specified by:

getMIMEType in interface OutputFile

Returns:

string representation of the MIME type

isMasterDocument

public boolean isMasterDocument()

Description copied from interface: OutputFile

Test whether this document is part of the main document flow (master documents) or an auxiliary document

Specified by:

isMasterDocument in interface OutputFile

Returns:

true if this document is a master document

containsMath

public boolean containsMath()

Description copied from interface: OutputFile

Test whether this document contains mathematical formulas

Specified by:

containsMath in interface OutputFile

Returns:

true if the document contains formulas

write

public void write(java.io.OutputStream os)
           throws java.io.IOException

Description copied from interface: OutputFile

Writes the OutputFile to an OutputStream.

Specified by:

write in interface OutputFile

Parameters:

os - OutputStream to which the content should be written

Throws:

java.io.IOException - if any I/O error occurs