cc.catalysts.boot.report.pdf.elements

Class AbstractReportElement

java.lang.Object

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

All Implemented Interfaces:

ReportElement

Direct Known Subclasses:

ReportImage, ReportLink, ReportPadding

public abstract class AbstractReportElement
extends java.lang.Object
implements ReportElement

Base class all report elements.

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
AbstractReportElement()

Method Summary

Modifier and Type	Method and Description
float	getFirstSegmentHeight(float allowedWidth) in case isSplitable is true, this method will be called.
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
AbstractReportElement[]	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 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

getHeight, print

Constructor Detail

AbstractReportElement

public AbstractReportElement()

Method Detail

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 AbstractReportElement[] 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