cc.catalysts.boot.report.pdf.elements

Class ReportTextBox

java.lang.Object

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

All Implemented Interfaces:

ReportElement

Direct Known Subclasses:

ReportRichTextBox

public class ReportTextBox
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!

Field Summary

Fields

Modifier and Type	Field and Description
protected ReportAlignType	align
protected java.util.Map<cc.catalysts.boot.report.pdf.elements.ReportTextBox.CacheKey,java.lang.String[]>	cache
protected float	lineDistance
protected java.lang.String	text
protected PdfTextStyle	textConfig

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ReportTextBox	clone(java.lang.String newString)
ReportAlignType	getAlign()
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
java.lang.String	getText()
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 textX, float textY, float allowedWidth)
void	setAlign(ReportAlignType align)
void	setText(java.lang.String text)
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.
protected java.lang.String[]	split(float allowedWidth, java.lang.String text)

Methods inherited from class java.lang.Object

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

Field Detail

textConfig

protected PdfTextStyle textConfig

text

protected java.lang.String text

lineDistance

protected final float lineDistance

align

protected ReportAlignType align

cache

protected java.util.Map<cc.catalysts.boot.report.pdf.elements.ReportTextBox.CacheKey,java.lang.String[]> cache

Constructor Detail

ReportTextBox

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

ReportTextBox

public ReportTextBox(ReportTextBox 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)

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

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

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

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

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

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

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.

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

split

protected java.lang.String[] split(float allowedWidth,
                                   java.lang.String text)

getAlign

public ReportAlignType getAlign()

setAlign

public void setAlign(ReportAlignType align)

getText

public java.lang.String getText()

setText

public void setText(java.lang.String text)