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

Direct Known Subclasses:

AbstractPLBlockElement, AbstractPLInlineBox, AbstractPLInlineElement

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

Abstract renderable PL element having a minimum size, a maximum size, margin, border, padding and a fill color.

Author:

Philip Helger

Field Summary

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

DEFAULT_MAX_SIZE, DEFAULT_MIN_SIZE

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

DEFAULT_BORDER

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

DEFAULT_FILL_COLOR

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

DEFAULT_MARGIN

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

DEFAULT_PADDING

Constructor Summary

Constructors

Constructor	Description
AbstractPLElement()

Method Summary

Modifier and Type	Method	Description
BorderSpec	getBorder()
Color	getFillColor()
MarginSpec	getMargin()
SizeSpec	getMaxSize()
SizeSpec	getMinSize()
PaddingSpec	getPadding()
protected SizeSpec	getRenderSize(SizeSpec aPreparedSize)	Overwrite this method to adopt prepared sizes (e.g. for min or max size) to get the render size.
IMPLTYPE	setBasicDataFrom(IMPLTYPE aSource)	For copying stuff internally.
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	setMaxSize(SizeSpec aMaxSize)	Set the maximum size to be used.
IMPLTYPE	setMinSize(SizeSpec aMinSize)	Set the minimum size to be used.
IMPLTYPE	setPadding(PaddingSpec aPadding)	Set the padding values.
String	toString()

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

getPrepareAvailableSize, getPreparedSize, getRenderSize, internalCheckAlreadyPrepared, internalCheckNotPrepared, internalMarkAsNotPrepared, internalMarkAsNotPreparedDontPropagate, internalMarkAsPrepared, isPrepared, onMarkAsNotPrepared, onPrepare, onRender, 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.IPLElement

getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, setExactHeight, setExactSize, setExactWidth, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth

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

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

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

hasFillColor

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

addMarginBottom, addMarginLeft, addMarginRight, addMarginTop, addMarginX, addMarginY, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMarginXSum, getMarginYSum, setMargin, setMargin, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setMarginX, setMarginY

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

getOutlineBottom, getOutlineLeft, getOutlineRight, getOutlineTop, getOutlineXSum, getOutlineYSum

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

addPaddingBottom, addPaddingLeft, addPaddingRight, addPaddingTop, addPaddingX, addPaddingY, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPaddingXSum, getPaddingYSum, setPadding, setPadding, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPaddingX, setPaddingY

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

getAsSplittable, getDebugID, hasID, isVertSplittable

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

beforeRender, getPreparedHeight, getPreparedSize, getPreparedWidth, getRenderHeight, getRenderSize, getRenderWidth, isPrepared, prepare, render

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

visit

Constructor Detail

AbstractPLElement

public AbstractPLElement()

Method Detail

setBasicDataFrom

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

Description copied from interface: IPLObject

For copying stuff internally. Must always call super method

Specified by:

setBasicDataFrom in interface IPLObject<IMPLTYPE extends AbstractPLElement<IMPLTYPE>>

Overrides:

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

Parameters:

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

Returns:

this for chaining

getMinSize

@Nonnull
public final SizeSpec getMinSize()

Specified by:

getMinSize in interface IPLElement<IMPLTYPE extends AbstractPLElement<IMPLTYPE>>

Returns:

The minimum size to be used. Excluding outline. Never null.

setMinSize

@Nonnull
public final IMPLTYPE setMinSize(@Nonnull
                                 SizeSpec aMinSize)

Description copied from interface: IPLElement

Set the minimum size to be used. Excluding outline.

Specified by:

setMinSize in interface IPLElement<IMPLTYPE extends AbstractPLElement<IMPLTYPE>>

Parameters:

aMinSize - Minimum size. May not be null.

Returns:

this

getMaxSize

@Nonnull
public final SizeSpec getMaxSize()

Specified by:

getMaxSize in interface IPLElement<IMPLTYPE extends AbstractPLElement<IMPLTYPE>>

Returns:

The maximum size to be used. Excluding outline. Never null.

setMaxSize

@Nonnull
public final IMPLTYPE setMaxSize(@Nonnull
                                 SizeSpec aMaxSize)

Description copied from interface: IPLElement

Set the maximum size to be used. Excluding outline.

Specified by:

setMaxSize in interface IPLElement<IMPLTYPE extends AbstractPLElement<IMPLTYPE>>

Parameters:

aMaxSize - Maximum size. May not be null. Must both be ≥ 0.

Returns:

this

getMargin

@Nonnull
public final MarginSpec getMargin()

Specified by:

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

Returns:

The current margin. Never null.

setMargin

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

Description copied from interface: IPLHasMargin

Set the margin values.

Specified by:

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

Parameters:

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

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

getPadding

@Nonnull
public final PaddingSpec getPadding()

Specified by:

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

Returns:

The current padding. Never null.

setPadding

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

Description copied from interface: IPLHasPadding

Set the padding values.

Specified by:

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

Parameters:

aPadding - Padding to use. May not be null.

Returns:

this

getFillColor

@Nullable
public final Color getFillColor()

Specified by:

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

Returns:

The current fill color. May be null.

setFillColor

@Nonnull
public final 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

getRenderSize

@Nonnull
@OverridingMethodsMustInvokeSuper
protected SizeSpec getRenderSize(@Nonnull
                                 SizeSpec aPreparedSize)

Description copied from class: AbstractPLRenderableObject

Overwrite this method to adopt prepared sizes (e.g. for min or max size) to get the render size.

Overrides:

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

Parameters:

aPreparedSize - The originally prepared size.

Returns:

The modified prepared size or the unchanged prepared size if no changes are necessary. May not be null.

toString

public String toString()

Overrides:

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