Package org.apache.pdfbox.pdmodel
Class PDPageTree
java.lang.Object
org.apache.pdfbox.pdmodel.PDPageTree
- All Implemented Interfaces:
Iterable<PDPage>
,COSObjectable
The page tree, which defines the ordering of pages in the document in an efficient manner.
- Author:
- John Hewson
-
Constructor Summary
ConstructorsConstructorDescriptionConstructor for embedding.PDPageTree
(COSDictionary root) Constructor for reading. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds the given page to this page tree.get
(int index) Returns the page at the given index.Convert this standard java object to a COS object.int
getCount()
Returns the number of leaf nodes (page objects) that are descendants of this root within the page tree.static COSBase
getInheritableAttribute
(COSDictionary node, COSName key) Returns the given attribute, inheriting from parent tree nodes if necessary.int
Returns the index of the given page, or -1 if it does not exist.void
insertAfter
(PDPage newPage, PDPage prevPage) Insert a page after another page within a page tree.void
insertBefore
(PDPage newPage, PDPage nextPage) Insert a page before another page within a page tree.iterator()
Returns an iterator which walks all pages in the tree, in order.void
remove
(int index) Removes the page with the given index from the page tree.void
Removes the given page from the page tree.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
Constructor Details
-
PDPageTree
public PDPageTree()Constructor for embedding. -
PDPageTree
Constructor for reading.- Parameters:
root
- A page tree root.
-
-
Method Details
-
getInheritableAttribute
Returns the given attribute, inheriting from parent tree nodes if necessary.- Parameters:
node
- page objectkey
- the key to look up- Returns:
- COS value for the given key
-
iterator
Returns an iterator which walks all pages in the tree, in order. -
get
Returns the page at the given index.- Parameters:
index
- zero-based index- Throws:
IllegalStateException
- if the requested index isn't found or doesn't point to a valid page dictionaryIndexOutOfBoundsException
- if the requested index is higher than the page count
-
indexOf
Returns the index of the given page, or -1 if it does not exist.- Parameters:
page
- The page to search for.- Returns:
- the zero-based index of the given page, or -1 if the page is not found.
-
getCount
public int getCount()Returns the number of leaf nodes (page objects) that are descendants of this root within the page tree.- Returns:
- the number of leaf nodes.
-
getCOSObject
Description copied from interface:COSObjectable
Convert this standard java object to a COS object.- Specified by:
getCOSObject
in interfaceCOSObjectable
- Returns:
- The cos object that matches this Java object.
-
remove
public void remove(int index) Removes the page with the given index from the page tree.- Parameters:
index
- zero-based page index
-
remove
Removes the given page from the page tree.- Parameters:
page
- The page to remove.
-
add
Adds the given page to this page tree.- Parameters:
page
- The page to add.
-
insertBefore
Insert a page before another page within a page tree.- Parameters:
newPage
- the page to be inserted.nextPage
- the page that is to be after the new page.- Throws:
IllegalArgumentException
- if one attempts to insert a page that isn't part of a page tree.
-
insertAfter
Insert a page after another page within a page tree.- Parameters:
newPage
- the page to be inserted.prevPage
- the page that is to be before the new page.- Throws:
IllegalArgumentException
- if one attempts to insert a page that isn't part of a page tree.
-