Class Pages

java.lang.Object

com.orsonpdf.PDFObject

com.orsonpdf.Pages

public final class Pages
extends PDFObject

A PDFObject that maintains the list of pages for the document. When a PDFDocument is created, it will create an instance of Pages and add it to the document catalog. You won't normally interact directly with this class.

Field Summary

Fields

Modifier and Type	Field	Description
private Map<FontKey,PDFFont>	fontMap
private FontMapper	fontMapper
private List<PDFFont>	fonts	The list of font objects used in the document.
private int	nextFont
private List<Page>	pages
private PDFDocument	parent	The PDF document.

Constructor Summary

Constructors

Constructor	Description
Pages(int number, int generation, PDFDocument parent)	Creates a new Pages object.

Method Summary

Modifier and Type	Method	Description
(package private) void	add(Page page)
private Dictionary	createDictionary()
String	findOrCreateFontReference(Font f)	Finds or creates a font reference for the specified AWT font.
PDFDocument	getDocument()	Returns the PDF document that the pages belong to.
PDFFont	getFont(String name)	Returns the PDF font with the specified name, or null if there is no font with that name.
List<PDFFont>	getFonts()	Returns a list of fonts used in these pages.
byte[]	getObjectBytes()	Returns the bytes that go between the 'obj' and 'endobj' in the PDF output for this object.
List<Page>	getPages()	Returns a list of the pages in this object.

Methods inherited from class PDFObject

getGeneration, getNumber, getReference, toPDFBytes

Methods inherited from class Object

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

Field Details

parent

private PDFDocument parent

The PDF document.

pages

private List<Page> pages

fonts

private List<PDFFont> fonts

The list of font objects used in the document.

fontMap

private Map<FontKey,PDFFont> fontMap

nextFont

private int nextFont

fontMapper

private FontMapper fontMapper

Constructor Details

Pages

Pages(int number,
 int generation,
 PDFDocument parent)

Creates a new Pages object.

Parameters:

number - the PDF object number.

generation - the PDF object generation number.

parent - the PDF document (null not permitted).

Method Details

getDocument

public PDFDocument getDocument()

Returns the PDF document that the pages belong to.

Returns:

The PDF document (never null).

getPages

public List<Page> getPages()

Returns a list of the pages in this object.

Returns:

A list of the pages.

getFonts

public List<PDFFont> getFonts()

Returns a list of fonts used in these pages.

Returns:

A list of fonts.

getFont

public PDFFont getFont(String name)

Returns the PDF font with the specified name, or null if there is no font with that name.

Parameters:

name - the font name.

Returns:

The PDF font or null.

add

void add(Page page)

Parameters:

page -

findOrCreateFontReference

public String findOrCreateFontReference(Font f)

Finds or creates a font reference for the specified AWT font.

Parameters:

f - the font (null not permitted).

Returns:

The font reference.

createDictionary

private Dictionary createDictionary()

getObjectBytes

public byte[] getObjectBytes()

Description copied from class: PDFObject

Returns the bytes that go between the 'obj' and 'endobj' in the PDF output for this object.

Specified by:

getObjectBytes in class PDFObject

Returns:

A byte array.