Package com.helger.pdflayout

Class PageLayoutPDF

java.lang.Object

com.helger.pdflayout.PageLayoutPDF

All Implemented Interfaces:

IPLVisitable

@NotThreadSafe
public class PageLayoutPDF
extends Object
implements IPLVisitable

Main class for creating layouted PDFs. This class contains the meta data as well as a list of PLPageSet objects that represent a set of pages with a consistent layouting scheme.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	DEFAULT_COMPRESS_PDF	By default certain parts of the created PDFs are compressed, to safe space.
static boolean	DEFAULT_CREATE_PDF_A	By default no PDF/A compliant PDF is created.

Constructor Summary

Constructors

Constructor	Description
PageLayoutPDF()	Constructor.

Method Summary

Modifier and Type	Method	Description
PageLayoutPDF	addPageSet(PLPageSet aPageSet)	Add a new page set
com.helger.commons.collection.impl.ICommonsList<? extends PLPageSet>	getAllPageSets()
String	getDocumentAuthor()
LocalDateTime	getDocumentCreationDateTime()
String	getDocumentCreator()
IPDDocumentCustomizer	getDocumentCustomizer()
String	getDocumentKeywords()
String	getDocumentSubject()
String	getDocumentTitle()
boolean	isCompressPDF()
boolean	isCreatePDF_A()
com.helger.commons.state.EChange	removePageSet(PLPageSet aPageSet)
PageLayoutPDF	renderTo(IPDDocumentCustomizer aCustomizer, OutputStream aOS)	Deprecated. Since 5.1.0; Call setDocumentCustomizer(IPDDocumentCustomizer) and than renderTo(OutputStream)
PageLayoutPDF	renderTo(File aFile)	Render this layout to a File.
PageLayoutPDF	renderTo(OutputStream aOS)	Render this layout to an OutputStream.
PageLayoutPDF	setCompressPDF(boolean bCompressPDF)
PageLayoutPDF	setCreatePDF_A(boolean bCreatePDF_A)
PageLayoutPDF	setDocumentAuthor(String sDocumentAuthor)
PageLayoutPDF	setDocumentCreationDateTime(LocalDateTime aDocumentCreationDate)
PageLayoutPDF	setDocumentCreator(String sDocumentCreator)
PageLayoutPDF	setDocumentCustomizer(IPDDocumentCustomizer aDocumentCustomizer)
PageLayoutPDF	setDocumentKeywords(String sDocumentKeywords)
PageLayoutPDF	setDocumentSubject(String sDocumentSubject)
PageLayoutPDF	setDocumentTitle(String sDocumentTitle)
com.helger.commons.state.EChange	visit(IPLVisitor aVisitor)	Visit this object and all descendants

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_COMPRESS_PDF

public static final boolean DEFAULT_COMPRESS_PDF

By default certain parts of the created PDFs are compressed, to safe space.

See Also:

Constant Field Values

DEFAULT_CREATE_PDF_A

public static final boolean DEFAULT_CREATE_PDF_A

By default no PDF/A compliant PDF is created.

See Also:

Constant Field Values

Constructor Detail

PageLayoutPDF

public PageLayoutPDF()

Constructor. Initializes Author, CreationDate and Creator from class VendorInfo.

Method Detail

isCompressPDF

public final boolean isCompressPDF()

Returns:

if PDF content should be compressed or not.

setCompressPDF

@Nonnull
public final PageLayoutPDF setCompressPDF(boolean bCompressPDF)

Parameters:

bCompressPDF - true to enable creation of compressed PDFs, false to disable it.

Returns:

this for chaining

isCreatePDF_A

public final boolean isCreatePDF_A()

Returns:

if PDF/A conformant PDF should be created or not.

Since:

6.0.3

setCreatePDF_A

@Nonnull
public final PageLayoutPDF setCreatePDF_A(boolean bCreatePDF_A)

Parameters:

bCreatePDF_A - true to enable creation of PDF/A, false to disable it.

Returns:

this for chaining

Since:

6.0.3

