cc.catalysts.boot.report.pdf.elements

Class ReportPadding

java.lang.Object

cc.catalysts.boot.report.pdf.elements.AbstractReportElement

cc.catalysts.boot.report.pdf.elements.ReportPadding

All Implemented Interfaces:

ReportElement

Direct Known Subclasses:

ReportPaddingWithHeight, ReportPageBreak

public class ReportPadding
extends AbstractReportElement
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
ReportPadding(float padding)

Method Summary

Modifier and Type	Method and Description
float	getHeight(float allowedWidth) Height of this segment
float	getPadding()
float	print(org.apache.pdfbox.pdmodel.PDDocument document, org.apache.pdfbox.pdmodel.PDPageContentStream stream, int pageNumber, float startX, float startY, float allowedWidth)

Methods inherited from class cc.catalysts.boot.report.pdf.elements.AbstractReportElement

getFirstSegmentHeight, getHeightOfElementToSplit, getImageIntents, isSplitable, split, split

Methods inherited from class java.lang.Object

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

Methods inherited from interface cc.catalysts.boot.report.pdf.elements.ReportElement

getFirstSegmentHeight, getHeightOfElementToSplit, getImageIntents, isSplitable, split, split

Constructor Detail

ReportPadding

public ReportPadding(float padding)

Method Detail

getPadding

public float getPadding()

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