com.helger.pdflayout.base

Class AbstractPLElement<IMPLTYPE extends AbstractPLElement<IMPLTYPE>>

java.lang.Object

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

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

com.helger.pdflayout.base.AbstractPLElement<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>, IPLElement<IMPLTYPE>, IPLHasBorder<IMPLTYPE>, IPLHasFillColor<IMPLTYPE>, IPLHasMargin<IMPLTYPE>, IPLHasMarginBorderPadding<IMPLTYPE>, IPLHasOutline, IPLHasPadding<IMPLTYPE>, IPLObject<IMPLTYPE>, IPLRenderableObject<IMPLTYPE>

Direct Known Subclasses:

AbstractPLAlignedElement, AbstractPLHBox, AbstractPLVBox, PLSpacerX

public abstract class AbstractPLElement<IMPLTYPE extends AbstractPLElement<IMPLTYPE>>
extends AbstractPLRenderableObject<IMPLTYPE>
implements IPLElement<IMPLTYPE>

Abstract renderable PL element having a padding only

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
AbstractPLElement()

Method Summary

Modifier and Type	Method and Description
BorderSpec	getBorder()
Color	getFillColor()
MarginSpec	getMargin()
PaddingSpec	getPadding()
IMPLTYPE	setBasicDataFrom(AbstractPLElement<?> aSource)
IMPLTYPE	setBorder(BorderSpec aBorder) Set the border values.
IMPLTYPE	setFillColor(Color aFillColor) Set the element fill color.
IMPLTYPE	setMargin(MarginSpec aMargin) Set the margin values.
IMPLTYPE	setPadding(PaddingSpec aPadding) Set the padding values.
String	toString()

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

getMaxSize, getMinSize, getPreparedSize, internalCheckNotPrepared, internalMarkAsNotPrepared, internalMarkAsPrepared, isPrepared, onPerform, onPerformFillAndBorder, onPrepare, 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

AbstractPLElement

public AbstractPLElement()

Method Detail

setBasicDataFrom

@Nonnull
 @OverridingMethodsMustInvokeSuper
public IMPLTYPE setBasicDataFrom(@Nonnull
                                                                               AbstractPLElement<?> aSource)

setMargin

@Nonnull
public final IMPLTYPE setMargin(@Nonnull
                                          MarginSpec aMargin)

Description copied from interface: IPLHasMargin

Set the margin values. This method may not be called after an element got prepared!

Specified by:

setMargin in interface IPLHasMargin<IMPLTYPE extends AbstractPLElement<IMPLTYPE>>

Parameters:

aMargin - Margin to use. May not be null.

Returns:

this

getMargin

@Nonnull
public final MarginSpec getMargin()

Specified by:

getMargin in interface IPLHasMargin<IMPLTYPE extends AbstractPLElement<IMPLTYPE>>

Returns:

The current margin. Never null.

setBorder

@Nonnull
public final IMPLTYPE setBorder(@Nonnull
                                          BorderSpec aBorder)

Description copied from interface: IPLHasBorder

Set the border values. This method may not be called after an element got prepared!

Specified by:

setBorder in interface IPLHasBorder<IMPLTYPE extends AbstractPLElement<IMPLTYPE>>

Parameters:

aBorder - Border to use. May not be null.

Returns:

this

getBorder

@Nonnull
public final BorderSpec getBorder()

Specified by:

getBorder in interface IPLHasBorder<IMPLTYPE extends AbstractPLElement<IMPLTYPE>>

Returns:

The current border. Never null.

setPadding

@Nonnull
public final IMPLTYPE setPadding(@Nonnull
                                           PaddingSpec aPadding)

Description copied from interface: IPLHasPadding

Set the padding values. This method may not be called after an element got prepared!

Specified by:

setPadding in interface IPLHasPadding<IMPLTYPE extends AbstractPLElement<IMPLTYPE>>

Parameters:

aPadding - Padding to use. May not be null.

Returns:

this

getPadding

@Nonnull
public final PaddingSpec getPadding()

Specified by:

getPadding in interface IPLHasPadding<IMPLTYPE extends AbstractPLElement<IMPLTYPE>>

Returns:

The current padding. Never null.

setFillColor

@Nonnull
public IMPLTYPE setFillColor(@Nullable
                                       Color aFillColor)

Description copied from interface: IPLHasFillColor

Set the element fill color.

Specified by:

setFillColor in interface IPLHasFillColor<IMPLTYPE extends AbstractPLElement<IMPLTYPE>>

Parameters:

aFillColor - The fill color to use. May be null.

Returns:

this

getFillColor

@Nullable
public Color getFillColor()

Specified by:

getFillColor in interface IPLHasFillColor<IMPLTYPE extends AbstractPLElement<IMPLTYPE>>

Returns:

The current fill color. May be null.

toString

public String toString()

Overrides:

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