Home » pdfbox-1.1.0-src » org.apache.pdfbox.pdmodel » [javadoc | source]
org.apache.pdfbox.pdmodel
public class: PDPageNode [javadoc | source]
java.lang.Object
   org.apache.pdfbox.pdmodel.PDPageNode

All Implemented Interfaces:
    COSObjectable

This represents a page node in a pdf document.
Constructor:
 public PDPageNode() 
 public PDPageNode(COSDictionary pages) 
    Creates a new instance of PDPage.
    Parameters:
    pages - The dictionary pages.
Method from org.apache.pdfbox.pdmodel.PDPageNode Summary:
findCropBox,   findMediaBox,   findResources,   findRotation,   getAllKids,   getCOSObject,   getCount,   getCropBox,   getDictionary,   getKids,   getMediaBox,   getParent,   getResources,   getRotation,   setCropBox,   setMediaBox,   setParent,   setResources,   setRotation,   updateCount
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.pdfbox.pdmodel.PDPageNode Detail:
 public PDRectangle findCropBox() 
    This will find the CropBox for this page by looking up the hierarchy until it finds them.
 public PDRectangle findMediaBox() 
    This will find the MediaBox for this page by looking up the hierarchy until it finds them.
 public PDResources findResources() 
    This will find the resources for this page by looking up the hierarchy until it finds them.
 public int findRotation() 
    This will find the rotation for this page by looking up the hierarchy until it finds them.
 public  void getAllKids(List result) 
    This will return all kids of this node as PDPage.
 public COSBase getCOSObject() 
    {@inheritDoc}
 public long getCount() 
    This will get the count of descendent page objects.
 public PDRectangle getCropBox() 
    This will get the CropBox at this page and not look up the hierarchy. This attribute is inheritable, and findCropBox() should probably used. This will return null if no CropBox is available at this level.
 public COSDictionary getDictionary() 
    This will get the underlying dictionary that this class acts on.
 public List getKids() 
    This will return all kids of this node, either PDPageNode or PDPage.
 public PDRectangle getMediaBox() 
    This will get the MediaBox at this page and not look up the hierarchy. This attribute is inheritable, and findMediaBox() should probably used. This will return null if no MediaBox are available at this level.
 public PDPageNode getParent() 
    This is the parent page node.
 public PDResources getResources() 
    This will get the resources at this page node and not look up the hierarchy. This attribute is inheritable, and findResources() should probably used. This will return null if no resources are available at this level.
 public Integer getRotation() 
    A value representing the rotation. This will be null if not set at this level The number of degrees by which the page should be rotated clockwise when displayed or printed. The value must be a multiple of 90. This will get the rotation at this page and not look up the hierarchy. This attribute is inheritable, and findRotation() should probably used. This will return null if no rotation is available at this level.
 public  void setCropBox(PDRectangle cropBox) 
    This will set the CropBox for this page.
 public  void setMediaBox(PDRectangle mediaBox) 
    This will set the mediaBox for this page.
 public  void setParent(PDPageNode parent) 
    This will set the parent of this page.
 public  void setResources(PDResources resources) 
    This will set the resources for this page.
 public  void setRotation(int rotation) 
    This will set the rotation for this page.
 public long updateCount() 
    This will update the count attribute of the page node. This only needs to be called if you add or remove pages. The PDDocument will call this for you when you use the PDDocumnet persistence methods. So, basically most clients will never need to call this.