Package 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.element.vbox.AbstractPLVBox<IMPLTYPE>

Type Parameters:

IMPLTYPE - Implementation type

All Implemented Interfaces:

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

Direct Known Subclasses:

PLVBox

public abstract class AbstractPLVBox<IMPLTYPE extends AbstractPLVBox<IMPLTYPE>>
extends AbstractPLRenderableObject<IMPLTYPE>
implements IPLSplittableObject<IMPLTYPE,IMPLTYPE>

Vertical box - groups several rows.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	DEFAULT_FULL_WIDTH

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

DEFAULT_VERT_SPLITTABLE

Constructor Summary

Constructors

Constructor	Description
AbstractPLVBox()

Method Summary

Modifier and Type	Method	Description
PLVBoxRow	addAndReturnRow(int nIndex, IPLRenderableObject<?> aElement, HeightSpec aHeight)	Add a row to this VBox.
PLVBoxRow	addAndReturnRow(IPLRenderableObject<?> aElement)	Add a row to this VBox using auto height.
PLVBoxRow	addAndReturnRow(IPLRenderableObject<?> aElement, HeightSpec aHeight)	Add a row to this VBox.
IMPLTYPE	addRow(int nIndex, IPLRenderableObject<?> aElement, HeightSpec aHeight)	Add a row to this VBox.
IMPLTYPE	addRow(IPLRenderableObject<?> aElement)	Add a row to this VBox using auto height.
IMPLTYPE	addRow(IPLRenderableObject<?> aElement, HeightSpec aHeight)	Add a row to this VBox.
boolean	containsAnyVertSplittableElement()
void	forEachRow(Consumer<? super PLVBoxRow> aConsumer)
void	forEachRowByIndex(ObjIntConsumer<? super PLVBoxRow> aConsumer)
com.helger.commons.collection.impl.ICommonsList<PLVBoxRow>	getAllRows()
HeightSpec	getDefaultHeight()
PLVBoxRow	getFirstRow()
IPLRenderableObject<?>	getFirstRowElement()
int	getHeaderRowCount()
PLVBoxRow	getLastRow()
IPLRenderableObject<?>	getLastRowElement()
PLVBoxRow	getRowAtIndex(int nIndex)	Get the row at the specified index.
int	getRowCount()
IPLRenderableObject<?>	getRowElementAtIndex(int nIndex)	Get the element in the row at the specified index.
Iterable<PLVBoxRow>	getRows()
boolean	isFullWidth()
boolean	isVertSplittable()
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.
IMPLTYPE	removeRow(int nIndex)	Remove the row with the specified index.
IMPLTYPE	setBasicDataFrom(IMPLTYPE aSource)	For copying stuff internally.
IMPLTYPE	setFullWidth(boolean bFullWidth)	Set usage of full width.
IMPLTYPE	setHeaderRowCount(int nHeaderRowCount)	Set the number of header rows in this table.
IMPLTYPE	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, 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.IPLHasOutline

getOutlineBottom, getOutlineLeft, getOutlineRight, getOutlineTop, getOutlineXSum, getOutlineYSum

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

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

internalCreateNewVertSplitObject

Field Detail

DEFAULT_FULL_WIDTH

public static final boolean DEFAULT_FULL_WIDTH

See Also:

Constant Field Values

Constructor Detail

AbstractPLVBox

public AbstractPLVBox()

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

Overrides:

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

Parameters:

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

Returns:

this for chaining

getRowCount

@Nonnegative
public int getRowCount()

Returns:

The number of rows. Always ≥ 0.

getAllRows

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

Returns:

All rows. Never null.

getRows

@Nonnull
public Iterable<PLVBoxRow> getRows()

Returns:

All rows. Never null.

forEachRow

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

forEachRowByIndex

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

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.

getDefaultHeight

@Nonnull
public HeightSpec getDefaultHeight()

Returns:

The default height to be used for rows if none is provided. May not be null.

addAndReturnRow

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

Add a row to this VBox using auto height.

Parameters:

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

Returns:

the created row

addAndReturnRow

@Nonnull
public final PLVBoxRow addAndReturnRow(@Nonnull
                                       IPLRenderableObject<?> aElement,
                                       @Nonnull
                                       HeightSpec aHeight)

Add a row to this VBox.

Parameters:

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

aHeight - The height specification to use. May not be null.

Returns:

the created row

addRow

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

Add a row to this VBox using auto height.

Parameters:

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

Returns:

this

addRow

@Nonnull
public final IMPLTYPE addRow(@Nonnull
                             IPLRenderableObject<?> aElement,
                             @Nonnull
                             HeightSpec aHeight)

Add a row to this VBox.

Parameters:

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

aHeight - The height specification to use. May not be null.

Returns:

this for chaining

addAndReturnRow

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

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.

aHeight - The height specification to use. May not be null.

Returns:

the created row. Never null.

addRow

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

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.

aHeight - The height specification to use. May not be null.

Returns:

this for chaining

removeRow

@Nonnull
public IMPLTYPE removeRow(@Nonnegative
                          int nIndex)

Remove the row with the specified index.

Parameters:

nIndex - The index to be removed.

Returns:

this for chaining

isVertSplittable

public final boolean isVertSplittable()

Specified by:

isVertSplittable in interface IPLObject<IMPLTYPE extends AbstractPLVBox<IMPLTYPE>>

Specified by:

isVertSplittable in interface IPLSplittableObject<IMPLTYPE extends AbstractPLVBox<IMPLTYPE>,IMPLTYPE extends AbstractPLVBox<IMPLTYPE>>

Returns:

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

setVertSplittable

@Nonnull
public final IMPLTYPE setVertSplittable(boolean bVertSplittable)

Description copied from interface: IPLSplittableObject

Change the vertical splitability of this object.

Specified by:

setVertSplittable in interface IPLSplittableObject<IMPLTYPE extends AbstractPLVBox<IMPLTYPE>,IMPLTYPE extends AbstractPLVBox<IMPLTYPE>>

Parameters:

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

Returns:

this for chaining

getHeaderRowCount

@Nonnegative
public final int getHeaderRowCount()

Returns:

The number of header rows. By default 0. Always ≥ 0.

setHeaderRowCount

@Nonnull
public final IMPLTYPE setHeaderRowCount(@Nonnegative
                                        int nHeaderRowCount)

Set the number of header rows in this table. Header rows get repeated on every page upon rendering.

Parameters:

nHeaderRowCount - The number of header rows, to be repeated by page. Must be ≥ 0.

Returns:

this

containsAnyVertSplittableElement

public boolean containsAnyVertSplittableElement()

isFullWidth

public final boolean isFullWidth()

Returns:

Should the VBox occupy the full width? The default is DEFAULT_FULL_WIDTH.

setFullWidth

@Nonnull
public final IMPLTYPE setFullWidth(boolean bFullWidth)

Set usage of full width.

Parameters:

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

Returns:

this for chaining

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

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

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

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

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

Parameters:

aCtx - Rendering context. Never null.

Throws:

IOException - In case of a PDFBox error

toString

public String toString()

Overrides:

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