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
void	printNewSection(PDFPageBandSection sectiontoprint)

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

getParent

Methods inherited from class java.lang.Object

equals, 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

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