org.openlowcode.tools.pdf

Class PDFPageBand

java.lang.Object

org.openlowcode.tools.pdf.PDFPart

org.openlowcode.tools.pdf.PDFPageBand

public class PDFPageBand
extends PDFPart

A PDF Page Band is made of

• a constant part (header and footer)
• a variable part that will be printed on several pages, the application managing page return

Author:

Open Lowcode SAS

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PDFPageBand.PartialPrintFeedback This class provides the feedback on partial print of a PDFPageBandSection.

Constructor Summary

Constructors

Constructor and Description
PDFPageBand(PDFPageBandHeaders headers, boolean portrait, float leftrightmargin, float topbottommargin)

Method Summary

Modifier and Type	Method and Description
float	getBandLeft() provides the left coordinates of the page band available for content taking into account page margin and page band header left size
float	getBandRight() provides the left coordinates of the page band available for content taking into account page margin and page band header right size
protected int	getPageNumber() This method should be called at the end of the layout phase or during the printing.
protected void	initialize() This method is called just before the actual printing in order to initialize widgets that depend from the content of the full document.
protected void	layoutPages(int pagesbefore) This method is called just after initalize and before print.
protected void	print(org.apache.pdfbox.pdmodel.PDDocument document) This method actually prints the document.
void	printNewSection(PDFPageBandSection sectiontoprint)

Methods inherited from class org.openlowcode.tools.pdf.PDFPart

getParent, setParentPDFDocument

Methods inherited from class java.lang.Object

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

Constructor Detail

PDFPageBand

public PDFPageBand(PDFPageBandHeaders headers,
                   boolean portrait,
                   float leftrightmargin,
                   float topbottommargin)
            throws java.io.IOException

Parameters:

headers - the header function that will write any header and footer on the document

portrait - true if portrait, false if landscape.

leftrightmargin - margin on page at left and right in mm

topbottommargin - margin on page at top and bottom in mm

Throws:

java.io.IOException

Method Detail

print

protected void print(org.apache.pdfbox.pdmodel.PDDocument document)
              throws java.io.IOException

Description copied from class: PDFPart

This method actually prints the document. It is called after initialize and layoutPages for the whole document

Specified by:

print in class PDFPart

Throws:

java.io.IOException

getPageNumber

protected int getPageNumber()

Description copied from class: PDFPart

This method should be called at the end of the layout phase or during the printing.

Specified by:

getPageNumber in class PDFPart

Returns:

layoutPages

protected void layoutPages(int pagesbefore)
                    throws java.io.IOException

Description copied from class: PDFPart

This method is called just after initalize and before print. All PDFParts should perform their page layout at this point. At the end, all pages should be setup, and the index of each page should be known.

Specified by:

layoutPages in class PDFPart

Parameters:

pagesbefore - the number of pages layed-out before.

Throws:

java.io.IOException

printNewSection

public void printNewSection(PDFPageBandSection sectiontoprint)
                     throws java.io.IOException

Parameters:

sectiontoprint -

Throws:

java.io.IOException

getBandLeft

public float getBandLeft()

provides the left coordinates of the page band available for content taking into account page margin and page band header left size

Returns:

value in mm with zero on left

getBandRight

public float getBandRight()

provides the left coordinates of the page band available for content taking into account page margin and page band header right size

Returns:

value in mm with zero on left

initialize

protected void initialize()

Description copied from class: PDFPart

This method is called just before the actual printing in order to initialize widgets that depend from the content of the full document. This is typically needed for table of content. Please note that at this point, pages may not have been layout yet

Specified by:

initialize in class PDFPart