java.lang.Object
org.jfree.pdf.PDFDocument
Represents a PDF document. The focus of this implementation is to
allow the use of the
PDFGraphics2D
class to generate PDF content,
typically in the following manner:
PDFDocument pdfDoc = new PDFDocument();
Page page = pdfDoc.createPage(new Rectangle(612, 468));
PDFGraphics2D g2 = page.getGraphics2D();
g2.setPaint(Color.RED);
g2.draw(new Rectangle(10, 10, 40, 50));
pdfDoc.writeToFile(new File("demo.pdf"));
The implementation is light-weight and works very well alongside packages such as JFreeChart and Orson Charts.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreatePage
(Rectangle2D bounds) Creates a newPage
, adds it to the document, and returns a reference to thePage
.Returns the author for the document.int
Returns a new PDF object number and increments the internal counter for the next PDF object number.byte[]
Returns a byte array containing the encoding of this PDF document.getTitle()
Returns the title for the document.boolean
Returns the debug mode flag that controls whether or not the output stream is filtered.void
Sets the author for the document.void
setDebugMode
(boolean debug) Sets the debug MODE flag (this needs to be set before any call tocreatePage(java.awt.geom.Rectangle2D)
).void
Sets the title for the document.void
writeToFile
(File f) Writes the PDF document to a file.
-
Constructor Details
-
PDFDocument
public PDFDocument()Creates a newPDFDocument
, initially with no content.
-
-
Method Details
-
getTitle
Returns the title for the document. The default value isnull
.- Returns:
- The title for the document (possibly
null
).
-
setTitle
Sets the title for the document.- Parameters:
title
- the title (null
permitted).
-
getAuthor
Returns the author for the document. The default value isnull
.- Returns:
- The author for the document (possibly
null
).
-
setAuthor
Sets the author for the document.- Parameters:
author
- the author (null
permitted).
-
isDebugMode
Returns the debug mode flag that controls whether or not the output stream is filtered.- Returns:
- The debug flag.
- Since:
- 1.4
-
setDebugMode
Sets the debug MODE flag (this needs to be set before any call tocreatePage(java.awt.geom.Rectangle2D)
).- Parameters:
debug
- the new flag value.- Since:
- 1.4
-
createPage
Creates a newPage
, adds it to the document, and returns a reference to thePage
.- Parameters:
bounds
- the page bounds (null
not permitted).- Returns:
- The new page.
-
getNextNumber
Returns a new PDF object number and increments the internal counter for the next PDF object number. This method is used to ensure that all objects in the document are assigned a unique number.- Returns:
- A new PDF object number.
-
getPDFBytes
Returns a byte array containing the encoding of this PDF document.- Returns:
- A byte array containing the encoding of this PDF document.
-
writeToFile
Writes the PDF document to a file. This is not a robust method, it exists mainly for the demo output.- Parameters:
f
- the file.
-