cc.catalysts.boot.report.pdf.elements

Class ReportTable

java.lang.Object

cc.catalysts.boot.report.pdf.elements.ReportTable

All Implemented Interfaces:

ReportElement

public class ReportTable
extends java.lang.Object
implements ReportElement

IMPORTANT: Although this class is publicly visible, it is subject to change and may not be implemented by clients!

Constructor Summary

Constructors

Constructor and Description
ReportTable(PdfStyleSheet pdfStyleSheet, float[] cellWidths, ReportElement[][] elements, ReportElement[] title)

Method Summary

Modifier and Type	Method and Description
float[]	getCellWidths()
ReportElement[][]	getElements()
boolean	getExtraSplitting()
float	getFirstSegmentHeight(float allowedWidth) in case isSplitable is true, this method will be called.
float	getHeight(float allowedWidth) Height of this segment
float	getHeightOfElementToSplit(float allowedWidth, float allowedHeight) For splittable elements returns the current height of the element that needs to be split.
java.util.Collection<ReportImage.ImagePrintIntent>	getImageIntents() Returns all the images that should have been printed by this element
PdfStyleSheet	getPdfStyleSheet()
ReportElement[]	getTitle()
boolean	isSplitable() In case the element may be split over pages, this method should return true
float	print(org.apache.pdfbox.pdmodel.PDDocument document, org.apache.pdfbox.pdmodel.PDPageContentStream stream, int pageNumber, float startX, float startY, float allowedWidth)
void	setBorder(boolean border)
void	setCellPaddingX(float cellPaddingX)
void	setCellPaddingY(float cellPaddingY)
void	setExtraSplitting(boolean enableExtraSplitting)
void	setNoBottomBorder(boolean border)
void	setNoInnerBorders(boolean noInnerBorders)
void	setNoTopBorder(boolean border)
void	setSplitable(boolean isSplitable)
void	setTextAlignInColumn(int column, ReportAlignType alignType, boolean excludeHeader)
void	setVerticalAlignInColumn(int column, ReportVerticalAlignType alignType)
ReportElement[]	split(float allowedWidth) If the element my be split this method should return two elements.
ReportElement[]	split(float allowedWidth, float allowedHeight) Will split the report element, so the height of the first segment will the maximum value less or equal to the allowed height value.
ReportElement[]	splitFirstCell(float allowedHeight, float allowedWidth)

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportTable

public ReportTable(PdfStyleSheet pdfStyleSheet,
                   float[] cellWidths,
                   ReportElement[][] elements,
                   ReportElement[] title)

Parameters:

cellWidths - width of each column (the sum of elements must be 1)

elements - elements of each cell

pdfStyleSheet - the stylesheet to be used for this table

title - the titles for the report (first row)

Method Detail

setNoInnerBorders

public void setNoInnerBorders(boolean noInnerBorders)

setNoBottomBorder

public void setNoBottomBorder(boolean border)

setNoTopBorder

public void setNoTopBorder(boolean border)

setBorder

public void setBorder(boolean border)

setExtraSplitting

public void setExtraSplitting(boolean enableExtraSplitting)

setCellPaddingX

public void setCellPaddingX(float cellPaddingX)

Parameters:

cellPaddingX - for left and right

setCellPaddingY

public void setCellPaddingY(float cellPaddingY)

Parameters:

cellPaddingY - for top and bottom

getExtraSplitting

public boolean getExtraSplitting()

print

public float print(org.apache.pdfbox.pdmodel.PDDocument document,
                   org.apache.pdfbox.pdmodel.PDPageContentStream stream,
                   int pageNumber,
                   float startX,
                   float startY,
                   float allowedWidth)
            throws java.io.IOException

Specified by:

print in interface ReportElement

Parameters:

document - PdfBox document

stream - PdfBox stream

pageNumber - current page number (0 based)

startX - starting x

startY - starting y

allowedWidth - maximal width of segment

Returns:

the Y position of the next line

Throws:

java.io.IOException - in case something happens during printing

getHeight

public float getHeight(float allowedWidth)

Description copied from interface: ReportElement

Height of this segment

Specified by:

getHeight in interface ReportElement

Parameters:

allowedWidth - allowed with of the segment

Returns:

height of the segment

isSplitable

public boolean isSplitable()

Description copied from interface: ReportElement

In case the element may be split over pages, this method should return true

Specified by:

isSplitable in interface ReportElement

Returns:

may the element be split over multiple pages

setSplitable

public void setSplitable(boolean isSplitable)

getFirstSegmentHeight

public float getFirstSegmentHeight(float allowedWidth)

Description copied from interface: ReportElement

in case isSplitable is true, this method will be called.

Specified by:

getFirstSegmentHeight in interface ReportElement

Parameters:

allowedWidth - the maximum allowed width for this element

Returns:

the height of the first nonSplitable segment

getImageIntents

public java.util.Collection<ReportImage.ImagePrintIntent> getImageIntents()

Description copied from interface: ReportElement

Returns all the images that should have been printed by this element

Specified by:

getImageIntents in interface ReportElement

Returns:

collection, can't be null, migth be empty

splitFirstCell

public ReportElement[] splitFirstCell(float allowedHeight,
                                      float allowedWidth)

getHeightOfElementToSplit

public float getHeightOfElementToSplit(float allowedWidth,
                                       float allowedHeight)

Description copied from interface: ReportElement

For splittable elements returns the current height of the element that needs to be split.

Specified by:

getHeightOfElementToSplit in interface ReportElement

Parameters:

allowedWidth - width of report element

allowedHeight - max height of first segment.

split

public ReportElement[] split(float allowedWidth,
                             float allowedHeight)

Description copied from interface: ReportElement

Will split the report element, so the height of the first segment will the maximum value less or equal to the allowed height value.

Specified by:

split in interface ReportElement

Parameters:

allowedWidth - width of report element

allowedHeight - max height of first segment.

Returns:

two report elements

split

public ReportElement[] split(float allowedWidth)

Description copied from interface: ReportElement

If the element my be split this method should return two elements. The first unsplitable elements, and the rest. The second arrays element may be null

Specified by:

split in interface ReportElement

Parameters:

allowedWidth - allowed with of the segment

Returns:

Arrays with two report elements

setTextAlignInColumn

public void setTextAlignInColumn(int column,
                                 ReportAlignType alignType,
                                 boolean excludeHeader)

setVerticalAlignInColumn

public void setVerticalAlignInColumn(int column,
                                     ReportVerticalAlignType alignType)

getElements

public ReportElement[][] getElements()

getTitle

public ReportElement[] getTitle()

getCellWidths

public float[] getCellWidths()

getPdfStyleSheet

public PdfStyleSheet getPdfStyleSheet()