Package 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>, IPLVisitable

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

Constructor Summary

Constructors

Constructor	Description
PLPageBreak(boolean bForcePageBreak)	Constructor

Method Summary

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

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

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

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, isVertSplittable

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

beforeRender, getPreparedHeight, getPreparedWidth, getRenderHeight, getRenderWidth

Constructor Details

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 Details

isForcePageBreak

public final 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)

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.

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

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

Parameters:

aCtx - Rendering context. Never null.

Throws:

IOException - In case of a PDFBox error

toString

public String toString()

Overrides:

toString in class AbstractPLRenderableObject<PLPageBreak>

createPreparedPageBreak

@Nonnull
public static PLPageBreak createPreparedPageBreak()