com.helger.pdflayout.base

Interface IPLRenderableObject<IMPLTYPE extends IPLRenderableObject<IMPLTYPE>>

Type Parameters:

IMPLTYPE - Implementation type

All Superinterfaces:

com.helger.commons.traits.IGenericImplTrait<IMPLTYPE>, com.helger.commons.id.IHasID<String>, IPLHasOutline, IPLObject<IMPLTYPE>

All Known Subinterfaces:

IPLElement<IMPLTYPE>

All Known Implementing Classes:

AbstractPLAlignedElement, AbstractPLElement, AbstractPLHBox, AbstractPLHBoxSplittable, AbstractPLRenderableObject, AbstractPLText, AbstractPLVBox, AbstractPLVBoxSplittable, PLHBox, PLHBoxSplittable, PLImage, PLPageBreak, PLSpacerX, PLSpacerY, PLTable, PLText, PLTextSplittable, PLTextWithPlaceholders, PLVBox, PLVBoxSplittable

public interface IPLRenderableObject<IMPLTYPE extends IPLRenderableObject<IMPLTYPE>>
extends IPLObject<IMPLTYPE>, IPLHasOutline

Base interface for a renderable PDF layout object

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static SizeSpec	DEFAULT_MAX_SIZE
static SizeSpec	DEFAULT_MIN_SIZE

Method Summary

Modifier and Type	Method and Description
default void	doPageSetup(PageSetupContext aCtx) Called after the page was created but before the content stream is created.
SizeSpec	getMaxSize()
SizeSpec	getMinSize()
SizeSpec	getPreparedSize()
boolean	isPrepared()
void	perform(RenderingContext aCtx) Second step: perform.
SizeSpec	prepare(PreparationContext aCtx) Prepare this element once for rendering.
default IMPLTYPE	setExactSize(float fWidth, float fHeight) Set the exact size to be used.
IMPLTYPE	setMaxSize(float fMaxWidth, float fMaxHeight) Set the maximum size to be used.
IMPLTYPE	setMinSize(float fMinWidth, float fMinHeight) Set the minimum size to be used.

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.IPLHasOutline

getFullBottom, getFullLeft, getFullRight, getFullTop, getFullXSum, getFullYSum

Field Detail

DEFAULT_MIN_SIZE

static final SizeSpec DEFAULT_MIN_SIZE

DEFAULT_MAX_SIZE

static final SizeSpec DEFAULT_MAX_SIZE

Method Detail

getMinSize

@Nonnull
SizeSpec getMinSize()

Returns:

The minimum size to be used. Excluding padding and margin. Never null.

setMinSize

@Nonnull
IMPLTYPE setMinSize(@Nonnegative
                              float fMinWidth,
                              @Nonnegative
                              float fMinHeight)

Set the minimum size to be used. Excluding padding and margin.

Parameters:

fMinWidth - Minimum width. Must be ≥ 0.

fMinHeight - Minimum height. Must be ≥ 0.

Returns:

this

getMaxSize

@Nonnull
SizeSpec getMaxSize()

Returns:

The maximum size to be used. Excluding padding and margin. Never null.

setMaxSize

@Nonnull
IMPLTYPE setMaxSize(@Nonnegative
                              float fMaxWidth,
                              @Nonnegative
                              float fMaxHeight)

Set the maximum size to be used. Excluding padding and margin.

Parameters:

fMaxWidth - Maximum width. Must be ≥ 0.

fMaxHeight - Maximum height. Must be ≥ 0.

Returns:

this

setExactSize

@Nonnull
default IMPLTYPE setExactSize(@Nonnegative
                                        float fWidth,
                                        @Nonnegative
                                        float fHeight)

Set the exact size to be used. Excluding padding and margin. This is a shortcut for setting minimum and maximum size to the same values.

Parameters:

fWidth - Width to use. Must be ≥ 0.

fHeight - Height to use. Must be ≥ 0.

Returns:

this

isPrepared

boolean isPrepared()

Returns:

true if this object was already prepared, false otherwise.

getPreparedSize

@Nullable
SizeSpec getPreparedSize()

Returns:

The prepared size or null if this object was not yet prepared.

See Also:

isPrepared()

prepare

@Nonnull
SizeSpec prepare(@Nonnull
                           PreparationContext aCtx)
                    throws IOException

Prepare this element once for rendering.

Parameters:

aCtx - The preparation context

Returns:

The net size of the rendered object without margin, border and margin. May not be null.

Throws:

IOException - if already prepared

See Also:

perform(RenderingContext)

doPageSetup

default void doPageSetup(@Nonnull
                         PageSetupContext aCtx)

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.

perform

@Nonnegative
void perform(@Nonnull
                           RenderingContext aCtx)
                    throws IOException

Second step: perform. This renders the previously prepared object to the PDF content stream present in the rendering context.

Parameters:

aCtx - Rendering context

Throws:

IOException - In case of a PDFBox error

See Also:

prepare(PreparationContext)