Package net.atthegate.server.service.pdf

Class PDF

java.lang.Object

net.atthegate.server.service.pdf.PDF

public class PDF
extends Object

Used to create PDF objects that represent PDF documents.

Field Summary

Fields

Modifier and Type	Field	Description
protected int	compliance
protected Map<String,Destination>	destinations
protected static final DecimalFormat	df
protected List<EmbeddedFile>	embeddedFiles
protected String	extGState
protected List<Font>	fonts
protected List<OptionalContentGroup>	groups
protected List<Image>	images
protected List<String>	importedFonts
protected int	metadataObjNumber
protected int	objNumber
protected int	outputIntentObjNumber
protected List<Page>	pages
protected Map<String,Integer>	states
protected Bookmark	toc

Constructor Summary

Constructors

Constructor	Description
PDF()	The default constructor - use when reading PDF files.
PDF(OutputStream os)	Creates a PDF object that represents a PDF document.
PDF(OutputStream os, int compliance)	Creates a PDF object that represents a PDF document.

Method Summary

Modifier and Type	Method	Description
protected int	addMetadataObject(String notice, boolean fontMetadataObject)
void	addObjects(Map<Integer,PDFobj> objects)
int	addOutlineDict(Bookmark toc)
void	addOutlineItem(int parent, int i, Bookmark bm1)
protected int	addOutputIntentObject()
void	addPage(Page page)
void	addResourceObjects(Map<Integer,PDFobj> objects)
protected void	append(byte b)
protected void	append(byte[] buf, int off, int len)
protected void	append(char ch)
protected void	append(float val)
protected void	append(int num)
protected void	append(ByteArrayOutputStream baos)
protected void	append(String str)
void	close()	Writes the PDF object to the output stream and closes it.
protected void	endobj()
void	flush()	Writes the PDF object to the output stream.
List<PDFobj>	getPageObjects(Map<Integer,PDFobj> objects)
PDFobj	getPagesObject(Map<Integer,PDFobj> objects)
protected void	newobj()
Map<Integer,PDFobj>	read(InputStream inputStream)	Returns a list of objects of type PDFobj read from input stream.
void	removePages(Set<Integer> pageNumbers, Map<Integer,PDFobj> objects)
void	setAuthor(String author)	Set the "Author" document property of the PDF file.
void	setCreator(String creator)
void	setKeywords(String keywords)
void	setPageLayout(String pageLayout)
void	setPageMode(String pageMode)
void	setSubject(String subject)	Set the "Subject" document property of the PDF file.
void	setTitle(String title)	Set the "Title" document property of the PDF file.

Methods inherited from class java.lang.Object

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

Field Details

objNumber

protected int objNumber

metadataObjNumber

protected int metadataObjNumber

outputIntentObjNumber

protected int outputIntentObjNumber

fonts

protected List<Font> fonts

images

protected List<Image> images

pages

protected List<Page> pages

destinations

protected Map<String,Destination> destinations

groups

protected List<OptionalContentGroup> groups

states

protected Map<String,Integer> states

df

protected static final DecimalFormat df

compliance

protected int compliance

embeddedFiles

protected List<EmbeddedFile> embeddedFiles

toc

protected Bookmark toc

importedFonts

protected List<String> importedFonts

extGState

protected String extGState

Constructor Details

PDF

public PDF()
    throws Exception

The default constructor - use when reading PDF files.

Throws:

Exception

PDF

public PDF(OutputStream os)
    throws Exception

Creates a PDF object that represents a PDF document.

Parameters:

os - the associated output stream.

Throws:

Exception

PDF

public PDF(OutputStream os,
 int compliance)
    throws Exception

Creates a PDF object that represents a PDF document. Use this constructor to create PDF/A compliant PDF documents. Please note: PDF/A compliance requires all fonts to be embedded in the PDF.

Parameters:

os - the associated output stream.

compliance - must be: Compliance.PDF_A_1B

Throws:

Exception

Method Details

newobj

protected void newobj()
               throws IOException

Throws:

IOException

endobj

protected void endobj()
               throws IOException

Throws:

IOException

addMetadataObject

protected int addMetadataObject(String notice,
 boolean fontMetadataObject)
                         throws Exception

Throws:

Exception

addOutputIntentObject

protected int addOutputIntentObject()
                             throws Exception

Throws:

Exception

addPage

public void addPage(Page page)
             throws Exception

Throws:

Exception

flush

public void flush()
           throws Exception

Writes the PDF object to the output stream. Does not close the underlying output stream.

Throws:

Exception

close

public void close()
           throws Exception

Writes the PDF object to the output stream and closes it.

Throws:

Exception

setTitle

public void setTitle(String title)

Set the "Title" document property of the PDF file.

Parameters:

title - The title of this document.

setAuthor

public void setAuthor(String author)

Set the "Author" document property of the PDF file.

Parameters:

author - The author of this document.

setSubject

public void setSubject(String subject)

Set the "Subject" document property of the PDF file.

Parameters:

subject - The subject of this document.

setKeywords

public void setKeywords(String keywords)

setCreator

public void setCreator(String creator)

setPageLayout

public void setPageLayout(String pageLayout)

setPageMode

public void setPageMode(String pageMode)

append

protected void append(int num)
               throws IOException

Throws:

IOException

append

protected void append(float val)
               throws IOException

Throws:

IOException

append

protected void append(String str)
               throws IOException

Throws:

IOException

append

protected void append(char ch)
               throws IOException

Throws:

IOException

append

protected void append(byte b)
               throws IOException

Throws:

IOException

append

protected void append(byte[] buf,
 int off,
 int len)
               throws IOException

Throws:

IOException

append

protected void append(ByteArrayOutputStream baos)
               throws IOException

Throws:

IOException

read

public Map<Integer,PDFobj> read(InputStream inputStream)
                         throws Exception

Returns a list of objects of type PDFobj read from input stream.

Parameters:

inputStream - the PDF input stream.

Returns:

List the list of PDF objects.

Throws:

Exception

addOutlineDict

public int addOutlineDict(Bookmark toc)
                   throws Exception

Throws:

Exception

addOutlineItem

public void addOutlineItem(int parent,
 int i,
 Bookmark bm1)
                    throws Exception

Throws:

Exception

removePages

public void removePages(Set<Integer> pageNumbers,
 Map<Integer,PDFobj> objects)
                 throws Exception

Throws:

Exception

addObjects

public void addObjects(Map<Integer,PDFobj> objects)
                throws Exception

Throws:

Exception

getPagesObject

public PDFobj getPagesObject(Map<Integer,PDFobj> objects)
                      throws Exception

Throws:

Exception

getPageObjects

public List<PDFobj> getPageObjects(Map<Integer,PDFobj> objects)
                            throws Exception

Throws:

Exception

addResourceObjects

public void addResourceObjects(Map<Integer,PDFobj> objects)
                        throws Exception

Throws:

Exception