com.helger.pdflayout.element.special

Class PLSpacerX

java.lang.Object

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

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

com.helger.pdflayout.base.AbstractPLElement<PLSpacerX>

com.helger.pdflayout.element.special.PLSpacerX

All Implemented Interfaces:

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

public class PLSpacerX
extends AbstractPLElement<PLSpacerX>

A horizontal spacer

Author:

Philip Helger

Field Summary

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

DEFAULT_MAX_SIZE, DEFAULT_MIN_SIZE

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

DEFAULT_MARGIN

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

DEFAULT_PADDING

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

DEFAULT_BORDER

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

DEFAULT_FILL_COLOR

Constructor Summary

Constructors

Constructor and Description
PLSpacerX()

Method Summary

Modifier and Type	Method and Description
static PLSpacerX	createPrepared(float fWidth)
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.

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

getBorder, getFillColor, getMargin, getPadding, setBasicDataFrom, setBorder, setFillColor, setMargin, setPadding, 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, getMaxSize, getMinSize, getPreparedSize, isPrepared, perform, prepare, setExactSize, setMaxSize, setMinSize

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

getFullBottom, getFullLeft, getFullRight, getFullTop, getFullXSum, getFullYSum, getMarginAndBorderBottom, getMarginAndBorderLeft, getMarginAndBorderRight, getMarginAndBorderTop, getMarginAndBorderXSum, getMarginAndBorderYSum

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

getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMarginXSum, getMarginYSum, setMargin, setMargin, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop

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

getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPaddingXSum, getPaddingYSum, setPadding, setPadding, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop

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

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

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

hasFillColor

Constructor Detail

PLSpacerX

public PLSpacerX()

Method Detail

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

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

Parameters:

aCtx - Rendering context

Throws:

IOException - In case of a PDFBox error

createPrepared

@Nonnull
public static PLSpacerX createPrepared(float fWidth)