com.helger.pdflayout.element.special

Class PLPageBreak

java.lang.Object

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

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

com.helger.pdflayout.element.special.PLPageBreak

All Implemented Interfaces:

com.helger.commons.id.IHasID<String>, com.helger.commons.traits.IGenericImplTrait<PLPageBreak>, IPLHasOutline, IPLObject<PLPageBreak>, IPLRenderableObject<PLPageBreak>

public class PLPageBreak
extends AbstractPLRenderableObject<PLPageBreak>

A page break that ensures a new page is started afterwards. The difference between force pages breaks and normal page breaks is as follows: forced page breaks are always executed, whereas normal page breaks are not executed if a new page just started.
Important note: page breaks are only handled if they are directly contained in a page set. Page breaks are not handled when nested in VBoxes or HBoxes.

Author:

Philip Helger

Field Summary

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

DEFAULT_MAX_SIZE, DEFAULT_MIN_SIZE

Constructor Summary

Constructors

Constructor and Description
PLPageBreak(boolean bForcePageBreak) Constructor

Method Summary

Modifier and Type	Method and Description
static PLPageBreak	createPreparedPageBreak()
boolean	isForcePageBreak()
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.
String	toString()

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

doPageSetup, setExactSize

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

getFullBottom, getFullLeft, getFullRight, getFullTop, getFullXSum, getFullYSum

Constructor Detail

PLPageBreak

public PLPageBreak(boolean bForcePageBreak)

Constructor

Parameters:

bForcePageBreak - true if this is a forced page break, false if it is a normal page break.

Method Detail

isForcePageBreak

public boolean isForcePageBreak()

Returns:

true if this is a forced page break, false if it is a normal page break.

onPrepare

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

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

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

Parameters:

aCtx - Rendering context

Throws:

IOException - In case of a PDFBox error

toString

public String toString()

Overrides:

toString in class AbstractPLRenderableObject<PLPageBreak>

createPreparedPageBreak

@Nonnull
public static PLPageBreak createPreparedPageBreak()