cc.catalysts.boot.report.pdf.elements

Class ReportImage

java.lang.Object

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

cc.catalysts.boot.report.pdf.elements.ReportImage

All Implemented Interfaces:

ReportElement

public class ReportImage
extends AbstractReportElement
implements ReportElement

IMPORTANT: Although this class is publicly visible, it is subject to change and may not be implemented by clients!

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReportImage.ImagePrintIntent This class is required, since pdf image printing has a bug.

Constructor Summary

Constructors

Constructor and Description
ReportImage(java.awt.image.BufferedImage img, float width, float height) The image will be placed as is.

Method Summary

Modifier and Type	Method and Description
ReportAlignType	getAlign()
float	getHeight()
float	getHeight(float allowedWidth) Height of this segment
java.util.Collection<ReportImage.ImagePrintIntent>	getImageIntents() Returns all the images that should have been printed by this element
float	getWidth()
float	print(org.apache.pdfbox.pdmodel.PDDocument document, org.apache.pdfbox.pdmodel.PDPageContentStream stream, int pageNumber, float leftX, float startY, float allowedWidth)
void	printImage(org.apache.pdfbox.pdmodel.PDDocument document, int pageNumber, float x, float y) Call this method to print images.
void	setAlign(ReportAlignType align)
void	setHeight(float height)
void	setWidth(float width)

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

getFirstSegmentHeight, getHeightOfElementToSplit, 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, isSplitable, split, split

Constructor Detail

ReportImage

public ReportImage(java.awt.image.BufferedImage img,
                   float width,
                   float height)

The image will be placed as is. Please provide the greatest size as possible.

Parameters:

img - Buffered image

width - width of image on report

height - height of image on report

Method Detail

print

public float print(org.apache.pdfbox.pdmodel.PDDocument document,
                   org.apache.pdfbox.pdmodel.PDPageContentStream stream,
                   int pageNumber,
                   float leftX,
                   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)

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

printImage

public void printImage(org.apache.pdfbox.pdmodel.PDDocument document,
                       int pageNumber,
                       float x,
                       float y)
                throws java.io.IOException

Call this method to print images. Make sure that the streams are closed before calling this method

Normal print method doesn't work since: http://stackoverflow.com/questions/9326245/how-to-exactly-position-an-image-inside-an-existing-pdf-page-using-pdfbox

Parameters:

document - the pdDocument.

pageNumber - page of image

x - location of image

y - location of image

Throws:

java.io.IOException - in case there are problems at reading or writing the image

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

Overrides:

getImageIntents in class AbstractReportElement

Returns:

collection, can't be null, migth be empty

setAlign

public void setAlign(ReportAlignType align)

getAlign

public ReportAlignType getAlign()

setWidth

public void setWidth(float width)

setHeight

public void setHeight(float height)

getWidth

public float getWidth()

getHeight

public float getHeight()