com.helger.pdflayout.element.special

Class PLSpacerY

java.lang.Object

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

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

com.helger.pdflayout.element.special.PLSpacerY

All Implemented Interfaces:

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

public class PLSpacerY
extends AbstractPLRenderableObject<PLSpacerY>

A vertical spacer

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
PLSpacerY(float fHeight)

Method Summary

Modifier and Type	Method and Description
static PLSpacerY	createPrepared(float fWidth, float fHeight)
float	getHeight()
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.
PLSpacerY	setBasicDataFrom(PLSpacerY aSource)
PLSpacerY	setHeight(float fHeight)
String	toString()

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

PLSpacerY

public PLSpacerY(float fHeight)

Method Detail

setBasicDataFrom

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

setHeight

@Nonnull
public PLSpacerY setHeight(float fHeight)

getHeight

public float getHeight()

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<PLSpacerY>

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

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<PLSpacerY>

Parameters:

aCtx - Rendering context

Throws:

IOException - In case of a PDFBox error

toString

public String toString()

Overrides:

toString in class AbstractPLRenderableObject<PLSpacerY>

createPrepared

@Nonnull
public static PLSpacerY createPrepared(float fWidth,
                                                 float fHeight)