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

Field Summary

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

DIRECT_MANUAL_BREAK, INDIRECT_MANUAL_BREAK, NO_MANUAL_BREAK

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

LogicalPageBox(ReportDefinition report, StyleSheet style, BoxDefinition box)

Method Summary

Object	clone() Clones this node.
long	computePageEnd()
RenderNode	derive(boolean deepDerive) Derive creates a disconnected node that shares all the properties of the original node.
RenderNode	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)
BlockRenderBox	getRepeatFooterArea()
WatermarkAreaBox	getWatermarkArea()
RenderNode	hibernate() Derives an hibernation copy.
void	rollbackSaveInformation()
void	setAllVerticalBreaks(PageBreakPositionList allVerticalBreaks)
void	setPageEnd(long pageEnd)
void	setPageName(String pageName)
void	setPageOffset(long pageOffset)
void	storeSaveInformation()

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

close

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

addChild, addChilds, addGeneratedChild, addGeneratedChilds, clear, commitApplyMark, findNodeById, freeze, getAppliedContentRefCount, getBaselineInfo, getBoxDefinition, getBreakContext, getComputedWidth, getContentAge, getContentAreaX1, getContentAreaX2, getContentBox, getContentRefCount, getFirstChild, getInsets, getLastChild, getManualBreakIndicator, getName, getPinned, getStateKey, getStaticBoxLayoutProperties, getStaticBoxPropertiesAge, getTableExportState, getTextEllipseBox, isAppendable, isAppliedOpen, isAppliedSeen, isAutoGenerated, isBoxOverflowX, isBoxOverflowY, isBreakAfter, isCommited, isDeepFinished, isDiscardable, isEmpty, isMarkedOpen, isMarkedSeen, isOpen, isPinned, isSizeSpecifiesBorderBox, markBoxSeen, markCacheClean, markPinned, remove, removeGenerated, reopenAfterRollback, replaceChild, replaceChilds, resetCacheState, setAutoGenerated, setBaselineInfo, setBreakContext, setComputedWidth, setContentAge, setContentAreaX1, setContentAreaX2, setContentBox, setDeepFinished, setManualBreakIndicator, setMinimumChunkWidth, setName, setStaticBoxPropertiesAge, setTableExportState, setTextEllipseBox, split, toString

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

apply, getAttributes, getCachedAge, getCachedHeight, getCachedParentWidth, getCachedWidth, getCachedX, getCachedY, getCacheState, getChangeTracker, getEffectiveMarginBottom, getEffectiveMarginTop, getElementType, getHeight, getInstanceId, getMajorAxis, getMaximumBoxWidth, getMinimumChunkWidth, getMinorAxis, getNext, getNodeLayoutProperties, getParent, getPrev, getStyleSheet, getVerticalTextAlignment, getWidth, getX, getY, isBoxVisible, isBoxVisible, isCacheValid, isFinishedPaginate, isFinishedTable, isFrozen, isHibernated, isIgnorableForRendering, isNodeVisible, isNodeVisible, isNodeVisible, isNodeVisible, isVirtualNode, setCachedAge, setCachedHeight, setCachedParentWidth, setCachedWidth, setCachedX, setCachedY, setFinishedPaginate, setFinishedTable, setHeight, setMaximumBoxWidth, setVirtualNode, setWidth, setX, setY, shift, shiftCached

Methods inherited from class java.lang.Object

equals, 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 RenderNode 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 RenderNode 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:

hibernate

public RenderNode hibernate()

Derives an hibernation copy. The resulting object should get stripped of all unnecessary caching information and all objects, which will be regenerated when the layouting restarts. Size does matter here.

Overrides:

hibernate in class RenderBox

Returns:

clone

public Object 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()