writer2latex.latex

Class LaTeXDocument

public class LaTeXDocument extends Object implements Document

Class representing a LaTeX document.

Constructor Summary
	LaTeXDocument(String sName, int nWrap) Constructs a new LaTeX Document. This new document is empty.

Method Summary
LaTeXDocumentPortion	getContents() Returns the `LaTeXDocumentPortion`, that contains the contents of the document.
String	getFileName() Returns the `Document` name with file extension.
String	getName() Returns the `Document` name with no file extension.
void	read(InputStream is) This method is supposed to read `byte` data from the InputStream.
void	setEncoding(String sEncoding) Set the output encoding to use when writing the document.
void	write(OutputStream os) Writes out the `Document` content to the specified `OutputStream`. This method may not be thread-safe.

Constructor Detail

LaTeXDocument

public LaTeXDocument(String sName, int nWrap)

Constructs a new LaTeX Document.

This new document is empty. Document data must added to the preamble and the body using appropriate methods.

Parameters: sName The name of the LaTeXDocument. nWrap Lines should be wrapped after this position

Method Detail

getContents

public LaTeXDocumentPortion getContents()

Returns the LaTeXDocumentPortion, that contains the contents of the document.

Returns: The content LaTeXDocumentPortion.

getFileName

public String getFileName()

Returns the Document name with file extension.

Returns: The Document name with file extension.

getName

public String getName()

Returns the Document name with no file extension.

Returns: The Document name with no file extension.

read

public void read(InputStream is)

This method is supposed to read byte data from the InputStream. Currently it does nothing, since we don't need it.

Parameters: is InputStream containing a LaTeX data file.

Throws: IOException In case of any I/O errors.

setEncoding

public void setEncoding(String sEncoding)

Set the output encoding to use when writing the document.

write

public void write(OutputStream os)

Writes out the Document content to the specified OutputStream.

This method may not be thread-safe. Implementations may or may not synchronize this method. User code (i.e. caller) must make sure that calls to this method are thread-safe.

Parameters: os OutputStream to write out the Document content.

Throws: IOException If any I/O error occurs.