cc.catalysts.boot.report.pdf.elements

Interface ReportElement

All Known Implementing Classes:

AbstractReportElement, ReportCompositeElement, ReportElementStatic, ReportImage, ReportLink, ReportPadding, ReportPaddingWithHeight, ReportPageBreak, ReportRichTextBox, ReportTable, ReportTextBox

public interface ReportElement

Interface for all report elements.

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

Method Summary

Modifier and Type	Method and Description
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
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)
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.

Method Detail

print

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

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

float getHeight(float allowedWidth)

Height of this segment

Parameters:

allowedWidth - allowed with of the segment

Returns:

height of the segment

isSplitable

boolean isSplitable()

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

Returns:

may the element be split over multiple pages

getFirstSegmentHeight

float getFirstSegmentHeight(float allowedWidth)

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

Parameters:

allowedWidth - the maximum allowed width for this element

Returns:

the height of the first nonSplitable segment

split

ReportElement[] split(float allowedWidth)

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

Parameters:

allowedWidth - allowed with of the segment

Returns:

Arrays with two report elements

split

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.

Parameters:

allowedWidth - width of report element

allowedHeight - max height of first segment.

Returns:

two report elements

getHeightOfElementToSplit

float getHeightOfElementToSplit(float allowedWidth,
                                float allowedHeight)

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

Parameters:

allowedWidth - width of report element

allowedHeight - max height of first segment.

getImageIntents

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

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

Returns:

collection, can't be null, migth be empty