Package com.helger.pdflayout.element.table

Class PLTable

java.lang.Object

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

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

com.helger.pdflayout.element.table.PLTable

All Implemented Interfaces:

com.helger.commons.id.IHasID<String>, com.helger.commons.traits.IGenericImplTrait<PLTable>, IPLHasMargin<PLTable>, IPLHasOutline, IPLObject<PLTable>, IPLRenderableObject<PLTable>, IPLSplittableObject<PLTable,PLTable>, IPLVisitable

public class PLTable
extends AbstractPLRenderableObject<PLTable>
implements IPLSplittableObject<PLTable,PLTable>, IPLHasMargin<PLTable>

A special table with a repeating header

Author:

Philip Helger

Field Summary

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

DEFAULT_MARGIN

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

DEFAULT_VERT_SPLITTABLE

Constructor Summary

Constructors

Constructor	Description
PLTable()	Deprecated.
PLTable(WidthSpec... aWidths)
PLTable(Iterable<? extends WidthSpec> aWidths)

Method Summary

Modifier and Type	Method	Description
PLTableRow	addAndReturnRow(PLTableCell... aCells)
PLTableRow	addAndReturnRow(Iterable<? extends PLTableCell> aCells)	Add a new table row with auto height.
PLTableRow	addAndReturnRow(Iterable<? extends PLTableCell> aCells, HeightSpec aHeight)	Add a new table row.
PLTable	addRow()	Deprecated.
PLTable	addRow(PLTableCell... aCells)	Add a new table row with auto height.
PLTable	addRow(PLTableRow aRow)
PLTable	addRow(PLTableRow aRow, HeightSpec aHeight)
PLTable	addRow(Iterable<? extends PLTableCell> aCells)	Add a new table row with auto height.
PLTable	addRow(Iterable<? extends PLTableCell> aCells, HeightSpec aHeight)	Add a new table row.
static PLTable	createWithEvenlySizedColumns(int nColumnCount)	Create a new table with evenly sized columns.
static PLTable	createWithPercentage(float... aPercentages)	Create a new table with the specified percentages.
void	forEachCell(Consumer<? super PLTableCell> aConsumer)
void	forEachRow(int nStartRowIncl, int nEndRowIncl, Consumer<? super PLTableRow> aConsumer)
void	forEachRow(int nStartRowIncl, int nEndRowIncl, ObjIntConsumer<? super PLTableRow> aConsumer)
void	forEachRow(Consumer<? super PLTableRow> aConsumer)
void	forEachRowByIndex(ObjIntConsumer<? super PLTableRow> aConsumer)
com.helger.commons.collection.impl.ICommonsList<WidthSpec>	getAllWidths()
PLTableCell	getCellAtIndex(int nRowIndex, int nColIndex)
int	getColumnCount()
int	getHeaderRowCount()
MarginSpec	getMargin()
PLTableRow	getRowAtIndex(int nIndex)
int	getRowCount()
PLTable	internalCreateNewVertSplitObject(PLTable aBase)	Create a new object of the same type as this object.
boolean	isVertSplittable()
protected void	onAfterSetID()	Callback invoked after an ID change.
protected void	onMarkAsNotPrepared()	PL objects need to overwrite this method to reset their preparation state.
protected SizeSpec	onPrepare(PreparationContext aCtx)	The abstract method that must be implemented by all subclasses.
protected void	onRender(PageRenderContext aCtx)	Abstract method to be implemented by subclasses.
PLTable	setBasicDataFrom(PLTable aSource)	For copying stuff internally.
PLTable	setHeaderRowCount(int nHeaderRowCount)
PLTable	setMargin(MarginSpec aMargin)	Set the margin values.
PLTable	setVertSplittable(boolean bVertSplittable)	Change the vertical splitability of this object.
PLSplitResult	splitElementVert(float fAvailableWidth, float fAvailableHeight)	Split this element vertically into sub-elements according to the available height.
String	toString()
com.helger.commons.state.EChange	visit(IPLVisitor aVisitor)	Visit this object and all descendants

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

getPrepareAvailableSize, getPreparedSize, getRenderSize, getRenderSize, internalCheckAlreadyPrepared, internalCheckNotPrepared, internalMarkAsNotPrepared, internalMarkAsNotPreparedDontPropagate, internalMarkAsPrepared, isPrepared, onRenderSizeChange, prepare, render

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

getDebugID, getID, 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.IPLHasMargin

addMarginBottom, addMarginLeft, addMarginRight, addMarginTop, addMarginX, addMarginY, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMarginXSum, getMarginYSum, getOutlineBottom, getOutlineLeft, getOutlineRight, getOutlineTop, getOutlineXSum, getOutlineYSum, setMargin, setMargin, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setMarginX, setMarginY

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

getAsSplittable, getDebugID, hasID

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

