org.openlowcode.tools.pdf

Interface PDFPageBandHeaders

All Known Implementing Classes:

PDFPageBandVoidHeaders

public interface PDFPageBandHeaders

A PDFPageBandHeaders is the constant part of a page band, typically the headers and footers

Author:

Open Lowcode SAS

Method Summary

Modifier and Type	Method and Description
float	getBottomHeaderSpace() the header space at bottom of page in addition to margins declared in the page band
float	getLeftHeaderSpace() the header space at left of page in addition to margins declared in the page band
float	getRightHeaderSpace() the header space at right of page in addition to margins declared in the page band
float	getTopHeaderSpace() the header space at top of page in addition to margins declared in the page band
void	printHeaders(PDFPage currentpage, float leftprintableinmm, float topprintableinmm, float rightprintableinmm, float bottomprintableinmm) Document parent to the page band

Method Detail

printHeaders

void printHeaders(PDFPage currentpage,
                  float leftprintableinmm,
                  float topprintableinmm,
                  float rightprintableinmm,
                  float bottomprintableinmm)
           throws java.io.IOException

Document parent to the page band

Parameters:

currentpage - the page on which to print the header

leftprintableinmm - coordinate to start printing header on (page size and margin taken into account)

topprintableinmm - coordinate to start printing header on (page size and margin taken into account)

rightprintableinmm - coordinate to start printing header on (page size and margin taken into account)

bottomprintableinmm - coordinate to start printing header on (page size and margin taken into account)

Throws:

java.io.IOException

getTopHeaderSpace

float getTopHeaderSpace()

the header space at top of page in addition to margins declared in the page band

Returns:

the positive value in mm

getBottomHeaderSpace

float getBottomHeaderSpace()

the header space at bottom of page in addition to margins declared in the page band

Returns:

the positive value in mm

getLeftHeaderSpace

float getLeftHeaderSpace()

the header space at left of page in addition to margins declared in the page band

Returns:

the positive value in mm

getRightHeaderSpace

float getRightHeaderSpace()

the header space at right of page in addition to margins declared in the page band

Returns:

the positive value in mm