Package org.pentaho.reporting.engine.classic.core.layout.model

Class LogicalPageBox

java.lang.Object

org.pentaho.reporting.engine.classic.core.layout.model.RenderNode

org.pentaho.reporting.engine.classic.core.layout.model.RenderBox

org.pentaho.reporting.engine.classic.core.layout.model.BlockRenderBox

org.pentaho.reporting.engine.classic.core.layout.model.LogicalPageBox

All Implemented Interfaces:

Cloneable

public final class LogicalPageBox
extends BlockRenderBox

The logical page is the root-structure of the generated content. This object is a slotted container.

Author:

Thomas Morgner

Nested Class Summary

Nested classes/interfaces inherited from class org.pentaho.reporting.engine.classic.core.layout.model.RenderBox

RenderBox.BreakIndicator, RenderBox.RestrictFinishClearOut

Nested classes/interfaces inherited from class org.pentaho.reporting.engine.classic.core.layout.model.RenderNode

RenderNode.CacheState

Field Summary

Fields inherited from class org.pentaho.reporting.engine.classic.core.layout.model.RenderBox

FLAG_BOX_CONTAINS_PRESERVED_CONTENT, FLAG_BOX_INVALID_WIDOW_ORPHAN_NODE, FLAG_BOX_TABLE_SECTION_RESERVED, FLAG_BOX_TABLE_SECTION_RESERVED2, FLAG_BOX_TABLE_SECTION_RESERVED3, FLAG_BOX_TABLE_SECTION_RESERVED4, FLAG_BOX_TABLE_SECTION_RESERVED5

Fields inherited from class org.pentaho.reporting.engine.classic.core.layout.model.RenderNode

CACHE_CLEAN, CACHE_DEEP_DIRTY, CACHE_DIRTY, HORIZONTAL_AXIS, VERTICAL_AXIS

Constructor Summary

Constructors

Constructor	Description
LogicalPageBox(ReportDefinition report, StyleSheet style, BoxDefinition box)

Method Summary

Modifier and Type	Method	Description
LogicalPageBox	clone()	Clones this node.
long	computePageEnd()
LogicalPageBox	derive(boolean deepDerive)	Derive creates a disconnected node that shares all the properties of the original node.
LogicalPageBox	deriveFrozen(boolean deepDerive)	Derive creates a disconnected node that shares all the properties of the original node.
PageBreakPositionList	getAllVerticalBreaks()
BlockRenderBox	getContentArea()
BlockRenderBox	getFooterArea()
BlockRenderBox	getHeaderArea()
LogicalPageBox	getLogicalPage()
int	getNodeType()
long	getPageEnd()
PageGrid	getPageGrid()
long	getPageHeight()
String	getPageName()
long	getPageOffset()
long	getPageWidth()
long[]	getPhysicalBreaks(int axis)
long	getProcessedTableOffset()
BlockRenderBox	getRepeatFooterArea()
WatermarkAreaBox	getWatermarkArea()
void	rollbackSaveInformation()
void	setAllVerticalBreaks(PageBreakPositionList allVerticalBreaks)
void	setPageEnd(long pageEnd)
void	setPageName(String pageName)
void	setPageOffset(long pageOffset)
void	setProcessedTableOffset(long processedTableOffset)
void	storeSaveInformation()

Methods inherited from class org.pentaho.reporting.engine.classic.core.layout.model.BlockRenderBox

isBlockForPagebreakPurpose

Methods inherited from class org.pentaho.reporting.engine.classic.core.layout.model.RenderBox

addChild, addChilds, addGeneratedChild, addGeneratedChilds, addOverflowArea, apply, clear, close, commit, create, decreaseContentReferenceCount, decreaseDescendantCount, decreaseTableReferenceCount, extendHeight, extendHeightInBlockMode, extendHeightInRowMode, findNodeById, freeze, getAppliedContentRefCount, getBaselineInfo, getBoxDefinition, getChildCount, getContentAge, getContentAreaX1, getContentAreaX2, getContentBox, getContentRefCount, getDescendantCount, getEffectiveMinimumChunkSize, getFirstChild, getInsets, getInsetsLeft, getInsetsRight, getLastChild, getManualBreakIndicator, getName, getOrphanConstraintSize, getOrphanLeafCount, getOverflowAreaHeight, getOverflowAreaWidth, getParentWidowContexts, getPinned, getProcessKeyCached, getProcessKeyStepAge, getRawValue, getRestrictFinishedClearOut, getStateKey, getStaticBoxLayoutProperties, getStaticBoxPropertiesAge, getTableExportState, getTableRefCount, getTableValidationAge, getTextEllipseBox, getVerticalInsets, getWidowConstraintSize, getWidowConstraintSizeWithKeepTogether, getWidowLeafCount, increaseContentReferenceCount, increaseDescendantCount, increaseTableReferenceCount, isAcceptInlineBoxes, isAppendable, isAppliedOpen, isAppliedSeen, isBoxOverflowX, isBoxOverflowY, isBreakAfter, isCommited, isContainsReservedContent, isContentRefHolder, isDeepFinishedTable, isDiscardable, isEmpty, isEmptyNodesHaveSignificance, isInvalidWidowOrphanNode, isMarkedOpen, isMarkedSeen, isOpen, isOrphanLeaf, isPinned, isPreventPagination, isProcessKeyCacheValid, isProcessKeyFinish, isRenderBox, isSizeSpecifiesBorderBox, markAsContentRefHolder, markBoxSeen, markPinned, remove, replaceChild, replaceChilds, resetCacheState, rollback, setBaselineInfo, setContainsReservedContent, setContentAge, setContentAreaX1, setContentAreaX2, setContentBox, setDeepFinished, setFirstChild, setInvalidWidowOrphanNode, setLastChild, setManualBreakIndicator, setMinimumChunkWidth, setName, setOpen, setOrphanConstraintSize, setOrphanLeafCount, setOverflowAreaHeight, setOverflowAreaWidth, setParentWidowContexts, setPreventPagination, setProcessKeyCached, setRawValue, setRestrictFinishedClearOut, setStateKey, setStaticBoxPropertiesAge, setTableExportState, setTableValidationAge, setTextEllipseBox, setWidowConstraintSize, setWidowConstraintSizeWithKeepTogether, setWidowLeafCount, split, toString, updateChangeTracker, useMinimumChunkWidth

