com.helger.pdflayout

Class PageLayoutPDF

java.lang.Object

com.helger.pdflayout.PageLayoutPDF

@NotThreadSafe
public class PageLayoutPDF
extends Object

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

Constructor Summary

Constructors

Constructor and Description
PageLayoutPDF() Constructor.

Method Summary

Modifier and Type	Method and Description
void	addPageSet(PLPageSet aPageSet) Add a new page set
com.helger.commons.collection.ext.ICommonsList<? extends PLPageSet>	getAllPageSets()
String	getDocumentAuthor()
Calendar	getDocumentCreationDate()
String	getDocumentCreator()
String	getDocumentKeywords()
String	getDocumentSubject()
String	getDocumentTitle()
boolean	isDebug()
com.helger.commons.state.EChange	removePageSet(PLPageSet aPageSet)
void	renderTo(IPDDocumentCustomizer aCustomizer, OutputStream aOS) Render this layout to an OutputStream.
void	renderTo(OutputStream aOS) Render this layout to an OutputStream.
PageLayoutPDF	setDebug(boolean bDebug)
void	setDocumentAuthor(String sDocumentAuthor)
void	setDocumentCreationDate(Calendar aDocumentCreationDate)
void	setDocumentCreator(String sDocumentCreator)
void	setDocumentKeywords(String sDocumentKeywords)
void	setDocumentSubject(String sDocumentSubject)
void	setDocumentTitle(String sDocumentTitle)

Methods inherited from class java.lang.Object

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

Constructor Detail

PageLayoutPDF

public PageLayoutPDF()

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

Method Detail

isDebug

public boolean isDebug()

Returns:

debug mode is active. This will draw additional box lines on the PDF.

setDebug

@Nonnull
public PageLayoutPDF setDebug(boolean bDebug)

Parameters:

bDebug - true to enable PDF debug mode, false to disable it.

Returns:

this for chaining

getDocumentAuthor

@Nullable
public String getDocumentAuthor()

setDocumentAuthor

public void setDocumentAuthor(@Nullable
                              String sDocumentAuthor)

getDocumentCreationDate

@Nullable
public Calendar getDocumentCreationDate()

setDocumentCreationDate

public void setDocumentCreationDate(@Nullable
                                    Calendar aDocumentCreationDate)

getDocumentCreator

@Nullable
public String getDocumentCreator()

setDocumentCreator

public void setDocumentCreator(@Nullable
                               String sDocumentCreator)

getDocumentTitle

@Nullable
public String getDocumentTitle()

setDocumentTitle

public void setDocumentTitle(@Nullable
                             String sDocumentTitle)

getDocumentKeywords

@Nullable
public String getDocumentKeywords()

setDocumentKeywords

public void setDocumentKeywords(@Nullable
                                String sDocumentKeywords)

getDocumentSubject

@Nullable
public String getDocumentSubject()

setDocumentSubject

public void setDocumentSubject(@Nullable
                               String sDocumentSubject)

getAllPageSets

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

addPageSet

public void addPageSet(@Nonnull
                       PLPageSet aPageSet)

Add a new page set

Parameters:

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

removePageSet

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

renderTo

public void 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.

Throws:

PDFCreationException - In case of an error

renderTo

public void renderTo(@Nullable
                     IPDDocumentCustomizer aCustomizer,
                     @Nonnull @WillClose
                     OutputStream aOS)
              throws PDFCreationException

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.

Throws:

PDFCreationException - In case of an error