rst.pdfbox.layout.elements

Class ImageElement

java.lang.Object

rst.pdfbox.layout.elements.ImageElement

All Implemented Interfaces:

Dividable, Drawable, Element, WidthRespecting

public class ImageElement
extends Object
implements Element, Drawable, Dividable, WidthRespecting

Nested Class Summary

Nested classes/interfaces inherited from interface rst.pdfbox.layout.elements.Dividable

Dividable.Divided

Field Summary

Fields

Modifier and Type	Field and Description
static float	SCALE_TO_RESPECT_WIDTH Set this to setWidth(float) resp.

Constructor Summary

Constructors

Constructor and Description
ImageElement(BufferedImage image)
ImageElement(InputStream inputStream)
ImageElement(String filePath)

Method Summary

Modifier and Type	Method and Description
Dividable.Divided	divide(float remainingHeight, float nextPageHeight) Divides the drawable vetically into pieces where the first part is to respect the given remaining height.
void	draw(org.apache.pdfbox.pdmodel.PDDocument pdDocument, org.apache.pdfbox.pdmodel.PDPageContentStream contentStream, Position upperLeft, DrawListener drawListener) Draws the object at the given position.
Position	getAbsolutePosition() If an absolute position is given, the drawable will be drawn at this position ignoring any Layout.
float	getHeight()
float	getMaxWidth()
float	getWidth()
Drawable	removeLeadingEmptyVerticalSpace()
void	setAbsolutePosition(Position absolutePosition) Sets the absolute position to render at.
void	setHeight(float height) Sets the height.
void	setMaxWidth(float maxWidth) Sets the max width to respect.
void	setWidth(float width) Sets the width.

Methods inherited from class java.lang.Object

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

Field Detail

SCALE_TO_RESPECT_WIDTH

public static final float SCALE_TO_RESPECT_WIDTH

Set this to setWidth(float) resp. setHeight(float) (usually both) in order to respect the width.

See Also:

Constant Field Values

Constructor Detail

ImageElement

public ImageElement(BufferedImage image)

ImageElement

public ImageElement(InputStream inputStream)
             throws IOException

Throws:

IOException

ImageElement

public ImageElement(String filePath)
             throws IOException

Throws:

IOException

Method Detail

getWidth

public float getWidth()
               throws IOException

Specified by:

getWidth in interface Drawable

Returns:

the width of the drawable.

Throws:

IOException - by pdfbox

setWidth

public void setWidth(float width)

Sets the width. Default is the image width. Set to SCALE_TO_RESPECT_WIDTH in order to let the image respect any given width.

Parameters:

width - the width to use.

getHeight

public float getHeight()
                throws IOException

Specified by:

getHeight in interface Drawable

Returns:

the height of the drawable.

Throws:

IOException - by pdfbox

setHeight

public void setHeight(float height)

Sets the height. Default is the image height. Set to SCALE_TO_RESPECT_WIDTH in order to let the image respect any given width. Usually this makes only sense if you also set the width to SCALE_TO_RESPECT_WIDTH.

Parameters:

height - the height to use.

divide

public Dividable.Divided divide(float remainingHeight,
                                float nextPageHeight)
                         throws IOException

Description copied from interface: Dividable

Divides the drawable vetically into pieces where the first part is to respect the given remaining height. The page height allows to make better decisions on how to divide best.

Specified by:

divide in interface Dividable

Parameters:

remainingHeight - the remaining height on the page dictating the height of the first part.

nextPageHeight - the height of the next page allows to make better decisions on how to divide best, e.g. maybe the element fits completely on the next page.

Returns:

the Divided containing the first part and the tail.

Throws:

IOException - by pdfbox.

getMaxWidth

public float getMaxWidth()

Specified by:

getMaxWidth in interface WidthRespecting

Returns:

the max width to respect.

setMaxWidth

public void setMaxWidth(float maxWidth)

Description copied from interface: WidthRespecting

Sets the max width to respect.

Specified by:

setMaxWidth in interface WidthRespecting

Parameters:

maxWidth - the maximum width.

getAbsolutePosition

public Position getAbsolutePosition()

Description copied from interface: Drawable

If an absolute position is given, the drawable will be drawn at this position ignoring any Layout.

Specified by:

getAbsolutePosition in interface Drawable

Returns:

the absolute position.

setAbsolutePosition

public void setAbsolutePosition(Position absolutePosition)

Sets the absolute position to render at.

Parameters:

absolutePosition - the absolute position.

draw

public void draw(org.apache.pdfbox.pdmodel.PDDocument pdDocument,
                 org.apache.pdfbox.pdmodel.PDPageContentStream contentStream,
                 Position upperLeft,
                 DrawListener drawListener)
          throws IOException

Description copied from interface: Drawable

Draws the object at the given position.

Specified by:

draw in interface Drawable

Parameters:

pdDocument - the underlying pdfbox document.

contentStream - the stream to draw to.

upperLeft - the upper left position to start drawing.

drawListener - the listener to notify on drawn objects.

Throws:

IOException - by pdfbox

removeLeadingEmptyVerticalSpace

public Drawable removeLeadingEmptyVerticalSpace()

Specified by:

removeLeadingEmptyVerticalSpace in interface Drawable

Returns:

a copy of this drawable where any leading empty vertical space is removed, if possible. This is useful for avoiding leading empty space on a new page.