beforeRender, getPreparedHeight, getPreparedWidth, getRenderHeight, getRenderWidth

Constructor Detail

PLTable

@Deprecated
@DevelopersNote("This ctor is only present to indicate if the varargs ctor would be used without parameters")
public PLTable()

Deprecated.

Don't use that constructor. Use PLTable(Iterable) or PLTable(WidthSpec...)!!!

PLTable

public PLTable(@Nonnull @Nonempty
               WidthSpec... aWidths)

Parameters:

aWidths - Must all be of the same type! "auto" width is not allowed - only "star" may be used.

PLTable

public PLTable(@Nonnull @Nonempty
               Iterable<? extends WidthSpec> aWidths)

Parameters:

aWidths - Must all be of the same type! "auto" width is not allowed - only "star" may be used.

Method Detail

onAfterSetID

@OverridingMethodsMustInvokeSuper
protected void onAfterSetID()

Description copied from class: AbstractPLObject

Callback invoked after an ID change. Overwrite this method to do local actions (if needed)

Overrides:

onAfterSetID in class AbstractPLObject<PLTable>

setBasicDataFrom

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

Description copied from interface: IPLObject

For copying stuff internally. Must always call super method

Specified by:

setBasicDataFrom in interface IPLObject<PLTable>

Overrides:

setBasicDataFrom in class AbstractPLRenderableObject<PLTable>

Parameters:

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

Returns:

this for chaining

getMargin

@Nonnull
public final MarginSpec getMargin()

Specified by:

getMargin in interface IPLHasMargin<PLTable>

Returns:

The current margin. Never null.

setMargin

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

Description copied from interface: IPLHasMargin

Set the margin values.

Specified by:

setMargin in interface IPLHasMargin<PLTable>

Parameters:

aMargin - Margin to use. May not be null.

Returns:

this

getAllWidths

@Nonnull
@Nonempty
@ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsList<WidthSpec> getAllWidths()

Returns:

A copy of the list with all widths as specified in the constructor. Neither null nor empty.

getColumnCount

@Nonnegative
public int getColumnCount()

Returns:

The number of columns in the table. Always ≥ 0.

setHeaderRowCount

@Nonnull
public PLTable setHeaderRowCount(@Nonnegative
                                 int nHeaderRowCount)

getHeaderRowCount

@Nonnegative
public int getHeaderRowCount()

addAndReturnRow

@Nonnull
public PLTableRow addAndReturnRow(@Nonnull
                                  PLTableCell... aCells)

addAndReturnRow

@Nonnull
public PLTableRow addAndReturnRow(@Nonnull
                                  Iterable<? extends PLTableCell> aCells)

Add a new table row with auto height. All contained elements are added with the specified width in the constructor. null elements are represented as empty cells.

Parameters:

aCells - The cells to add. May not be null.

Returns:

the added table row and never null.

addAndReturnRow

@Nonnull
public PLTableRow addAndReturnRow(@Nonnull
                                  Iterable<? extends PLTableCell> aCells,
                                  @Nonnull
                                  HeightSpec aHeight)

Add a new table row. All contained elements are added with the specified width in the constructor. null elements are represented as empty cells.

Parameters:

aCells - The cells to add. May not be null but may contain null values.

aHeight - Row height to be used. May not be null.

Returns:

the added table row and never null.

addRow

@Nonnull
public PLTable addRow(@Nonnull
                      PLTableRow aRow)

addRow

@Nonnull
public PLTable addRow(@Nonnull
                      PLTableRow aRow,
                      @Nonnull
                      HeightSpec aHeight)

addRow

@Nonnull
@Deprecated
public PLTable addRow()

Deprecated.

Don't call this.

Returns:

this for chaining

addRow

@Nonnull
public PLTable addRow(@Nonnull
                      PLTableCell... aCells)

Add a new table row with auto height. All contained elements are added with the specified width in the constructor. null elements are represented as empty cells.

Parameters:

aCells - The cells to add. May not be null.

Returns:

this

addRow

@Nonnull
public PLTable addRow(@Nonnull
                      Iterable<? extends PLTableCell> aCells)

Add a new table row with auto height. All contained elements are added with the specified width in the constructor. null elements are represented as empty cells.

Parameters:

aCells - The cells to add. May not be null.

Returns:

this

addRow

@Nonnull
public PLTable addRow(@Nonnull
                      Iterable<? extends PLTableCell> aCells,
                      @Nonnull
                      HeightSpec aHeight)

Add a new table row. All contained elements are added with the specified width in the constructor. null elements are represented as empty cells.

Parameters:

aCells - The cells to add. May not be null.

aHeight - Row height to be used.

Returns:

this

forEachRow

public void forEachRow(@Nonnull
                       Consumer<? super PLTableRow> aConsumer)

forEachRowByIndex

public void forEachRowByIndex(@Nonnull
                              ObjIntConsumer<? super PLTableRow> aConsumer)

