Java Doc for PDPage.java in  » PDF » PDFBox-0.7.3 » org » pdfbox » pdmodel » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » PDF » PDFBox 0.7.3 » org.pdfbox.pdmodel 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.pdfbox.pdmodel.PDPage

PDPage
public class PDPage implements COSObjectable,Printable(Code)
This represents a single page in a PDF document.
author:
   Ben Litchfield
version:
   $Revision: 1.28 $


Field Summary
final public static  PDRectanglePAGE_SIZE_LETTER
     A page size of LETTER or 8.5x11.

Constructor Summary
public  PDPage()
     Creates a new instance of PDPage with a size of 8.5x11.
public  PDPage(COSDictionary pageDic)
     Creates a new instance of PDPage.

Method Summary
public  BufferedImageconvertToImage()
     Convert this page to an output image.
public  booleanequals(Object other)
    
public  PDRectanglefindCropBox()
     This will find the CropBox for this page by looking up the hierarchy until it finds them.
public  PDRectanglefindMediaBox()
     This will find the MediaBox for this page by looking up the hierarchy until it finds them.
public  PDResourcesfindResources()
     This will find the resources for this page by looking up the hierarchy until it finds them.
public  intfindRotation()
     This will find the rotation for this page by looking up the hierarchy until it finds them.
public  PDPageAdditionalActionsgetActions()
     Get the page actions.
public  ListgetAnnotations()
     This will return a list of the Annotations for this page.
public  PDRectanglegetArtBox()
     A rectangle, expressed in default user space units, defining the extent of the page's meaningful content (including potential white space) as intended by the page's creator The default isthe CropBox.
public  PDRectanglegetBleedBox()
     A rectangle, expressed in default user space units, defining the region to which the contents of the page should be clipped when output in a production environment.
public  COSDictionarygetCOSDictionary()
     This will get the underlying dictionary that this class acts on.
public  COSBasegetCOSObject()
     Convert this standard java object to a COS object.
public  PDStreamgetContents()
     This will get the contents of the PDF Page, in the case that the contents of the page is an array then then the entire array of streams will be be wrapped and appear as a single stream.
public  PDRectanglegetCropBox()
     A rectangle, expressed in default user space units, defining the visible region of default user space.
public  CalendargetLastModified()
     This will get the date that the content stream was last modified.
public  PDRectanglegetMediaBox()
     A rectangle, expressed in default user space units, defining the boundaries of the physical medium on which the page is intended to be displayed or printed This will get the MediaBox at this page and not look up the hierarchy.
public  PDMetadatagetMetadata()
     Get the metadata that is part of the document catalog.
public  PDPageNodegetParent()
     This is the parent page node.
public  PDResourcesgetResources()
     This will get the resources at this page and not look up the hierarchy.
public  IntegergetRotation()
     A value representing the rotation.
public  ListgetThreadBeads()
     This will get a list of PDThreadBead objects, which are article threads in the document.
public  PDRectanglegetTrimBox()
     A rectangle, expressed in default user space units, defining the intended dimensions of the finished page after trimming.
public  inthashCode()
    
public  intprint(Graphics graphics, PageFormat pageFormat, int pageIndex)
    
public  voidsetActions(PDPageAdditionalActions actions)
     Set the page actions.
public  voidsetAnnotations(List annots)
     This will set the list of annotations.
Parameters:
  annots - The new list of annotations.
public  voidsetArtBox(PDRectangle artBox)
     This will set the ArtBox for this page.
public  voidsetBleedBox(PDRectangle bleedBox)
     This will set the BleedBox for this page.
public  voidsetContents(PDStream contents)
     This will set the contents of this page.
public  voidsetCropBox(PDRectangle cropBox)
     This will set the CropBox for this page.
public  voidsetMediaBox(PDRectangle mediaBox)
     This will set the mediaBox for this page.
public  voidsetMetadata(PDMetadata meta)
     Set the metadata for this object.
public  voidsetParent(PDPageNode parent)
     This will set the parent of this page.
public  voidsetResources(PDResources resources)
     This will set the resources for this page.
public  voidsetRotation(int rotation)
     This will set the rotation for this page.
public  voidsetThreadBeads(List beads)
     This will set the list of thread beads.
public  voidsetTrimBox(PDRectangle trimBox)
     This will set the TrimBox for this page.
public  voidupdateLastModified()
     This will update the last modified time for the page object.

Field Detail
PAGE_SIZE_LETTER
final public static PDRectangle PAGE_SIZE_LETTER(Code)
A page size of LETTER or 8.5x11.




Constructor Detail
PDPage
public PDPage()(Code)
Creates a new instance of PDPage with a size of 8.5x11.



PDPage
public PDPage(COSDictionary pageDic)(Code)
Creates a new instance of PDPage.
Parameters:
  pageDic - The existing page dictionary.




Method Detail
convertToImage
public BufferedImage convertToImage() throws IOException(Code)
Convert this page to an output image. A graphical representation of this page.
throws:
  IOException - If there is an error drawing to the image.



equals
public boolean equals(Object other)(Code)



findCropBox
public PDRectangle findCropBox()(Code)
This will find the CropBox for this page by looking up the hierarchy until it finds them. The CropBox at this level in the hierarchy.



findMediaBox
public PDRectangle findMediaBox()(Code)
This will find the MediaBox for this page by looking up the hierarchy until it finds them. The MediaBox at this level in the hierarchy.



