org.openlowcode.tools.pdf

Class PDFMultiPageTable

java.lang.Object

org.openlowcode.tools.pdf.PDFMultiPageTable

All Implemented Interfaces:

PDFPageBandSection

Direct Known Subclasses:

PDFMultiPageTableWithRichText

public class PDFMultiPageTable
extends java.lang.Object
implements PDFPageBandSection

A multiple-page table that will by default print the header on each page. The columns will not be separated.

Author:

Open Lowcode SAS

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	PDFMultiPageTable.CellText Holds information about a single cell display

Field Summary

Fields

Modifier and Type	Field and Description
protected float[]	columnwidthinmm

Constructor Summary

Constructors

Constructor and Description
PDFMultiPageTable(float[] columnrelativewidth) Creates a table of columns with different width taking the full page width
PDFMultiPageTable(float leftmargin, float rightmargin, float[] columnrelativewidth)
PDFMultiPageTable(float leftmargin, float rightmargin, int columnnumber)
PDFMultiPageTable(int columnnumber) Creates a table of columns with similar width taking the full page width

Method Summary

Modifier and Type	Method and Description
void	addBlankLine() Creates a new line without content.
void	addBlankLine(boolean drawlineabove) Creates a new line without content.
void	addOneLineContent(java.lang.String[] linecontent) create a new line with the given content and a line above
boolean	breakableSection() This method specifies if the section can be broken (and so printed across several pages.
java.lang.String	dropContentSample() this class drops a content sample for logging purposes.
PDFMultiPageTable.CellText	getCellContent(int row, int column)
protected float	getCellHeight(float columnwidth, int lineindex, int columnindex) calculates the height of the cell.
int	getColumnNumber()
float	getSectionHeight(float leftinmm, float rightinmm) the height of section that needs to be printed
void	initialize() This method allows sections to initialize themselves knowning the full reference of the document before the page number is calculated
void	print(PDFPageBand pageband, PDFPage currentpage, float mmfromtopforsection, float leftinmm, float rightinmm)
protected void	printOneCell(PDFPage currentpage, int rowindex, int columnindex, float mmfromtopforsection, float currentleft, float currentcolumnwidth) This method prints the content of one row of a table.
PDFPageBand.PartialPrintFeedback	printPartial(PDFPageBand pageband, float spaceleft, PDFPage currentpage, float mmfromtopforsection, float leftinmm, float rightinmm)
void	setCellContent(java.lang.String cellcontent, int columnindex)
void	setCellContent(java.lang.String cellcontent, int columnindex, boolean showasnumber)
void	setHeader(java.lang.String headertext, int columnindex)
void	setHeaders(java.lang.String[] headertexts)
void	setParentDocument(PDFDocument document) Provides automatically the PDFDocument to the PDFPageBandSection.

Methods inherited from class java.lang.Object

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

Field Detail

columnwidthinmm

protected float[] columnwidthinmm

Constructor Detail

PDFMultiPageTable

public PDFMultiPageTable(int columnnumber)

Creates a table of columns with similar width taking the full page width

Parameters:

columnnumber - number of columns of same size

PDFMultiPageTable

public PDFMultiPageTable(float[] columnrelativewidth)

Creates a table of columns with different width taking the full page width

Parameters:

columnrelativewidth - a table of strictly positive float numbers. It does not need to be the width of columns in milimeter as the utility will resize the columns according to width available, so you can also use percentage or another scale

PDFMultiPageTable

public PDFMultiPageTable(float leftmargin,
                         float rightmargin,
                         int columnnumber)

Parameters:

leftmargin - space left blank on the left size of the table (betweeen left border of the page band and table)

rightmargin - space left blank on the right size of the table (betweeen table and left border of the page band)

columnnumber - number of columns of same size

PDFMultiPageTable

public PDFMultiPageTable(float leftmargin,
                         float rightmargin,
                         float[] columnrelativewidth)

Parameters:

leftmargin - space left blank on the left size of the table (betweeen left border of the page band and table)

rightmargin - space left blank on the right size of the table (betweeen table and left border of the page band)

columnrelativewidth - a table of strictly positive float numbers. It does not need to be the width of columns in milimeter as the utility will resize the columns according to width available, so you can also use

Method Detail

getColumnNumber

public int getColumnNumber()

Returns:

the number of columns in the table

getCellContent

public PDFMultiPageTable.CellText getCellContent(int row,
                                                 int column)

Parameters:

row - index of row, starting by 0

column - index of column, starting by 0

Returns:

setHeaders

public void setHeaders(java.lang.String[] headertexts)

Parameters:

headertexts - the list of header texts (should be consistent with the column number)

setHeader

public void setHeader(java.lang.String headertext,
                      int columnindex)

Parameters:

headertext - the text to print as header

columnindex - index of column between 0 (included) and columnnumber (excluded)

addOneLineContent

public void addOneLineContent(java.lang.String[] linecontent)

create a new line with the given content and a line above

Parameters:

linecontent - content of the line

addBlankLine

public void addBlankLine(boolean drawlineabove)

Creates a new line without content. Content can then be added by setCellContent. The new line is created with or without a bar above

Parameters:

drawlineabove - if true,draws a line above

addBlankLine

public void addBlankLine()

Creates a new line without content. Content can then be added by setCellContent. The new line is created with a bar above

setCellContent

public void setCellContent(java.lang.String cellcontent,
                           int columnindex,
                           boolean showasnumber)

Parameters:

cellcontent - text to include in the cell

columnindex - index of the column, starting with zero

showasnumber - if true, will display as right aligned constant space number

setCellContent

public void setCellContent(java.lang.String cellcontent,
                           int columnindex)

Parameters:

cellcontent -

columnindex -

getCellHeight

protected float getCellHeight(float columnwidth,
                              int lineindex,
                              int columnindex)
                       throws java.io.IOException

calculates the height of the cell. This method can be overloaded by subclasses with specific layout (rich-text...)

Parameters:

columnwidth - width of the table column

lineindex - line index starting with 0

columnindex - column index starting with 0

Returns:

the height of the cell

Throws:

java.io.IOException

printOneCell

protected void printOneCell(PDFPage currentpage,
                            int rowindex,
                            int columnindex,
                            float mmfromtopforsection,
                            float currentleft,
                            float currentcolumnwidth)
                     throws java.io.IOException

This method prints the content of one row of a table. It can be overriden by subclasses wishing to add their own formatting

Parameters:

currentpage - page to print in

rowindex - index of the row (starting with 0)

columnindex - index of the column (starting with 0)

mmfromtopforsection - vertical position for printing as per pageband mechanism

currentleft - left of the cell

currentcolumnwidth - with of the cell

Throws:

java.io.IOException - if any exception is raised regarding printing of the content

print

public void print(PDFPageBand pageband,
                  PDFPage currentpage,
                  float mmfromtopforsection,
                  float leftinmm,
                  float rightinmm)
           throws java.io.IOException

Specified by:

print in interface PDFPageBandSection

Parameters:

pageband - pageband calling the method. That allows for recursive calling

currentpage - the page to print into

mmfromtopforsection - the cursor location to start printing at

leftinmm - the index of the left most printable space of the printing section

rightinmm - the index of the right most printable space of the printing section

Throws:

java.io.IOException

getSectionHeight

public float getSectionHeight(float leftinmm,
                              float rightinmm)
                       throws java.io.IOException

Description copied from interface: PDFPageBandSection

the height of section that needs to be printed

Specified by:

getSectionHeight in interface PDFPageBandSection

Parameters:

leftinmm - the index of the left most printable space of the printing section

rightinmm - the index of the right most printable space of the printing section

Returns:

the positive value in mm

Throws:

java.io.IOException

breakableSection

public boolean breakableSection()

Description copied from interface: PDFPageBandSection

This method specifies if the section can be broken (and so printed across several pages.

Specified by:

breakableSection in interface PDFPageBandSection

Returns:

true if section is breakable, false else

printPartial

public PDFPageBand.PartialPrintFeedback printPartial(PDFPageBand pageband,
                                                     float spaceleft,
                                                     PDFPage currentpage,
                                                     float mmfromtopforsection,
                                                     float leftinmm,
                                                     float rightinmm)
                                              throws java.io.IOException

Specified by:

printPartial in interface PDFPageBandSection

Parameters:

pageband - pageband calling the method. That allows for recursive calling

spaceleft - the space (height) in mm

currentpage - the page to print into

mmfromtopforsection - the cursor location to start printing at

leftinmm - the index of the left most printable space of the printing section

rightinmm - the index of the right most printable space of the printing section

Returns:

a status of if print is finished and the space consumed (new cursor is sent back)

Throws:

java.io.IOException

dropContentSample

public java.lang.String dropContentSample()

Description copied from interface: PDFPageBandSection

this class drops a content sample for logging purposes.

Specified by:

dropContentSample in interface PDFPageBandSection

Returns:

a string sample of around 100 characters

setParentDocument

public void setParentDocument(PDFDocument document)

Description copied from interface: PDFPageBandSection

Provides automatically the PDFDocument to the PDFPageBandSection. This is useful for sections that need full access to the whole document (today, only the DocumentTableOfContent needs it)

Specified by:

setParentDocument in interface PDFPageBandSection

Parameters:

document - the parent document to the PDFPageBand.

initialize

public void initialize()

Description copied from interface: PDFPageBandSection

This method allows sections to initialize themselves knowning the full reference of the document before the page number is calculated

Specified by:

initialize in interface PDFPageBandSection