Package 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>, IPLVisitable

public class PLSpacerY
extends AbstractPLRenderableObject<PLSpacerY>

A vertical spacer

Author:

Philip Helger

Constructor Summary

Constructors

Constructor	Description
PLSpacerY()
PLSpacerY(float fHeight)

Method Summary

Modifier and Type	Method	Description
static PLSpacerY	createPrepared(float fWidth, float fHeight)
float	getHeight()
protected void	onMarkAsNotPrepared()	PL objects need to overwrite this method to reset their preparation state.
protected SizeSpec	onPrepare(PreparationContext aCtx)	The abstract method that must be implemented by all subclasses.
protected void	onRender(PageRenderContext aCtx)	Abstract method to be implemented by subclasses.
PLSpacerY	setBasicDataFrom(PLSpacerY aSource)	For copying stuff internally.
PLSpacerY	setHeight(float fHeight)
String	toString()

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

getPrepareAvailableSize, getPreparedSize, getRenderSize, 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.IPLHasOutline

getOutlineBottom, getOutlineLeft, getOutlineRight, getOutlineTop, getOutlineXSum, getOutlineYSum

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

getAsSplittable, getDebugID, hasID, isVertSplittable

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

beforeRender, getPreparedHeight, getPreparedWidth, getRenderHeight, getRenderWidth

Constructor Detail

PLSpacerY

public PLSpacerY()

PLSpacerY

public PLSpacerY(float fHeight)

Method Detail

setBasicDataFrom

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

Description copied from interface: IPLObject

For copying stuff internally. Must always call super method

Specified by:

setBasicDataFrom in interface IPLObject<PLSpacerY>

Overrides:

setBasicDataFrom in class AbstractPLRenderableObject<PLSpacerY>

Parameters:

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

Returns:

this for chaining

getHeight

public final float getHeight()

setHeight

@Nonnull
public final PLSpacerY setHeight(float fHeight)

onPrepare

protected SizeSpec onPrepare(@Nonnull
                             PreparationContext aCtx)

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.

onMarkAsNotPrepared

protected void onMarkAsNotPrepared()

Description copied from class: AbstractPLRenderableObject

PL objects need to overwrite this method to reset their preparation state. They also need to propagate this to their children!

Specified by:

onMarkAsNotPrepared in class AbstractPLRenderableObject<PLSpacerY>

onRender

protected void onRender(@Nonnull
                        PageRenderContext aCtx)
                 throws IOException

Description copied from class: AbstractPLRenderableObject

Abstract method to be implemented by subclasses.

Specified by:

onRender in class AbstractPLRenderableObject<PLSpacerY>

Parameters:

aCtx - Rendering context. Never null.

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)