findResources
public PDResources findResources()(Code)
This will find the resources for this page by looking up the hierarchy until it finds them. The resources at this level in the hierarchy.



findRotation
public int findRotation()(Code)
This will find the rotation for this page by looking up the hierarchy until it finds them. The rotation at this level in the hierarchy.



getActions
public PDPageAdditionalActions getActions()(Code)
Get the page actions. The Actions for this Page



getAnnotations
public List getAnnotations() throws IOException(Code)
This will return a list of the Annotations for this page. List of the PDAnnotation objects.
throws:
  IOException - If there is an error while creating the annotations.



getArtBox
public PDRectangle getArtBox()(Code)
A rectangle, expressed in default user space units, defining the extent of the page's meaningful content (including potential white space) as intended by the page's creator The default isthe CropBox. The ArtBox attribute.



getBleedBox
public PDRectangle getBleedBox()(Code)
A rectangle, expressed in default user space units, defining the region to which the contents of the page should be clipped when output in a production environment. The default is the CropBox. The BleedBox attribute.



getCOSDictionary
public COSDictionary getCOSDictionary()(Code)
This will get the underlying dictionary that this class acts on. The underlying dictionary for this class.



getCOSObject
public COSBase getCOSObject()(Code)
Convert this standard java object to a COS object. The cos object that matches this Java object.



getContents
public PDStream getContents() throws IOException(Code)
This will get the contents of the PDF Page, in the case that the contents of the page is an array then then the entire array of streams will be be wrapped and appear as a single stream. The page content stream.
throws:
  IOException - If there is an error obtaining the stream.



getCropBox
public PDRectangle getCropBox()(Code)
A rectangle, expressed in default user space units, defining the visible region of default user space. When the page is displayed or printed, its contents are to be clipped (cropped) to this rectangle and then imposed on the output medium in some implementationdefined manner 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. The CropBox at this level in the hierarchy.



getLastModified
public Calendar getLastModified() throws IOException(Code)
This will get the date that the content stream was last modified. This may return null. The date the content stream was last modified.
throws:
  IOException - If there is an error accessing the date information.



getMediaBox
public PDRectangle getMediaBox()(Code)
A rectangle, expressed in default user space units, defining the boundaries of the physical medium on which the page is intended to be displayed or printed 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. The MediaBox at this level in the hierarchy.



getMetadata
public PDMetadata getMetadata()(Code)
Get the metadata that is part of the document catalog. This will return null if there is no meta data for this object. The metadata for this object.



getParent
public PDPageNode getParent()(Code)
This is the parent page node. The parent is a required element of the page. This will be null until this page is added to the document. The parent to this page.



getResources
public PDResources getResources()(Code)
This will get the resources at this page 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. The resources at this level in the hierarchy.



getRotation
public Integer getRotation()(Code)
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. The rotation at this level in the hierarchy.



getThreadBeads
public List getThreadBeads()(Code)
This will get a list of PDThreadBead objects, which are article threads in the document. This will return an empty list of there are no thread beads. A list of article threads on this page.



getTrimBox
public PDRectangle getTrimBox()(Code)
A rectangle, expressed in default user space units, defining the intended dimensions of the finished page after trimming. The default is the CropBox. The TrimBox attribute.



hashCode
public int hashCode()(Code)



print
public int print(Graphics graphics, PageFormat pageFormat, int pageIndex) throws PrinterException(Code)



setActions
public void setActions(PDPageAdditionalActions actions)(Code)
Set the page actions.
Parameters:
  actions - The actions for the page.



setAnnotations
public void setAnnotations(List annots)(Code)
This will set the list of annotations.
Parameters:
  annots - The new list of annotations.



setArtBox
public void setArtBox(PDRectangle artBox)(Code)
This will set the ArtBox for this page.
Parameters:
  artBox - The new ArtBox for this page.



setBleedBox
public void setBleedBox(PDRectangle bleedBox)(Code)
This will set the BleedBox for this page.
Parameters:
  bleedBox - The new BleedBox for this page.



setContents
public void setContents(PDStream contents)(Code)
This will set the contents of this page.
Parameters:
  contents - The new contents of the page.



setCropBox
public void setCropBox(PDRectangle cropBox)(Code)
This will set the CropBox for this page.
Parameters:
  cropBox - The new CropBox for this page.



setMediaBox
public void setMediaBox(PDRectangle mediaBox)(Code)
This will set the mediaBox for this page.
Parameters:
  mediaBox - The new mediaBox for this page.



setMetadata
public void setMetadata(PDMetadata meta)(Code)
Set the metadata for this object. This can be null.
Parameters:
  meta - The meta data for this object.



setParent
public void setParent(PDPageNode parent)(Code)
This will set the parent of this page.
Parameters:
  parent - The parent to this page node.



setResources
public void setResources(PDResources resources)(Code)
This will set the resources for this page.
Parameters:
  resources - The new resources for this page.



setRotation
public void setRotation(int rotation)(Code)
This will set the rotation for this page.
Parameters:
  rotation - The new rotation for this page.



setThreadBeads
public void setThreadBeads(List beads)(Code)
This will set the list of thread beads.
Parameters:
  beads - A list of PDThreadBead objects or null.



setTrimBox
public void setTrimBox(PDRectangle trimBox)(Code)
This will set the TrimBox for this page.
Parameters:
  trimBox - The new TrimBox for this page.



updateLastModified
public void updateLastModified()(Code)
This will update the last modified time for the page object.



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.