|
jPod PDF library | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.intarsys.pdf.cos.COSBasedObject
de.intarsys.pdf.pd.PDObject
de.intarsys.pdf.pd.PDPageNode
public abstract class PDPageNode
An abstract superclass for pages and page tree nodes
Nested Class Summary | |
---|---|
static class |
PDPageNode.MetaClass
The meta class implementation |
Field Summary | |
---|---|
static COSName |
CN_Type_Page
|
static COSName |
CN_Type_Pages
|
static COSName |
DK_Parent
|
static COSName |
DK_Rotate
|
static PDPageNode.MetaClass |
META
The meta class instance |
Fields inherited from class de.intarsys.pdf.pd.PDObject |
---|
DK_Subtype, DK_Type |
Method Summary | |
---|---|
void |
dispose()
Deprecated. |
abstract int |
getCount()
The total number of pages represented by this node. |
CDSRectangle |
getCropBox()
The rectangle in user space coordinates defining the visible region of the page. |
PDAnnotation |
getFirstAnnotation()
The first PDAnnotation linked on this page. |
abstract PDPageNode |
getFirstNode()
Get the first node within the receiver or the receiver if it is not a collection (page tree). |
abstract PDPage |
getFirstPage()
Get the first page (leaf node) within the receiver hierarchy. |
PDObject |
getGenericParent()
The parent of the receiver if it is a node in a hierarchical structure (like page nodes or form fields). |
PDAnnotation |
getLastAnnotation()
The last PDAnnotation linked on this page. |
abstract PDPageNode |
getLastNode()
Get the last node within the receiver or the receiver if it is not a collection (page tree). |
abstract PDPage |
getLastPage()
Get the last page (leaf node) within the receiver hierarchy. |
CDSRectangle |
getMediaBox()
The rectangle in user space coordinates defining the physical page boundaries. user space is measured in 1/72 inch initially |
PDPageNode |
getNextNode()
Get the next node after the receiver. |
int |
getNodeIndex()
The zero based index of this within the document. |
PDPage |
getPageAt(int index)
The page at index within the receivers subtree. |
PDPageTree |
getParent()
The parent node if available. |
PDPageNode |
getPreviousNode()
The previous node . |
int |
getRotate()
The number of degrees by which the page should be rotated clockwise when displayed or printed. |
void |
invalidateCaches()
Invalidate all local caches as the base object may have changed. |
abstract boolean |
isPage()
Answer true if this is a single page node. |
abstract boolean |
isValid()
true if this page node object is a valid participant in
the documents page tree. |
void |
setCropBox(CDSRectangle rect)
Set the rectangle in user space coordinates defining the visible region of the page. user space is measured in 1/72 inch initially |
void |
setGenericParent(PDObject newParent)
Set the parent of the receiver if it is a node in a hierarchical structure (like page nodes or form fields). |
void |
setMediaBox(CDSRectangle rect)
Set the rectangle in user space coordinates defining the physical page boundaries. user space is measured in 1/72 inch initially |
void |
setRotate(int rotate)
The number of degrees by which the page should be rotated clockwise when displayed or printed. |
Methods inherited from class de.intarsys.pdf.pd.PDObject |
---|
cosGetFieldDescendant, cosGetFieldInheritable, cosGetFieldInherited, cosGetSubtype, cosGetType, cosRemoveFieldInheritable, cosSetFieldInheritable, cosSetSubtype, cosSetType, getDoc, getGenericChildren, toString |
Methods inherited from class de.intarsys.pdf.cos.COSBasedObject |
---|
changed, cosGetArray, cosGetDict, cosGetDoc, cosGetField, cosGetObject, cosGetStream, cosHasField, cosRemoveField, cosSetField, getAttribute, getFieldBoolean, getFieldDate, getFieldFixed, getFieldFixedArray, getFieldInt, getFieldMLString, getFieldString, removeAttribute, setAttribute, setFieldBoolean, setFieldFixed, setFieldInt, setFieldMLString, setFieldName, setFieldObject, setFieldString |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final PDPageNode.MetaClass META
public static final COSName DK_Parent
public static final COSName CN_Type_Pages
public static final COSName CN_Type_Page
public static final COSName DK_Rotate
Method Detail |
---|
@Deprecated public void dispose()
public abstract int getCount()
public CDSRectangle getCropBox()
public PDAnnotation getFirstAnnotation()
PDAnnotation
linked on this page.
PDAnnotation
linked on this page.public abstract PDPageNode getFirstNode()
This may return null if the receiver is an empty collection.
public abstract PDPage getFirstPage()
public PDObject getGenericParent()
PDObject
A concrete PDObject implementation supporting inheritance should implement this method.
getGenericParent
in class PDObject
public PDAnnotation getLastAnnotation()
PDAnnotation
linked on this page.
PDAnnotation
linked on this page.public abstract PDPageNode getLastNode()
This may return null if the receiver is an empty collection.
public abstract PDPage getLastPage()
public CDSRectangle getMediaBox()
public PDPageNode getNextNode()
public int getNodeIndex()
this
within the document.
this
within the document.public PDPage getPageAt(int index)
index
within the receivers subtree.
index
- The page index
index
within the receivers subtree.public PDPageTree getParent()
public PDPageNode getPreviousNode()
public int getRotate()
Notice: the value is inheritable
public void invalidateCaches()
COSBasedObject
invalidateCaches
in class COSBasedObject
public abstract boolean isPage()
true
if this is a single page node.
true
if this is a single page node.public abstract boolean isValid()
true
if this page node object is a valid participant in
the documents page tree.
true
if this page node object is a valid
participant in the documents page tree.public void setCropBox(CDSRectangle rect)
rect
- The rectangle defining the visible page regionpublic void setGenericParent(PDObject newParent)
PDObject
A concrete PDObject implementation supporting inheritance should implement this method.
setGenericParent
in class PDObject
newParent
- The new parent object.public void setMediaBox(CDSRectangle rect)
rect
- The rectangle defining the physical page boundariespublic void setRotate(int rotate)
Notice: This object and its children are affected on a change!
rotate
- A multiple of 90, the value is not checked for a legal
value
|
jPod PDF library | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |