com.helger.pdflayout.element.hbox

Class AbstractPLHBox<IMPLTYPE extends AbstractPLHBox<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.element.hbox.AbstractPLHBox<IMPLTYPE>

Type Parameters:

IMPLTYPE - Implementation type

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:

AbstractPLHBoxSplittable, PLHBox

public abstract class AbstractPLHBox<IMPLTYPE extends AbstractPLHBox<IMPLTYPE>>
extends AbstractPLElement<IMPLTYPE>

Horizontal box - groups several columns.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
protected com.helger.commons.collection.ext.ICommonsList<PLHBoxColumn>	m_aColumns
protected float[]	m_aPreparedColumnHeight prepare height (without padding and margin)
protected float[]	m_aPreparedColumnWidth prepare width (without padding and margin)

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

Method Summary

Modifier and Type	Method and Description
PLHBoxColumn	addAndReturnColumn(int nIndex, IPLRenderableObject<?> aElement, WidthSpec aWidth)
PLHBoxColumn	addAndReturnColumn(IPLRenderableObject<?> aElement, WidthSpec aWidth)
IMPLTYPE	addColumn(int nIndex, IPLRenderableObject<?> aElement, WidthSpec aWidth)
IMPLTYPE	addColumn(IPLRenderableObject<?> aElement, WidthSpec aWidth)
void	doPageSetup(PageSetupContext aCtx) Called after the page was created but before the content stream is created.
com.helger.commons.collection.ext.ICommonsList<PLHBoxColumn>	getAllColumns()
PLHBoxColumn	getColumnAtIndex(int nIndex)
BorderSpec	getColumnBorder() Get the border around each contained column.
int	getColumnCount()
IPLRenderableObject<?>	getColumnElementAtIndex(int nIndex)
Color	getColumnFillColor() Get the fill color to be used to fill the whole column.
PLHBoxColumn	getFirstColumn()
IPLRenderableObject<?>	getFirstColumnElement()
PLHBoxColumn	getLastColumn()
IPLRenderableObject<?>	getLastColumnElement()
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.
IMPLTYPE	removeColumn(int nIndex)
IMPLTYPE	setBasicDataFrom(AbstractPLHBox<?> aSource)
IMPLTYPE	setColumnBorder(BorderSpec aBorder) Set the border around each contained column.
IMPLTYPE	setColumnBorder(BorderStyleSpec aBorder) Set the border around each contained column.
IMPLTYPE	setColumnBorder(BorderStyleSpec aBorderY, BorderStyleSpec aBorderX) Set the border around each contained column.
IMPLTYPE	setColumnBorder(BorderStyleSpec aBorderTop, BorderStyleSpec aBorderRight, BorderStyleSpec aBorderBottom, BorderStyleSpec aBorderLeft) Set the border around each contained column.
IMPLTYPE	setColumnBorderBottom(BorderStyleSpec aBorder) Set the bottom border value around each contained column.
IMPLTYPE	setColumnBorderLeft(BorderStyleSpec aBorder) Set the left border value around each contained column.
IMPLTYPE	setColumnBorderRight(BorderStyleSpec aBorder) Set the right border value around each contained column.
IMPLTYPE	setColumnBorderTop(BorderStyleSpec aBorder) Set the top border value around each contained column.
IMPLTYPE	setColumnFillColor(Color aColumnFillColor) Set the fill color to be used to fill the whole column.
String	toString()

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

getBorder, getFillColor, getMargin, getPadding, setBasicDataFrom, setBorder, setFillColor, setMargin, setPadding

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

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

Field Detail

m_aColumns

protected final com.helger.commons.collection.ext.ICommonsList<PLHBoxColumn> m_aColumns

m_aPreparedColumnWidth

protected float[] m_aPreparedColumnWidth

prepare width (without padding and margin)

m_aPreparedColumnHeight

protected float[] m_aPreparedColumnHeight

prepare height (without padding and margin)

Constructor Detail

AbstractPLHBox

public AbstractPLHBox()

Method Detail

setBasicDataFrom

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

getColumnCount

@Nonnegative
public int getColumnCount()

Returns:

The number of columns. Always ≥ 0.

getAllColumns

@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.collection.ext.ICommonsList<PLHBoxColumn> getAllColumns()

Returns:

All columns. Never null.

getColumnAtIndex

@Nullable
public PLHBoxColumn getColumnAtIndex(@Nonnegative
                                                int nIndex)

getFirstColumn

@Nullable
public PLHBoxColumn getFirstColumn()

getLastColumn

@Nullable
public PLHBoxColumn getLastColumn()

getColumnElementAtIndex

@Nullable
public IPLRenderableObject<?> getColumnElementAtIndex(@Nonnegative
                                                                 int nIndex)

getFirstColumnElement

@Nullable
public IPLRenderableObject<?> getFirstColumnElement()

getLastColumnElement

@Nullable
public IPLRenderableObject<?> getLastColumnElement()

addAndReturnColumn

