Modifier and Type	Class and Description
private class	PDPageTree.PageIterator Iterator which walks all pages in the tree, in order.
private static class	PDPageTree.SearchContext

Modifier and Type	Field and Description
private final PDDocument	document
private static final Log	LOG
private final Set<COSDictionary>	pageSet
private final COSDictionary	root

Access	Constructor and Description
public	PDPageTree() Constructor for embedding.
public	PDPageTree(COSDictionary A page tree root. root) Constructor for reading.
pack-priv	PDPageTree(COSDictionary A page tree root. root, PDDocument The document which contains "root". document) Constructor for reading.

Method Summary

Modifier and Type	Method and Description
public void	add(PDPage The page to add. page) Adds the given page to this page tree.
private boolean	findPage(PDPageTree.SearchContext context, COSDictionary node)
public PDPage	Returns: the page at the given index get(int zero-based index index) Returns the page at the given index.
private COSDictionary	Returns: COS dictionary of the Page object get(int 1-based page number pageNum, COSDictionary page tree node to search node, int number of pages encountered so far encountered) Returns the given COS page using a depth-first search.
public COSDictionary	getCOSObject() Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject. Convert this standard java object to a COS object.
public int	Returns: the number of leaf nodes, 0 if not present getCount() Returns the number of leaf nodes (page objects) that are descendants of this root within the page tree.
public static COSBase	Returns: COS value for the given key getInheritableAttribute(COSDictionary page object node, COSName the key to look up key) Returns the given attribute, inheriting from parent tree nodes if necessary.
private List<COSDictionary>	Returns: list of kids getKids(COSDictionary page tree node node) Helper to get kids from malformed PDFs.
private void	increaseParents(COSDictionary parentDict)
public int	Returns: the zero-based index of the given page, or -1 if the page is not found. indexOf(PDPage The page to search for. page) Returns the index of the given page, or -1 if it does not exist.
public void	insertAfter(PDPage the page to be inserted. newPage, PDPage the page that is to be before the new page. prevPage) Insert a page after another page within a page tree.
public void	insertBefore(PDPage the page to be inserted. newPage, PDPage the page that is to be after the new page. nextPage) Insert a page before another page within a page tree.
private boolean	isPageTreeNode(COSDictionary node) Returns true if the node is a page tree node (i.e. and intermediate).
public Iterator<PDPage>	iterator() Implements java.lang.Iterable.iterator. Returns an iterator which walks all pages in the tree, in order.
public void	remove(int zero-based page index index) Removes the page with the given index from the page tree.
public void	remove(PDPage The page to remove. page) Removes the given page from the page tree.
private void	remove(COSDictionary node) Removes the given COS page.
private static void	sanitizeType(COSDictionary dictionary)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

document	back to summary
private final PDDocument document

LOG	back to summary
private static final Log LOG

pageSet	back to summary
private final Set<COSDictionary> pageSet

root	back to summary
private final COSDictionary root

Constructor Detail

PDPageTree	back to summary
public PDPageTree() Constructor for embedding.

PDPageTree	back to summary
public PDPageTree(COSDictionary root) Constructor for reading. Parameters root:COSDictionary A page tree root.

PDPageTree

back to summary

public PDPageTree(COSDictionary root)

Constructor for reading.

Parameters

root:COSDictionary: A page tree root.

PDPageTree	back to summary
pack-priv PDPageTree(COSDictionary root, PDDocument document) Constructor for reading. Parameters root:COSDictionary A page tree root. document:PDDocument The document which contains "root".

PDPageTree

back to summary

pack-priv PDPageTree(COSDictionary root, PDDocument document)

Constructor for reading.

Parameters

root:COSDictionary: A page tree root.
document:PDDocument: The document which contains "root".

Method Detail

add	back to summary
public void add(PDPage page) Adds the given page to this page tree. Parameters page:PDPage The page to add.

add

back to summary

public void add(PDPage page)

Adds the given page to this page tree.

Parameters

page:PDPage: The page to add.

findPage	back to summary
private boolean findPage(PDPageTree.SearchContext context, COSDictionary node)

get	back to summary
public PDPage get(int index) Returns the page at the given index. Parameters index:int zero-based index Returns:PDPage the page at the given index Exceptions IllegalStateException: if the requested index isn't found or doesn't point to a valid page dictionary IndexOutOfBoundsException: if the requested index is higher than the page count

get

back to summary

