Package com.helger.pdflayout.element.image

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.AbstractPLInlineElement<IMPLTYPE>

com.helger.pdflayout.element.image.AbstractPLImage<PLImage>

com.helger.pdflayout.element.image.PLImage

All Implemented Interfaces:

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

public class PLImage
extends AbstractPLImage<PLImage>

Represent a static image based on BufferedImage. This image type is supported for all EPLImageTypes!

Author:

Philip Helger

See Also:

PLStreamImage

Field Summary

Fields inherited from class com.helger.pdflayout.element.image.AbstractPLImage

DEFAULT_IMAGE_TYPE

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

DEFAULT_MAX_SIZE, DEFAULT_MIN_SIZE

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

DEFAULT_BORDER

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

DEFAULT_FILL_COLOR

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

DEFAULT_MARGIN

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

DEFAULT_PADDING

Constructor Summary

Constructors

Constructor	Description
PLImage(BufferedImage aImage)
PLImage(BufferedImage aImage, float fImageWidth, float fImageHeight)

Method Summary

Modifier and Type	Method	Description
BufferedImage	getImage()
protected org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject	getXObject(PagePreRenderContext aCtx)	Resolve the PDImageXObject for rendering.
PLImage	setBasicDataFrom(PLImage aSource)	For copying stuff internally.
String	toString()

Methods inherited from class com.helger.pdflayout.element.image.AbstractPLImage

beforeRender, getImageHeight, getImageType, getImageWidth, onMarkAsNotPrepared, onPrepare, onRender, setImageType

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

getBorder, getFillColor, getMargin, getMaxSize, getMinSize, getPadding, getRenderSize, setBorder, setFillColor, setMargin, setMaxSize, setMinSize, setPadding

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

getPrepareAvailableSize, getPreparedSize, getRenderSize, internalCheckAlreadyPrepared, internalCheckNotPrepared, internalMarkAsNotPrepared, internalMarkAsNotPreparedDontPropagate, internalMarkAsPrepared, isPrepared, onRenderSizeChange, prepare, render, visit

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

getDebugID, getID, onAfterSetID, setID

Methods inherited from class java.lang.Object

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

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

thisAsT

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

getID

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

getMaxHeight, getMaxSize, getMaxWidth, getMinHeight, getMinSize, getMinWidth, setExactHeight, setExactSize, setExactWidth, setMaxHeight, setMaxSize, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinSize, setMinWidth

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

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

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

getFillColor, hasFillColor, setFillColor

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

addMarginBottom, addMarginLeft, addMarginRight, addMarginTop, addMarginX, addMarginY, getMargin, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMarginXSum, getMarginYSum, setMargin, setMargin, setMargin, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setMarginX, setMarginY

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

getOutlineBottom, getOutlineLeft, getOutlineRight, getOutlineTop, getOutlineXSum, getOutlineYSum

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

addPaddingBottom, addPaddingLeft, addPaddingRight, addPaddingTop, addPaddingX, addPaddingY, getPadding, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPaddingXSum, getPaddingYSum, setPadding, setPadding, setPadding, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPaddingX, setPaddingY

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

getAsSplittable, getDebugID, hasID, isVertSplittable

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

getPreparedHeight, getPreparedSize, getPreparedWidth, getRenderHeight, getRenderSize, getRenderWidth, isPrepared, prepare, render

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

visit

Constructor Detail

PLImage

public PLImage(@Nonnull
               BufferedImage aImage)

PLImage

public PLImage(@Nonnull
               BufferedImage aImage,
               @Nonnegative
               float fImageWidth,
               @Nonnegative
               float fImageHeight)

Method Detail

setBasicDataFrom

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

Description copied from interface: IPLObject

For copying stuff internally. Must always call super method

Specified by:

setBasicDataFrom in interface IPLObject<PLImage>

Overrides:

setBasicDataFrom in class AbstractPLImage<PLImage>

Parameters:

aSource - Source object to copy from. May not be null.

Returns:

this for chaining

getImage

@Nullable
public BufferedImage getImage()

getXObject

@Nonnull
protected org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject getXObject(@Nonnull
                                                                             PagePreRenderContext aCtx)
                                                                      throws IOException

Description copied from class: AbstractPLImage

Resolve the PDImageXObject for rendering. Must consider the image type according to AbstractPLImage.getImageType().

Specified by:

getXObject in class AbstractPLImage<PLImage>

Parameters:

aCtx - Render context

Returns:

Never null.

Throws:

IOException - In case of error.

toString

public String toString()

Overrides:

toString in class AbstractPLImage<PLImage>