cc.catalysts.boot.report.pdf.elements

Class ReportRichTextBox

java.lang.Object

cc.catalysts.boot.report.pdf.elements.ReportTextBox

cc.catalysts.boot.report.pdf.elements.ReportRichTextBox

All Implemented Interfaces:

ReportElement

public class ReportRichTextBox
extends ReportTextBox

Created by cboehmwalder on 04.08.2016.

Field Summary

Fields inherited from class cc.catalysts.boot.report.pdf.elements.ReportTextBox

align, cache, lineDistance, text, textConfig

Constructor Summary

Constructors

Constructor and Description
ReportRichTextBox(PdfTextStyle textConfig, float lineDistance, java.lang.String text)
ReportRichTextBox(PdfTextStyle textConfig, float lineDistance, java.lang.String text, java.lang.String boldFontStyle, java.lang.String italicFontStyle)
ReportRichTextBox(ReportRichTextBox object, java.lang.String text) copy constructor with new text

Method Summary

Modifier and Type	Method and Description
ReportTextBox	clone(java.lang.String newString)
float	print(org.apache.pdfbox.pdmodel.PDDocument document, org.apache.pdfbox.pdmodel.PDPageContentStream stream, int pageNumber, float textX, float textY, 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.

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

getAlign, getFirstSegmentHeight, getHeight, getHeightOfElementToSplit, getImageIntents, getText, isSplitable, setAlign, setText, split

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportRichTextBox

public ReportRichTextBox(PdfTextStyle textConfig,
                         float lineDistance,
                         java.lang.String text,
                         java.lang.String boldFontStyle,
                         java.lang.String italicFontStyle)

ReportRichTextBox

public ReportRichTextBox(PdfTextStyle textConfig,
                         float lineDistance,
                         java.lang.String text)

ReportRichTextBox

public ReportRichTextBox(ReportRichTextBox object,
                         java.lang.String text)

copy constructor with new text

Parameters:

object - reportTextBox object for configurations

text - text of text box

Method Detail

clone

public ReportTextBox clone(java.lang.String newString)

Overrides:

clone in class ReportTextBox

print

public float print(org.apache.pdfbox.pdmodel.PDDocument document,
                   org.apache.pdfbox.pdmodel.PDPageContentStream stream,
                   int pageNumber,
                   float textX,
                   float textY,
                   float allowedWidth)

Specified by:

print in interface ReportElement

Overrides:

print in class ReportTextBox

Parameters:

document - PdfBox document

stream - PdfBox stream

pageNumber - current page number (0 based)

textX - starting x

textY - starting y

allowedWidth - maximal width of segment

Returns:

the Y position of the next line

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

Overrides:

split in class ReportTextBox

Parameters:

allowedWidth - allowed with of the segment

Returns:

Arrays with two report elements

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

Overrides:

split in class ReportTextBox

Parameters:

allowedWidth - width of report element

allowedHeight - max height of first segment.

Returns:

two report elements