cc.catalysts.boot.report.pdf.elements

Class ReportElementStatic

java.lang.Object

cc.catalysts.boot.report.pdf.elements.ReportElementStatic

All Implemented Interfaces:

ReportElement

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

Constructor Summary

Constructors

Constructor and Description
ReportElementStatic(ReportElement base, int pageNo, float x, float y, float width, PositionOfStaticElements position)

Method Summary

Modifier and Type	Method and Description
ReportElement	getBase()
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
int	getPageNo()
PositionOfStaticElements	getPosition()
float	getWidth()
float	getX()
float	getY()
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportElementStatic

public ReportElementStatic(ReportElement base,
                           int pageNo,
                           float x,
                           float y,
                           float width,
                           PositionOfStaticElements position)

Parameters:

base - ReportElement to be printed

pageNo - 0-based number of page, where to print element

x - starting X coordinate of print location

y - starting Y coordinate of print location

width - the width of the static element

Method Detail

getBase

public ReportElement getBase()

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 - IGNORED

pageNumber - IGNORED (taken from constructor)

startX - IGNORED (taken from constructor)

startY - IGNORED (taken from constructor)

allowedWidth - IGNORED (taken from constructor)

Returns:

0

Throws:

java.io.IOException - in case something happens in the underlying pdf implementation

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

getX

public float getX()

getY

public float getY()

getWidth

public float getWidth()

getPageNo

public int getPageNo()

getPosition

public PositionOfStaticElements getPosition()