Package org.apache.poi.hpbf

Class HPBFDocument

java.lang.Object

org.apache.poi.POIDocument

org.apache.poi.hpbf.HPBFDocument

public final class HPBFDocument
extends POIDocument

This class provides the basic functionality for HPBF, our implementation of the publisher file format.

Field Summary

Fields inherited from class org.apache.poi.POIDocument

directory

Constructor Summary

Constructors

Constructor	Description
HPBFDocument(java.io.InputStream inp)
HPBFDocument(DirectoryNode dir)	Opens an embedded publisher document, at the given directory.
HPBFDocument(DirectoryNode dir, POIFSFileSystem fs)	Deprecated. Use HPBFDocument(DirectoryNode) instead
HPBFDocument(NPOIFSFileSystem fs)
HPBFDocument(POIFSFileSystem fs)	Opens a new publisher document

Method Summary

Modifier and Type	Method	Description
EscherDelayStm	getEscherDelayStm()
EscherStm	getEscherStm()
MainContents	getMainContents()
QuillContents	getQuillContents()
void	write(java.io.OutputStream out)	Writes the document out to the specified output stream.

Methods inherited from class java.lang.Object

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

Methods inherited from class org.apache.poi.POIDocument

copyNodeRecursively, copyNodes, copyNodes, createInformationProperties, getDocumentSummaryInformation, getPropertySet, getPropertySet, getSummaryInformation, readProperties, writeProperties, writeProperties, writePropertySet

Constructor Detail

HPBFDocument

public HPBFDocument(POIFSFileSystem fs)
             throws java.io.IOException

Opens a new publisher document

Throws:

java.io.IOException

HPBFDocument

public HPBFDocument(NPOIFSFileSystem fs)
             throws java.io.IOException

Throws:

java.io.IOException

HPBFDocument

public HPBFDocument(java.io.InputStream inp)
             throws java.io.IOException

Throws:

java.io.IOException

HPBFDocument

@Deprecated
public HPBFDocument(DirectoryNode dir,
                    POIFSFileSystem fs)
             throws java.io.IOException

Deprecated.

Use HPBFDocument(DirectoryNode) instead

Opens an embedded publisher document, at the given directory.

Throws:

java.io.IOException

HPBFDocument

public HPBFDocument(DirectoryNode dir)
             throws java.io.IOException

Opens an embedded publisher document, at the given directory.

Throws:

java.io.IOException

Method Detail

getMainContents

public MainContents getMainContents()

getQuillContents

public QuillContents getQuillContents()

getEscherStm

public EscherStm getEscherStm()

getEscherDelayStm

public EscherDelayStm getEscherDelayStm()

write

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

Description copied from class: POIDocument

Writes the document out to the specified output stream. The stream is not closed as part of this operation.

Specified by:

write in class POIDocument

Parameters:

out - The stream to write to.

Throws:

java.io.IOException - thrown on errors writing to the stream