org.apache.fop.area

Class Page

Implemented Interfaces:
Cloneable, Serializable

public class Page
extends AreaTreeObject
implements Serializable, Cloneable

The page. This holds the contents of the page. Each region is added. The unresolved references area added so that if the page is serialized then it will handle the resolving properly after being reloaded. This is serializable so it can be saved to cache to save memory if there are forward references. The page is cloneable so the page master can make copies of the top level page and regions.

Field Summary

Fields inherited from class org.apache.fop.area.AreaTreeObject

foreignAttributes

Constructor Summary

Page()
Empty constructor, for cloning
Page(SimplePageMaster spm)
Constructor

Method Summary

Object
clone()
Clone this page.
void
fakeNonEmpty()
Call this method to force this page to pretend not to be empty.
RegionViewport
getRegionViewport(int areaclass)
Get the region from this page.
Map
getUnresolvedReferences()
Get the map unresolved references from this page.
boolean
isEmpty()
indicates whether any FOs have been added to the body region
void
setRegionViewport(int areaclass, RegionViewport port)
Set the region on this page.
void
setUnresolvedReferences(Map unres)
Set the unresolved references on this page for serializing.

Methods inherited from class org.apache.fop.area.AreaTreeObject

getForeignAttributeValue, getForeignAttributes, setForeignAttribute, setForeignAttributes

Constructor Details

Page

public Page()
Empty constructor, for cloning

Page

public Page(SimplePageMaster spm)
Constructor
Parameters:
spm - SimplePageMaster containing the dimensions for this page-reference-area

Method Details

clone

public Object clone()
Clone this page. This returns a new page with a clone of all the regions.
Returns:
a new clone of this page

fakeNonEmpty

public void fakeNonEmpty()
Call this method to force this page to pretend not to be empty.

getRegionViewport

public RegionViewport getRegionViewport(int areaclass)
Get the region from this page.
Parameters:
areaclass - the region area class
Returns:
the region viewport or null if none

getUnresolvedReferences

public Map getUnresolvedReferences()
Get the map unresolved references from this page. This should be called after deserializing to retrieve the map of unresolved references that were serialized.
Returns:
the de-serialized HashMap of unresolved objects

isEmpty

public boolean isEmpty()
indicates whether any FOs have been added to the body region
Returns:
whether any FOs have been added to the body region

setRegionViewport

public void setRegionViewport(int areaclass,
                              RegionViewport port)
Set the region on this page.
Parameters:
areaclass - the area class of the region to set
port - the region viewport to set

setUnresolvedReferences

public void setUnresolvedReferences(Map unres)
Set the unresolved references on this page for serializing.
Parameters:
unres - the Map of unresolved objects

Copyright 1999-2007 The Apache Software Foundation. All Rights Reserved.