public PDPage get(int index)

Returns the page at the given index.

Parameters

index:int: zero-based index

Returns:PDPage

the page at the given index

Exceptions

IllegalStateException:: if the requested index isn't found or doesn't point to a valid page dictionary
IndexOutOfBoundsException:: if the requested index is higher than the page count

get	back to summary
private COSDictionary get(int pageNum, COSDictionary node, int encountered) Returns the given COS page using a depth-first search. Parameters pageNum:int 1-based page number node:COSDictionary page tree node to search encountered:int number of pages encountered so far Returns:COSDictionary COS dictionary of the Page object Exceptions IllegalStateException: if the requested page number isn't found IndexOutOfBoundsException: if the requested page number is higher than the page count

get

back to summary

private COSDictionary get(int pageNum, COSDictionary node, int encountered)

Returns the given COS page using a depth-first search.

Parameters

pageNum:int: 1-based page number
node:COSDictionary: page tree node to search
encountered:int: number of pages encountered so far

Returns:COSDictionary

COS dictionary of the Page object

Exceptions

IllegalStateException:: if the requested page number isn't found
IndexOutOfBoundsException:: if the requested page number is higher than the page count

getCOSObject	back to summary
public COSDictionary getCOSObject() Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject. Doc from org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject. Convert this standard java object to a COS object. Returns:COSDictionary The cos object that matches this Java object. Annotations @Override

getCOSObject

back to summary

public COSDictionary getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Doc from org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Convert this standard java object to a COS object.

Returns:COSDictionary

The cos object that matches this Java object.

Annotations

@Override

getCount	back to summary
public int getCount() Returns the number of leaf nodes (page objects) that are descendants of this root within the page tree. Returns:int the number of leaf nodes, 0 if not present

getCount

back to summary

public int getCount()

Returns the number of leaf nodes (page objects) that are descendants of this root within the page tree.

Returns:int: the number of leaf nodes, 0 if not present

getInheritableAttribute	back to summary
public static COSBase getInheritableAttribute(COSDictionary node, COSName key) Returns the given attribute, inheriting from parent tree nodes if necessary. Parameters node:COSDictionary page object key:COSName the key to look up Returns:COSBase COS value for the given key

getInheritableAttribute

back to summary

public static COSBase getInheritableAttribute(COSDictionary node, COSName key)

Returns the given attribute, inheriting from parent tree nodes if necessary.

Parameters

node:COSDictionary: page object
key:COSName: the key to look up

Returns:COSBase

COS value for the given key

getKids	back to summary
private List<COSDictionary> getKids(COSDictionary node) Helper to get kids from malformed PDFs. Parameters node:COSDictionary page tree node Returns:List<COSDictionary> list of kids

getKids

back to summary

private List<COSDictionary> getKids(COSDictionary node)

Helper to get kids from malformed PDFs.

Parameters

node:COSDictionary: page tree node

Returns:List<COSDictionary>

list of kids

increaseParents	back to summary
private void increaseParents(COSDictionary parentDict)

indexOf	back to summary
public int indexOf(PDPage page) Returns the index of the given page, or -1 if it does not exist. Parameters page:PDPage The page to search for. Returns:int the zero-based index of the given page, or -1 if the page is not found.

indexOf

back to summary

public int indexOf(PDPage page)

Returns the index of the given page, or -1 if it does not exist.

Parameters

page:PDPage: The page to search for.

Returns:int

the zero-based index of the given page, or -1 if the page is not found.

insertAfter	back to summary
public void insertAfter(PDPage newPage, PDPage prevPage) Insert a page after another page within a page tree. Parameters newPage:PDPage the page to be inserted. prevPage:PDPage the page that is to be before the new page. Exceptions IllegalArgumentException: if one attempts to insert a page that isn't part of a page tree.

insertAfter

back to summary

public void insertAfter(PDPage newPage, PDPage prevPage)

Insert a page after another page within a page tree.

Parameters

newPage:PDPage: the page to be inserted.
prevPage:PDPage: the page that is to be before the new page.

Exceptions

IllegalArgumentException:: if one attempts to insert a page that isn't part of a page tree.

insertBefore	back to summary
public void insertBefore(PDPage newPage, PDPage nextPage) Insert a page before another page within a page tree. Parameters newPage:PDPage the page to be inserted. nextPage:PDPage the page that is to be after the new page. Exceptions IllegalArgumentException: if one attempts to insert a page that isn't part of a page tree.

