com.helger.pdflayout.base

Class AbstractPLRenderableObject<IMPLTYPE extends AbstractPLRenderableObject<IMPLTYPE>>

java.lang.Object

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

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

Type Parameters:

IMPLTYPE - The implementation type of this class.

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractPLElement, PLPageBreak, PLSpacerY

public abstract class AbstractPLRenderableObject<IMPLTYPE extends AbstractPLRenderableObject<IMPLTYPE>>
extends AbstractPLObject<IMPLTYPE>
implements IPLRenderableObject<IMPLTYPE>

Abstract layout object that supports rendering.

Author:

Philip Helger

Field Summary

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

DEFAULT_MAX_SIZE, DEFAULT_MIN_SIZE

Constructor Summary

Constructors

Constructor and Description
AbstractPLRenderableObject()

Method Summary

Modifier and Type	Method and Description
SizeSpec	getMaxSize()
SizeSpec	getMinSize()
SizeSpec	getPreparedSize()
protected void	internalCheckNotPrepared() Throw an exception, if this object is already prepared.
void	internalMarkAsNotPrepared()
IMPLTYPE	internalMarkAsPrepared(SizeSpec aPreparedSize)
boolean	isPrepared()
protected abstract void	onPerform(RenderingContext aCtx) Abstract method to be implemented by subclasses.
protected void	onPerformFillAndBorder(RenderingContext aCtx) method to be implemented by subclasses.
protected abstract SizeSpec	onPrepare(PreparationContext aCtx) The abstract method that must be implemented by all subclasses.
void	perform(RenderingContext aCtx) Second step: perform.
SizeSpec	prepare(PreparationContext aCtx) Prepare this element once for rendering.
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.
String	toString()

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

doPageSetup, setExactSize

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

Constructor Detail

AbstractPLRenderableObject

public AbstractPLRenderableObject()

Method Detail

getMinSize

@Nonnull
public SizeSpec getMinSize()

Specified by:

getMinSize in interface IPLRenderableObject<IMPLTYPE extends AbstractPLRenderableObject<IMPLTYPE>>

Returns:

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

setMinSize

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

Description copied from interface: IPLRenderableObject

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

Specified by:

setMinSize in interface IPLRenderableObject<IMPLTYPE extends AbstractPLRenderableObject<IMPLTYPE>>

Parameters:

fMinWidth - Minimum width. Must be ≥ 0.

fMinHeight - Minimum height. Must be ≥ 0.

Returns:

this

getMaxSize

@Nonnull
public SizeSpec getMaxSize()

Specified by:

getMaxSize in interface IPLRenderableObject<IMPLTYPE extends AbstractPLRenderableObject<IMPLTYPE>>

Returns:

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

setMaxSize

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

Description copied from interface: IPLRenderableObject

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

Specified by:

setMaxSize in interface IPLRenderableObject<IMPLTYPE extends AbstractPLRenderableObject<IMPLTYPE>>

Parameters:

fMaxWidth - Maximum width. Must be ≥ 0.

fMaxHeight - Maximum height. Must be ≥ 0.

Returns:

this

internalCheckNotPrepared

@OverrideOnDemand
 @OverridingMethodsMustInvokeSuper
protected void internalCheckNotPrepared()

Throw an exception, if this object is already prepared.

Throws:

IllegalStateException - if already prepared

isPrepared

public final boolean isPrepared()

Specified by:

isPrepared in interface IPLRenderableObject<IMPLTYPE extends AbstractPLRenderableObject<IMPLTYPE>>

Returns:

true if this object was already prepared, false otherwise.

getPreparedSize

@Nullable
public final SizeSpec getPreparedSize()

Specified by:

getPreparedSize in interface IPLRenderableObject<IMPLTYPE extends AbstractPLRenderableObject<IMPLTYPE>>

Returns:

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

See Also:

IPLRenderableObject.isPrepared()

onPrepare

@Nonnull
protected abstract SizeSpec onPrepare(@Nonnull
                                                PreparationContext aCtx)
                                         throws IOException

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

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

prepare

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

Description copied from interface: IPLRenderableObject

Prepare this element once for rendering.

Specified by:

prepare in interface IPLRenderableObject<IMPLTYPE extends AbstractPLRenderableObject<IMPLTYPE>>

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:

IPLRenderableObject.perform(RenderingContext)

internalMarkAsNotPrepared

public final void internalMarkAsNotPrepared()

internalMarkAsPrepared

@Nonnull
public final IMPLTYPE internalMarkAsPrepared(@Nonnull
                                                       SizeSpec aPreparedSize)

Parameters:

aPreparedSize - The new prepared size without padding or margin.

Returns:

this

onPerformFillAndBorder

@OverrideOnDemand
protected void onPerformFillAndBorder(@Nonnull
                                                         RenderingContext aCtx)
                                                  throws IOException

method to be implemented by subclasses. Should fill the surrounding and create the border.

Parameters:

aCtx - Rendering context

Throws:

IOException - In case of a PDFBox error

onPerform

@OverrideOnDemand
protected abstract void onPerform(@Nonnull
                                                     RenderingContext aCtx)
                                              throws IOException

Abstract method to be implemented by subclasses.

Parameters:

aCtx - Rendering context

Throws:

IOException - In case of a PDFBox error

perform

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

Description copied from interface: IPLRenderableObject

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

Specified by:

perform in interface IPLRenderableObject<IMPLTYPE extends AbstractPLRenderableObject<IMPLTYPE>>

Parameters:

aCtx - Rendering context

Throws:

IOException - In case of a PDFBox error

See Also:

IPLRenderableObject.prepare(PreparationContext)

toString

public String toString()

Overrides:

toString in class AbstractPLObject<IMPLTYPE extends AbstractPLRenderableObject<IMPLTYPE>>