org.jfree.layouting.renderer.model.page

Class LogicalPageBox

public class LogicalPageBox extends BlockRenderBox

The logical page box does not have a layout at all. It has collection of flows, one for each logical page area.

Each logical page has a header (for the repeating group headers, not to be mistaken as PageHeader!), content and footer area. The footer area contains the foot-notes at the very bottom, the repeatable footer area and finally the flow:bottom area.

The flow- and repeatable areas behave like stacks, and are filled from the content area (so for headers, new content goes after any previous content, and for footers, new content goes before any previous content.)

The footNotes section is always filled in the normal-order, so new content gets added at the bottom of that area.

The logical page also holds the absolutely and static positioned elements. These elements may overlap the repeating headers, but will never overlap the physical page header or footer.

The logical page is also the container for all physical pages. (The sizes of the physical pages influence the available space on the logical pages.)

Layout notes: The logical page, as it is implemented now, consists of three areas. The header and footer areas are plain banded areas and correspond to the @top and @bottom page-areas. These areas are layouted zero-based. The header's y=0 corresponds to the beginning of the page, while the footer's y=0 depends on the total height of the footer and must fullfill the following constraint: Page_bottom_edge = (footer_y + footer_height).

The content window is positioned relative to the content-flow and is placed between the header and the footer. The mapping of the content into the header is defined by the pageOffset. The content-window's y=0 corresponds to the normal-flow's y=pageOffset.

Repeatable headers and footers are *not* inserted into the content-flow.

Author: Thomas Morgner

Constructor Summary
LogicalPageBox(PageGrid pageGrid)
Method Summary
voidappyStyle(LayoutContext context, OutputProcessorMetaData metaData)
Objectclone()
Clones this node.
RenderNodederive(boolean deepDerive)
Derive creates a disconnected node that shares all the properties of the original node.
RenderNodederiveFrozen(boolean deepDerive)
Derive creates a disconnected node that shares all the properties of the original node.
RenderNodefindNodeById(Object instanceId)
NormalFlowRenderBoxgetContentArea()
PageAreaRenderBoxgetFooterArea()
PageAreaRenderBoxgetHeaderArea()
RenderBoxgetInsertationPoint()
LogicalPageBoxgetLogicalPage()
NormalFlowRenderBoxgetNormalFlow()
PageGridgetPageGrid()
longgetPageHeight()
longgetPageOffset()
longgetPageWidth()
long[]getPhysicalBreaks(int axis)
RenderNodehibernate()
Derives an hibernation copy.
voidinsertFirst(RenderNode node)
voidinsertLast(RenderNode node)
booleanisNormalFlowActive()
booleanisOverflow()
voidsetNormalFlowActive(boolean normalFlowActive)
voidsetPageOffset(long pageOffset)
voidupdatePageArea(PageGrid pageGrid)

Constructor Detail

LogicalPageBox

public LogicalPageBox(PageGrid pageGrid)

Method Detail

appyStyle

public void appyStyle(LayoutContext context, OutputProcessorMetaData metaData)

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.

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.

Returns:

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.

Returns:

findNodeById

public RenderNode findNodeById(Object instanceId)

getContentArea

public NormalFlowRenderBox getContentArea()

getFooterArea

public PageAreaRenderBox getFooterArea()

getHeaderArea

public PageAreaRenderBox getHeaderArea()

getInsertationPoint

public RenderBox getInsertationPoint()

getLogicalPage

public LogicalPageBox getLogicalPage()

getNormalFlow

public NormalFlowRenderBox getNormalFlow()

getPageGrid

public PageGrid getPageGrid()

getPageHeight

public long getPageHeight()

getPageOffset

public long getPageOffset()

getPageWidth

public long getPageWidth()

getPhysicalBreaks

public long[] getPhysicalBreaks(int axis)

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.

Returns:

insertFirst

public void insertFirst(RenderNode node)

insertLast

public void insertLast(RenderNode node)

isNormalFlowActive

public boolean isNormalFlowActive()

isOverflow

public boolean isOverflow()

setNormalFlowActive

public void setNormalFlowActive(boolean normalFlowActive)

setPageOffset

public void setPageOffset(long pageOffset)

updatePageArea

public void updatePageArea(PageGrid pageGrid)