forEachRow

public void forEachRow(int nStartRowIncl,
                       int nEndRowIncl,
                       @Nonnull
                       Consumer<? super PLTableRow> aConsumer)

forEachRow

public void forEachRow(int nStartRowIncl,
                       int nEndRowIncl,
                       @Nonnull
                       ObjIntConsumer<? super PLTableRow> aConsumer)

getRowCount

@Nonnegative
public int getRowCount()

forEachCell

public void forEachCell(@Nonnull
                        Consumer<? super PLTableCell> aConsumer)

getRowAtIndex

@Nullable
public PLTableRow getRowAtIndex(@Nonnegative
                                int nIndex)

getCellAtIndex

@Nullable
public PLTableCell getCellAtIndex(@Nonnegative
                                  int nRowIndex,
                                  @Nonnegative
                                  int nColIndex)

visit

@Nonnull
public com.helger.commons.state.EChange visit(@Nonnull
                                              IPLVisitor aVisitor)
                                       throws IOException

Description copied from interface: IPLVisitable

Visit this object and all descendants

Specified by:

visit in interface IPLVisitable

Overrides:

visit in class AbstractPLRenderableObject<PLTable>

Parameters:

aVisitor - The visitor to use. May not be null.

Returns:

EChange.CHANGED if something changed internally.

Throws:

IOException - on PDFBox error

onPrepare

@OverridingMethodsMustInvokeSuper
protected SizeSpec onPrepare(@Nonnull
                             PreparationContext aCtx)

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<PLTable>

Parameters:

aCtx - Preparation context. Never null.

Returns:

The size of the rendered element without padding, border and margin. May not be null.

onMarkAsNotPrepared

protected void onMarkAsNotPrepared()

Description copied from class: AbstractPLRenderableObject

PL objects need to overwrite this method to reset their preparation state. They also need to propagate this to their children!

Specified by:

onMarkAsNotPrepared in class AbstractPLRenderableObject<PLTable>

isVertSplittable

public final boolean isVertSplittable()

Specified by:

isVertSplittable in interface IPLObject<PLTable>

Specified by:

isVertSplittable in interface IPLSplittableObject<PLTable,PLTable>

Returns:

true if this element is vertically splittable, false otherwise. The default is IPLSplittableObject.DEFAULT_VERT_SPLITTABLE.

setVertSplittable

@Nonnull
public final PLTable setVertSplittable(boolean bVertSplittable)

Description copied from interface: IPLSplittableObject

Change the vertical splitability of this object.

Specified by:

setVertSplittable in interface IPLSplittableObject<PLTable,PLTable>

Parameters:

bVertSplittable - true if this element is splittable, false otherwise.

Returns:

this for chaining

internalCreateNewVertSplitObject

@Nonnull
public PLTable internalCreateNewVertSplitObject(@Nonnull
                                                PLTable aBase)

Description copied from interface: IPLSplittableObject

Create a new object of the same type as this object.

Specified by:

internalCreateNewVertSplitObject in interface IPLSplittableObject<PLTable,PLTable>

Parameters:

aBase - The source object to copy data from.

Returns:

Never null.

splitElementVert

@Nullable
public PLSplitResult splitElementVert(float fAvailableWidth,
                                      float fAvailableHeight)

Description copied from interface: IPLSplittableObject

Split this element vertically into sub-elements according to the available height. Splitting is always done after preparation and must return prepared objects!

Specified by:

splitElementVert in interface IPLSplittableObject<PLTable,PLTable>

Parameters:

fAvailableWidth - The available width without outline of the element.

fAvailableHeight - The available height without outline of this element. Must be ≥ 0.

Returns:

null if splitting makes no sense.

onRender

protected void onRender(@Nonnull
                        PageRenderContext aCtx)
                 throws IOException

Description copied from class: AbstractPLRenderableObject

Abstract method to be implemented by subclasses.

Specified by:

onRender in class AbstractPLRenderableObject<PLTable>

Parameters:

aCtx - Rendering context. Never null.

Throws:

IOException - In case of a PDFBox error

toString

public String toString()

Overrides:

toString in class AbstractPLRenderableObject<PLTable>

createWithPercentage

@Nonnull
@ReturnsMutableCopy
public static PLTable createWithPercentage(@Nonnull @Nonempty
                                           float... aPercentages)

Create a new table with the specified percentages.

Parameters:

aPercentages - The array to use. The sum of all percentages should be ≤ 100. May neither be null nor empty.

Returns:

The created PLTable and never null.

createWithEvenlySizedColumns

@Nonnull
@ReturnsMutableCopy
public static PLTable createWithEvenlySizedColumns(@Nonnegative
                                                   int nColumnCount)

Create a new table with evenly sized columns.

Parameters:

nColumnCount - The number of columns to use. Must be > 0.

Returns:

The created PLTable and never null.