com.helger.pdflayout.element

Class PLImage

java.lang.Object

com.helger.pdflayout.base.AbstractPLObject<IMPLTYPE>

com.helger.pdflayout.base.AbstractPLRenderableObject<IMPLTYPE>

com.helger.pdflayout.base.AbstractPLElement<IMPLTYPE>

com.helger.pdflayout.base.AbstractPLAlignedElement<PLImage>

com.helger.pdflayout.element.PLImage

All Implemented Interfaces:

com.helger.commons.id.IHasID<String>, com.helger.commons.traits.IGenericImplTrait<PLImage>, IPLElement<PLImage>, IPLHasBorder<PLImage>, IPLHasFillColor<PLImage>, IPLHasHorizontalAlignment<PLImage>, IPLHasMargin<PLImage>, IPLHasMarginBorderPadding<PLImage>, IPLHasOutline, IPLHasPadding<PLImage>, IPLHasVerticalAlignment<PLImage>, IPLObject<PLImage>, IPLRenderableObject<PLImage>

public class PLImage
extends AbstractPLAlignedElement<PLImage>

Render an image

Author:

Philip Helger

Field Summary

Fields inherited from interface com.helger.pdflayout.base.IPLHasHorizontalAlignment

DEFAULT_HORZ_ALIGNMENT

Fields inherited from interface com.helger.pdflayout.base.IPLHasVerticalAlignment

DEFAULT_VERT_ALIGNMENT

Fields inherited from interface com.helger.pdflayout.base.IPLRenderableObject

DEFAULT_MAX_SIZE, DEFAULT_MIN_SIZE

Fields inherited from interface com.helger.pdflayout.base.IPLHasMargin

DEFAULT_MARGIN

Fields inherited from interface com.helger.pdflayout.base.IPLHasPadding

DEFAULT_PADDING

Fields inherited from interface com.helger.pdflayout.base.IPLHasBorder

DEFAULT_BORDER

Fields inherited from interface com.helger.pdflayout.base.IPLHasFillColor

DEFAULT_FILL_COLOR

Constructor Summary

Constructors

Constructor and Description
PLImage(BufferedImage aImage)
PLImage(BufferedImage aImage, float fWidth, float fHeight)
PLImage(com.helger.commons.io.IHasInputStream aImage, float fWidth, float fHeight)

Method Summary

Modifier and Type	Method and Description
void	doPageSetup(PageSetupContext aCtx) Called after the page was created but before the content stream is created.
float	getHeight()
com.helger.commons.io.IHasInputStream	getIIS()
BufferedImage	getImage()
float	getWidth()
protected void	onPerform(RenderingContext aCtx) Abstract method to be implemented by subclasses.
protected SizeSpec	onPrepare(PreparationContext aCtx) The abstract method that must be implemented by all subclasses.
PLImage	setBasicDataFrom(PLImage aSource)
String	toString()

Methods inherited from class com.helger.pdflayout.base.AbstractPLAlignedElement

getHorzAlign, getVertAlign, setBasicDataFrom, setHorzAlign, setVertAlign

Methods inherited from class com.helger.pdflayout.base.AbstractPLElement

getBorder, getFillColor, getMargin, getPadding, setBasicDataFrom, setBorder, setFillColor, setMargin, setPadding

Methods inherited from class com.helger.pdflayout.base.AbstractPLRenderableObject

getMaxSize, getMinSize, getPreparedSize, internalCheckNotPrepared, internalMarkAsNotPrepared, internalMarkAsPrepared, isPrepared, onPerformFillAndBorder, perform, prepare, setMaxSize, setMinSize

Methods inherited from class com.helger.pdflayout.base.AbstractPLObject

getDebugID, getID, setBasicDataFrom, setID

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.pdflayout.base.IPLObject

getAsSplittable, getDebugID, isSplittable

Methods inherited from interface com.helger.commons.id.IHasID

getComparatorID, getID

Methods inherited from interface com.helger.commons.traits.IGenericImplTrait

thisAsT

Methods inherited from interface com.helger.pdflayout.base.IPLRenderableObject

getMaxSize, getMinSize, getPreparedSize, isPrepared, perform, prepare, setExactSize, setMaxSize, setMinSize

Methods inherited from interface com.helger.pdflayout.base.IPLHasMarginBorderPadding

getFullBottom, getFullLeft, getFullRight, getFullTop, getFullXSum, getFullYSum, getMarginAndBorderBottom, getMarginAndBorderLeft, getMarginAndBorderRight, getMarginAndBorderTop, getMarginAndBorderXSum, getMarginAndBorderYSum

Methods inherited from interface com.helger.pdflayout.base.IPLHasMargin

getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMarginXSum, getMarginYSum, setMargin, setMargin, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop

Methods inherited from interface com.helger.pdflayout.base.IPLHasPadding

getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPaddingXSum, getPaddingYSum, setPadding, setPadding, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop

Methods inherited from interface com.helger.pdflayout.base.IPLHasBorder

getBorderBottomWidth, getBorderLeftWidth, getBorderRightWidth, getBorderTopWidth, getBorderXSumWidth, getBorderYSumWidth, setBorder, setBorder, setBorder, setBorderBottom, setBorderLeft, setBorderRight, setBorderTop

Methods inherited from interface com.helger.pdflayout.base.IPLHasFillColor

hasFillColor

Constructor Detail

PLImage

public PLImage(@Nonnull
               BufferedImage aImage)

PLImage

public PLImage(@Nonnull
               BufferedImage aImage,
               @Nonnegative
               float fWidth,
               @Nonnegative
               float fHeight)

PLImage

public PLImage(@Nonnull
               com.helger.commons.io.IHasInputStream aImage,
               @Nonnegative
               float fWidth,
               @Nonnegative
               float fHeight)

Method Detail

getImage

@Nullable
public BufferedImage getImage()

getIIS

@Nullable
public com.helger.commons.io.IHasInputStream getIIS()

getWidth

public float getWidth()

getHeight

public float getHeight()

setBasicDataFrom

@Nonnull
 @OverridingMethodsMustInvokeSuper
public PLImage setBasicDataFrom(@Nonnull
                                                                              PLImage aSource)

onPrepare

protected SizeSpec onPrepare(@Nonnull
                             PreparationContext aCtx)
                      throws IOException

Description copied from class: AbstractPLRenderableObject

The abstract method that must be implemented by all subclasses. It is ensured that this method is called only once per instance!

Specified by:

onPrepare in class AbstractPLRenderableObject<PLImage>

Parameters:

aCtx - Preparation context. Never null.

Returns:

The size of the rendered element without padding, border and margin. May not be null.

Throws:

IOException - on error

doPageSetup

public void doPageSetup(@Nonnull
                        PageSetupContext aCtx)

Description copied from interface: IPLRenderableObject

Called after the page was created but before the content stream is created. This is e.g. used for images to create their XObjects upfront.

Parameters:

aCtx - The current page setup context. Never null.

onPerform

protected void onPerform(@Nonnull
                         RenderingContext aCtx)
                  throws IOException

Description copied from class: AbstractPLRenderableObject

Abstract method to be implemented by subclasses.

Specified by:

onPerform in class AbstractPLRenderableObject<PLImage>

Parameters:

aCtx - Rendering context

Throws:

IOException - In case of a PDFBox error

toString

public String toString()

Overrides:

toString in class AbstractPLAlignedElement<PLImage>