insertBefore

back to summary

public void insertBefore(PDPage newPage, PDPage nextPage)

Insert a page before another page within a page tree.

Parameters

newPage:PDPage: the page to be inserted.
nextPage:PDPage: the page that is to be after the new page.

Exceptions

IllegalArgumentException:: if one attempts to insert a page that isn't part of a page tree.

isPageTreeNode	back to summary
private boolean isPageTreeNode(COSDictionary node) Returns true if the node is a page tree node (i.e. and intermediate).

iterator	back to summary
public Iterator<PDPage> iterator() Implements java.lang.Iterable.iterator. Returns an iterator which walks all pages in the tree, in order. Returns:Iterator<PDPage> Doc from java.lang.Iterable.iterator. an Iterator. Annotations @Override

iterator

back to summary

public Iterator<PDPage> iterator()

Implements java.lang.Iterable.iterator.

Returns an iterator which walks all pages in the tree, in order.

Returns:Iterator<PDPage>

Doc from java.lang.Iterable.iterator.

an Iterator.

Annotations

@Override

remove	back to summary
public void remove(int index) Removes the page with the given index from the page tree. Parameters index:int zero-based page index

remove

back to summary

public void remove(int index)

Removes the page with the given index from the page tree.

Parameters

index:int: zero-based page index

remove	back to summary
public void remove(PDPage page) Removes the given page from the page tree. Parameters page:PDPage The page to remove.

remove

back to summary

public void remove(PDPage page)

Removes the given page from the page tree.

Parameters

page:PDPage: The page to remove.

remove	back to summary
private void remove(COSDictionary node) Removes the given COS page.

sanitizeType	back to summary
private static void sanitizeType(COSDictionary dictionary)

org.apache.pdfbox.pdmodel back to summary

private final Class PDPageTree.PageIterator

Class Inheritance

extends Object
implements Iterator<PDPage>

java.lang.Object
org.apache.pdfbox.pdmodel.PDPageTree.PageIterator

All Implemented Interfaces

java.util.Iterator

Iterator which walks all pages in the tree, in order.

Field Summary

Modifier and Type	Field and Description
private final Queue<COSDictionary>	queue
private Set<COSDictionary>	set

Constructor Summary

Access	Constructor and Description
private	PageIterator(COSDictionary node)

Method Summary

Modifier and Type	Method and Description
private void	enqueueKids(COSDictionary node)
public boolean	hasNext() Implements java.util.Iterator.hasNext. Returns `true` if the iteration has more elements.
public PDPage	next() Implements java.util.Iterator.next. Returns the next element in the iteration.
public void	remove() Overrides default java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation).

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

queue	back to summary
private final Queue<COSDictionary> queue

set	back to summary
private Set<COSDictionary> set

Constructor Detail

PageIterator	back to summary
private PageIterator(COSDictionary node)

Method Detail

enqueueKids	back to summary
private void enqueueKids(COSDictionary node)

hasNext back to summary

hasNext	back to summary
public boolean hasNext() Implements java.util.Iterator.hasNext. Doc from java.util.Iterator.hasNext. Returns `true` if the iteration has more elements. (In other words, returns `true` if `next` would return an element rather than throwing an exception.) Returns:boolean `true` if the iteration has more elements Annotations @Override

public boolean hasNext()

Implements java.util.Iterator.hasNext.

Doc from java.util.Iterator.hasNext.

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Returns:boolean

true if the iteration has more elements

Annotations

@Override

next	back to summary
public PDPage next() Implements java.util.Iterator.next. Doc from java.util.Iterator.next. Returns the next element in the iteration. Returns:PDPage the next element in the iteration Annotations @Override

back to summary

public PDPage next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Returns:PDPage

the next element in the iteration

Annotations

@Override

remove back to summary

remove	back to summary
public void remove() Overrides default java.util.Iterator.remove. Doc from java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to `next`. The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy. The behavior of an iterator is unspecified if this method is called after a call to the `forEachRemaining` method. Annotations @Override

public void remove()

Overrides default java.util.Iterator.remove.

Doc from java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to next.

The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy.

The behavior of an iterator is unspecified if this method is called after a call to the forEachRemaining method.

Annotations

@Override

public Class PDPageTree

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class PDPageTree.PageIterator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class PDPageTree.SearchContext

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Field and Description
private boolean	found
private int	index
private final COSDictionary	searched