org.pentaho.reporting.engine.classic.core.layout.process

Class PaginationStepLib

java.lang.Object

org.pentaho.reporting.engine.classic.core.layout.process.PaginationStepLib

public final class PaginationStepLib
extends Object

A helper class that contains generic methods that would distract me from the actual pagination logic.

Method Summary

Modifier and Type	Method and Description
static void	assertBlockPosition(RenderBox box, long shift)
static void	assertProgress(LogicalPageBox pageBox)
static long	computeNonBreakableBoxHeight(RenderBox box, PaginationShiftState shiftState, BasePaginationTableState tableState) Computes the height that will be required on this page to display at least some parts of the box.
static void	configureBreakUtility(PageBreakPositionList breakUtility, LogicalPageBox pageBox, long[] allCurrentBreaks, long reservedHeight, long lastBreakLocal)
static long	getWidowConstraint(RenderBox box, PaginationShiftState shiftState, BasePaginationTableState tableState)
static long	restrictPageAreaHeights(LogicalPageBox pageBox, long[] allCurrentBreaks)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

configureBreakUtility

public static void configureBreakUtility(PageBreakPositionList breakUtility,
                                         LogicalPageBox pageBox,
                                         long[] allCurrentBreaks,
                                         long reservedHeight,
                                         long lastBreakLocal)

assertProgress

public static void assertProgress(LogicalPageBox pageBox)

restrictPageAreaHeights

public static long restrictPageAreaHeights(LogicalPageBox pageBox,
                                           long[] allCurrentBreaks)

assertBlockPosition

public static void assertBlockPosition(RenderBox box,
                                       long shift)

computeNonBreakableBoxHeight

public static long computeNonBreakableBoxHeight(RenderBox box,
                                                PaginationShiftState shiftState,
                                                BasePaginationTableState tableState)

Computes the height that will be required on this page to display at least some parts of the box.

Parameters:

box - the box for which the height is computed

Returns:

the height in micro-points.

getWidowConstraint

public static long getWidowConstraint(RenderBox box,
                                      PaginationShiftState shiftState,
                                      BasePaginationTableState tableState)