getDocumentAuthor

@Nullable
public final String getDocumentAuthor()

setDocumentAuthor

@Nonnull
public final PageLayoutPDF setDocumentAuthor(@Nullable
                                             String sDocumentAuthor)

getDocumentCreationDateTime

@Nullable
public final LocalDateTime getDocumentCreationDateTime()

setDocumentCreationDateTime

@Nonnull
public final PageLayoutPDF setDocumentCreationDateTime(@Nullable
                                                       LocalDateTime aDocumentCreationDate)

getDocumentCreator

@Nullable
public final String getDocumentCreator()

setDocumentCreator

@Nonnull
public final PageLayoutPDF setDocumentCreator(@Nullable
                                              String sDocumentCreator)

getDocumentTitle

@Nullable
public final String getDocumentTitle()

setDocumentTitle

@Nonnull
public final PageLayoutPDF setDocumentTitle(@Nullable
                                            String sDocumentTitle)

getDocumentKeywords

@Nullable
public final String getDocumentKeywords()

setDocumentKeywords

@Nonnull
public final PageLayoutPDF setDocumentKeywords(@Nullable
                                               String sDocumentKeywords)

getDocumentSubject

@Nullable
public final String getDocumentSubject()

setDocumentSubject

@Nonnull
public final PageLayoutPDF setDocumentSubject(@Nullable
                                              String sDocumentSubject)

getAllPageSets

@Nonnull
@ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsList<? extends PLPageSet> getAllPageSets()

addPageSet

@Nonnull
public PageLayoutPDF addPageSet(@Nonnull
                                PLPageSet aPageSet)

Add a new page set

Parameters:

aPageSet - The page set to be added. May not be null.

Returns:

this for chaining

removePageSet

@Nonnull
public com.helger.commons.state.EChange removePageSet(@Nullable
                                                      PLPageSet aPageSet)

getDocumentCustomizer

@Nullable
public final IPDDocumentCustomizer getDocumentCustomizer()

setDocumentCustomizer

@Nonnull
public final PageLayoutPDF setDocumentCustomizer(@Nullable
                                                 IPDDocumentCustomizer aDocumentCustomizer)

visit

@Nonnull
public com.helger.commons.state.EChange visit(@Nonnull
                                              IPLVisitor aVisitor)
                                       throws IOException

Description copied from interface: IPLVisitable

Visit this object and all descendants

Specified by:

visit in interface IPLVisitable

Parameters:

aVisitor - The visitor to use. May not be null.

Returns:

EChange.CHANGED if something changed internally.

Throws:

IOException - on PDFBox error

renderTo

@Nonnull
public PageLayoutPDF renderTo(@Nonnull @WillClose
                              OutputStream aOS)
                       throws PDFCreationException

Render this layout to an OutputStream.

Parameters:

aOS - The output stream to write to. May not be null. Is closed automatically.

Returns:

this for chaining

Throws:

PDFCreationException - In case of an error

renderTo

@Nonnull
@Deprecated
public final PageLayoutPDF renderTo(@Nullable
                                    IPDDocumentCustomizer aCustomizer,
                                    @Nonnull @WillClose
                                    OutputStream aOS)
                             throws PDFCreationException

Deprecated.

Since 5.1.0; Call setDocumentCustomizer(IPDDocumentCustomizer) and than renderTo(OutputStream)

Render this layout to an OutputStream.

Parameters:

aCustomizer - The customizer to be invoked before the document is written to the stream. May be null.

aOS - The output stream to write to. May not be null. Is closed automatically.

Returns:

this for chaining

Throws:

PDFCreationException - In case of an error

renderTo

@Nonnull
public PageLayoutPDF renderTo(@Nonnull
                              File aFile)
                       throws PDFCreationException

Render this layout to a File.

Parameters:

aFile - The output stream to write to. May not be null. Is closed automatically.

Returns:

this for chaining

Throws:

PDFCreationException - In case of an error

IllegalArgumentException - In case the file cannot be opened for writing

Since:

5.1.0