com.helger.pdflayout.element.vbox

Class AbstractPLVBox<IMPLTYPE extends AbstractPLVBox<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.vbox.AbstractPLVBox<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>, IPLHasRowBorder<IMPLTYPE>

Direct Known Subclasses:

AbstractPLVBoxSplittable, PLTable, PLVBox

public abstract class AbstractPLVBox<IMPLTYPE extends AbstractPLVBox<IMPLTYPE>>
extends AbstractPLElement<IMPLTYPE>
implements IPLHasRowBorder<IMPLTYPE>

Vertical box - groups several rows.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
protected float[]	m_aPreparedRowElementHeight prepare height (without padding and margin)
protected float[]	m_aPreparedRowElementWidth prepare width (without padding and margin)
protected com.helger.commons.collection.ext.ICommonsList<PLVBoxRow>	m_aRows

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

Method Summary

Modifier and Type	Method and Description
PLVBoxRow	addAndReturnRow(int nIndex, IPLRenderableObject<?> aElement) Add a row to this VBox.
PLVBoxRow	addAndReturnRow(IPLRenderableObject<?> aElement) Add a row to this VBox.
IMPLTYPE	addRow(int nIndex, IPLRenderableObject<?> aElement) Add a row to this VBox.
IMPLTYPE	addRow(IPLRenderableObject<?> aElement) Add a row to this VBox.
void	doPageSetup(PageSetupContext aCtx) Called after the page was created but before the content stream is created.
com.helger.commons.collection.ext.ICommonsList<PLVBoxRow>	getAllRows()
PLVBoxRow	getFirstRow()
IPLRenderableObject<?>	getFirstRowElement()
PLVBoxRow	getLastRow()
IPLRenderableObject<?>	getLastRowElement()
PLVBoxRow	getRowAtIndex(int nIndex) Get the row at the specified index.
BorderSpec	getRowBorder() Get the border around each contained row.
int	getRowCount()
IPLRenderableObject<?>	getRowElementAtIndex(int nIndex) Get the element in the row at the specified index.
Color	getRowFillColor() Get the fill color to be used to fill the whole row.
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	removeRow(int nIndex)
IMPLTYPE	setBasicDataFrom(AbstractPLVBox<?> aSource)
IMPLTYPE	setRowBorder(BorderSpec aRowBorder) Set the border around each contained row.
IMPLTYPE	setRowFillColor(Color aRowFillColor) Set the fill color to be used to fill the whole row.
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.element.vbox.IPLHasRowBorder

setRowBorder, setRowBorder, setRowBorder, setRowBorderBottom, setRowBorderLeft, setRowBorderRight, setRowBorderTop

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

hasFillColor

Field Detail

m_aRows

protected final com.helger.commons.collection.ext.ICommonsList<PLVBoxRow> m_aRows

m_aPreparedRowElementWidth

protected float[] m_aPreparedRowElementWidth

prepare width (without padding and margin)

m_aPreparedRowElementHeight

protected float[] m_aPreparedRowElementHeight

prepare height (without padding and margin)

Constructor Detail

AbstractPLVBox

public AbstractPLVBox()

Method Detail

setBasicDataFrom

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

getRowCount

@Nonnegative
public int getRowCount()

Returns:

The number of rows. Always ≥ 0.

getAllRows

@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.collection.ext.ICommonsList<PLVBoxRow> getAllRows()

Returns:

All rows. Never null.

getRowAtIndex

@Nullable
public PLVBoxRow getRowAtIndex(@Nonnegative
                                          int nIndex)

Get the row at the specified index.

Parameters:

nIndex - The index to use. Should be ≥ 0.

Returns:

null if an invalid index was provided.

getFirstRow

@Nullable
public PLVBoxRow getFirstRow()

Returns:

The first row or null if no row is present.

getLastRow

@Nullable
public PLVBoxRow getLastRow()

Returns:

The last row or null if no row is present.

getRowElementAtIndex

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

Get the element in the row at the specified index.

Parameters:

nIndex - The index to use. Should be ≥ 0.

Returns:

null if an invalid index was provided.

getFirstRowElement

@Nullable
public IPLRenderableObject<?> getFirstRowElement()

Returns:

The element in the first row or null if no row is present.

getLastRowElement

@Nullable
public IPLRenderableObject<?> getLastRowElement()

Returns:

The element in the last row or null if no row is present.

addAndReturnRow

@Nonnull
public PLVBoxRow addAndReturnRow(@Nonnull
                                           IPLRenderableObject<?> aElement)

Add a row to this VBox.

Parameters:

aElement - The row to be added. May not be null.

Returns:

the created row

addRow

@Nonnull
public IMPLTYPE addRow(@Nonnull
                                 IPLRenderableObject<?> aElement)

Add a row to this VBox.

Parameters:

aElement - The row to be added. May not be null.

Returns:

this

addAndReturnRow

@Nonnull
public PLVBoxRow addAndReturnRow(@Nonnegative
                                           int nIndex,
                                           @Nonnull
                                           IPLRenderableObject<?> aElement)

Add a row to this VBox.

Parameters:

nIndex - The index where the row should be added. Must be ≥ 0.

aElement - The row to be added. May not be null.

Returns:

the created row

addRow

@Nonnull
public IMPLTYPE addRow(@Nonnegative
                                 int nIndex,
                                 @Nonnull
                                 IPLRenderableObject<?> aElement)

Add a row to this VBox.

Parameters:

nIndex - The index where the row should be added. Must be ≥ 0.

aElement - The row to be added. May not be null.

Returns:

this

removeRow

@Nonnull
public IMPLTYPE removeRow(@Nonnegative
                                    int nIndex)

setRowBorder

@Nonnull
public final IMPLTYPE setRowBorder(@Nonnull
                                             BorderSpec aRowBorder)

Set the border around each contained row.

Specified by:

setRowBorder in interface IPLHasRowBorder<IMPLTYPE extends AbstractPLVBox<IMPLTYPE>>

Parameters:

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

Returns:

this

getRowBorder

@Nonnull
public final BorderSpec getRowBorder()

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

Specified by:

getRowBorder in interface IPLHasRowBorder<IMPLTYPE extends AbstractPLVBox<IMPLTYPE>>

Returns:

Never null.

setRowFillColor

@Nonnull
public IMPLTYPE setRowFillColor(@Nullable
                                          Color aRowFillColor)

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

Parameters:

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

Returns:

this

getRowFillColor

@Nullable
public Color getRowFillColor()

Get the fill color to be used to fill the whole row. 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 AbstractPLVBox<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.

Specified by:

doPageSetup in interface IPLRenderableObject<IMPLTYPE extends AbstractPLVBox<IMPLTYPE>>

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

Parameters:

aCtx - Rendering context

Throws:

IOException - In case of a PDFBox error

toString

public String toString()

Overrides:

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