Methods inherited from class org.pentaho.reporting.engine.classic.core.layout.model.RenderNode

getApplyState, getAttributes, getCachedAge, getCachedHeight, getCachedWidth, getCachedX, getCachedX2, getCachedY, getCachedY2, getCacheState, getChangeTracker, getEffectiveMarginBottom, getEffectiveMarginTop, getElementType, getHeight, getInstanceId, getLayoutNodeType, getLayoutParent, getLinebreakAge, getMajorAxis, getMaximumBoxWidth, getMinimumChunkWidth, getMinorAxis, getNext, getNodeLayoutProperties, getParent, getPrev, getRowIndex, getStyleSheet, getValidateModelAge, getVerticalTextAlignment, getWidth, getX, getY, getY2, isBoxVisible, isBoxVisible, isCacheValid, isFinishedPaginate, isFinishedTable, isFlag, isFrozen, isIgnorableForRendering, isLinebreakCacheValid, isNodeVisible, isNodeVisible, isNodeVisible, isNodeVisible, isParanoidModelChecks, isValidateModelCacheValid, isValidateModelResult, isVirtualNode, isVisible, isWidowBox, markApplyStateDirty, reinit, resetValidateModelResult, setCachedAge, setCachedHeight, setCachedWidth, setCachedX, setCachedY, setFinishedPaginate, setFinishedTable, setFlag, setHeight, setLinebreakAge, setMaximumBoxWidth, setNext, setNextUnchecked, setParent, setPrev, setPrevUnchecked, setValidateModelResult, setVirtualNode, setWidowBox, setWidth, setX, setY, shift, shiftCached, updateCacheState

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LogicalPageBox

public LogicalPageBox(ReportDefinition report,
                      StyleSheet style,
                      BoxDefinition box)

Method Detail

getContentArea

public BlockRenderBox getContentArea()

getHeaderArea

public BlockRenderBox getHeaderArea()

getRepeatFooterArea

public BlockRenderBox getRepeatFooterArea()

getFooterArea

public BlockRenderBox getFooterArea()

getWatermarkArea

public WatermarkAreaBox getWatermarkArea()

getLogicalPage

public LogicalPageBox getLogicalPage()

Overrides:

getLogicalPage in class RenderNode

getPageWidth

public long getPageWidth()

getPageGrid

public PageGrid getPageGrid()

getPageOffset

public long getPageOffset()

setPageOffset

public void setPageOffset(long pageOffset)

getPageEnd

public long getPageEnd()

setPageEnd

public void setPageEnd(long pageEnd)

getPhysicalBreaks

public long[] getPhysicalBreaks(int axis)

getPageHeight

public long getPageHeight()

deriveFrozen

public LogicalPageBox deriveFrozen(boolean deepDerive)

Derive creates a disconnected node that shares all the properties of the original node. The derived node will no longer have any parent, silbling, child or any other relationships with other nodes.

Overrides:

deriveFrozen in class RenderBox

Returns:

derive

public LogicalPageBox derive(boolean deepDerive)

Derive creates a disconnected node that shares all the properties of the original node. The derived node will no longer have any parent, silbling, child or any other relationships with other nodes.

Overrides:

derive in class RenderBox

Returns:

clone

public LogicalPageBox clone()

Clones this node. Be aware that cloning can get you into deep trouble, as the relations this node has may no longer be valid.

Overrides:

clone in class RenderNode

Returns:

setAllVerticalBreaks

public void setAllVerticalBreaks(PageBreakPositionList allVerticalBreaks)

getAllVerticalBreaks

public PageBreakPositionList getAllVerticalBreaks()

computePageEnd

public long computePageEnd()

getPageName

public String getPageName()

setPageName

public void setPageName(String pageName)

getNodeType

public int getNodeType()

Overrides:

getNodeType in class BlockRenderBox

storeSaveInformation

public void storeSaveInformation()

rollbackSaveInformation

public void rollbackSaveInformation()

getProcessedTableOffset

public long getProcessedTableOffset()

setProcessedTableOffset

public void setProcessedTableOffset(long processedTableOffset)