@Nonnull
public PLHBoxColumn addAndReturnColumn(@Nonnull
                                                 IPLRenderableObject<?> aElement,
                                                 @Nonnull
                                                 WidthSpec aWidth)

addColumn

@Nonnull
public IMPLTYPE addColumn(@Nonnull
                                    IPLRenderableObject<?> aElement,
                                    @Nonnull
                                    WidthSpec aWidth)

addAndReturnColumn

@Nonnull
public PLHBoxColumn addAndReturnColumn(@Nonnegative
                                                 int nIndex,
                                                 @Nonnull
                                                 IPLRenderableObject<?> aElement,
                                                 @Nonnull
                                                 WidthSpec aWidth)

addColumn

@Nonnull
public IMPLTYPE addColumn(@Nonnegative
                                    int nIndex,
                                    @Nonnull
                                    IPLRenderableObject<?> aElement,
                                    @Nonnull
                                    WidthSpec aWidth)

removeColumn

@Nonnull
public IMPLTYPE removeColumn(@Nonnegative
                                       int nIndex)

setColumnBorder

@Nonnull
public final IMPLTYPE setColumnBorder(@Nullable
                                                BorderStyleSpec aBorder)

Set the border around each contained column.

Parameters:

aBorder - The border style to use. May be null.

Returns:

this

setColumnBorder

@Nonnull
public final IMPLTYPE setColumnBorder(@Nullable
                                                BorderStyleSpec aBorderY,
                                                @Nullable
                                                BorderStyleSpec aBorderX)

Set the border around each contained column.

Parameters:

aBorderY - The border to set for top and bottom. Maybe null.

aBorderX - The border to set for left and right. Maybe null.

Returns:

this

setColumnBorder

@Nonnull
public final IMPLTYPE setColumnBorder(@Nullable
                                                BorderStyleSpec aBorderTop,
                                                @Nullable
                                                BorderStyleSpec aBorderRight,
                                                @Nullable
                                                BorderStyleSpec aBorderBottom,
                                                @Nullable
                                                BorderStyleSpec aBorderLeft)

Set the border around each contained column.

Parameters:

aBorderTop - The border to set for top. Maybe null.

aBorderRight - The border to set for right. Maybe null.

aBorderBottom - The border to set for bottom. Maybe null.

aBorderLeft - The border to set for left. Maybe null.

Returns:

this

setColumnBorder

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

Set the border around each contained column.

Parameters:

aBorder - The border to set. May not be null.

Returns:

this

setColumnBorderTop

@Nonnull
public final IMPLTYPE setColumnBorderTop(@Nullable
                                                   BorderStyleSpec aBorder)

Set the top border value around each contained column. This method may not be called after an element got prepared!

Parameters:

aBorder - The value to use. May be null.

Returns:

this

setColumnBorderRight

@Nonnull
public final IMPLTYPE setColumnBorderRight(@Nullable
                                                     BorderStyleSpec aBorder)

Set the right border value around each contained column. This method may not be called after an element got prepared!

Parameters:

aBorder - The value to use. May be null.

Returns:

this

setColumnBorderBottom

@Nonnull
public final IMPLTYPE setColumnBorderBottom(@Nullable
                                                      BorderStyleSpec aBorder)

Set the bottom border value around each contained column. This method may not be called after an element got prepared!

Parameters:

aBorder - The value to use. May be null.

Returns:

this

setColumnBorderLeft

@Nonnull
public final IMPLTYPE setColumnBorderLeft(@Nullable
                                                    BorderStyleSpec aBorder)

Set the left border value around each contained column. This method may not be called after an element got prepared!

Parameters:

aBorder - The value to use. May be null.

Returns:

this

getColumnBorder

@Nonnull
public final BorderSpec getColumnBorder()

Get the border around each contained column. By default BorderSpec.BORDER0 which means no border is used.

Returns:

Never null.

setColumnFillColor

@Nonnull
public IMPLTYPE setColumnFillColor(@Nullable
                                             Color aColumnFillColor)

Set the fill color to be used to fill the whole column. null means no fill color.

Parameters:

aColumnFillColor - The fill color to use. May be null to indicate no fill color (which is also the default).

Returns:

this

getColumnFillColor

@Nullable
public Color getColumnFillColor()

Get the fill color to be used to fill the whole column. null means no fill color.

Returns:

May be null.

onPrepare

@OverridingMethodsMustInvokeSuper
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<IMPLTYPE extends AbstractPLHBox<IMPLTYPE>>

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

doPageSetup

public void doPageSetup(@Nonnull
                        PageSetupContext aCtx)

Description copied from interface: IPLRenderableObject

Called after the page was created but before the content stream is created. This is e.g. used for images to create their XObjects upfront.

Parameters:

aCtx - The current page setup context. Never null.

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<IMPLTYPE extends AbstractPLHBox<IMPLTYPE>>

Parameters:

aCtx - Rendering context

Throws:

IOException - In case of a PDFBox error

toString

public String toString()

Overrides:

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