Package com.helger.pdflayout.base

Class AbstractPLBlockElement<IMPLTYPE extends AbstractPLBlockElement<IMPLTYPE>>

java.lang.Object

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

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

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

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

Direct Known Subclasses:

AbstractPLBox

public abstract class AbstractPLBlockElement<IMPLTYPE extends AbstractPLBlockElement<IMPLTYPE>>
extends AbstractPLElement<IMPLTYPE>
implements IPLBlockElement<IMPLTYPE>

Abstract implementation of IPLBlockElement.

Author:

Philip Helger

Field Summary

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

DEFAULT_FULL_WIDTH

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

DEFAULT_HORZ_ALIGNMENT

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

DEFAULT_VERT_ALIGNMENT

Constructor Summary

Constructors

Constructor	Description
AbstractPLBlockElement()

Method Summary

Modifier and Type	Method	Description
EHorzAlignment	getHorzAlign()
EVertAlignment	getVertAlign()
boolean	isFullWidth()
IMPLTYPE	setBasicDataFrom(IMPLTYPE aSource)	For copying stuff internally.
IMPLTYPE	setFullWidth(boolean bFullWidth)	Set usage of full width.
IMPLTYPE	setHorzAlign(EHorzAlignment eHorzAlign)	Set the horizontal alignment of this element.
IMPLTYPE	setVertAlign(EVertAlignment eVertAlign)	Set the vertical alignment of this element.
String	toString()

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

getBorder, getFillColor, getMargin, getMaxSize, getMinSize, getPadding, getRenderSize, setBorder, setFillColor, setMargin, setMaxSize, setMinSize, setPadding

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, getMaxSize, getMaxWidth, getMinHeight, getMinSize, getMinWidth, setExactHeight, setExactSize, setExactWidth, setMaxHeight, setMaxSize, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinSize, setMinWidth

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

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

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

getFillColor, hasFillColor, setFillColor

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

getIndentX

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

addMarginBottom, addMarginLeft, addMarginRight, addMarginTop, addMarginX, addMarginY, getMargin, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMarginXSum, getMarginYSum, setMargin, 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, getPadding, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPaddingXSum, getPaddingYSum, setPadding, setPadding, setPadding, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPaddingX, setPaddingY

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

getIndentY, getIndentY

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

AbstractPLBlockElement

public AbstractPLBlockElement()

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 AbstractPLBlockElement<IMPLTYPE>>

Overrides:

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

Parameters:

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

Returns:

this for chaining

getHorzAlign

@Nonnull
public final EHorzAlignment getHorzAlign()

Specified by:

getHorzAlign in interface IPLHasHorizontalAlignment<IMPLTYPE extends AbstractPLBlockElement<IMPLTYPE>>

Returns:

The horizontal alignment of this element. By default it is EHorzAlignment.DEFAULT. Never null. The horizontal alignment may only be applied to contained children!

setHorzAlign

@Nonnull
public final IMPLTYPE setHorzAlign(@Nonnull
                                   EHorzAlignment eHorzAlign)

Description copied from interface: IPLHasHorizontalAlignment

Set the horizontal alignment of this element. The horizontal alignment may only be applied to contained children!

Specified by:

setHorzAlign in interface IPLHasHorizontalAlignment<IMPLTYPE extends AbstractPLBlockElement<IMPLTYPE>>

Parameters:

eHorzAlign - The new horizontal alignment. May not be null.

Returns:

this

getVertAlign

@Nonnull
public final EVertAlignment getVertAlign()

Specified by:

getVertAlign in interface IPLHasVerticalAlignment<IMPLTYPE extends AbstractPLBlockElement<IMPLTYPE>>

Returns:

The vertical alignment of this element. By default it is EVertAlignment.DEFAULT. Never null. The vertical alignment may only be applied to contained children!

setVertAlign

@Nonnull
public final IMPLTYPE setVertAlign(@Nonnull
                                   EVertAlignment eVertAlign)

Description copied from interface: IPLHasVerticalAlignment

Set the vertical alignment of this element. The vertical alignment may only be applied to contained children!

Specified by:

setVertAlign in interface IPLHasVerticalAlignment<IMPLTYPE extends AbstractPLBlockElement<IMPLTYPE>>

Parameters:

eVertAlign - The new vertical alignment. May not be null.

Returns:

this

isFullWidth

public final boolean isFullWidth()

Specified by:

isFullWidth in interface IPLBlockElement<IMPLTYPE extends AbstractPLBlockElement<IMPLTYPE>>

Returns:

Should the element occupy the full width? The default is IPLBlockElement.DEFAULT_FULL_WIDTH.

setFullWidth

@Nonnull
public final IMPLTYPE setFullWidth(boolean bFullWidth)

Description copied from interface: IPLBlockElement

Set usage of full width.

Specified by:

setFullWidth in interface IPLBlockElement<IMPLTYPE extends AbstractPLBlockElement<IMPLTYPE>>

Parameters:

bFullWidth - true to enable full width, false to use only what is available.

Returns:

this for chaining

toString

public String toString()

Overrides:

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