Package org.apache.fop.area
Class AreaTreeModel
java.lang.Object
org.apache.fop.area.AreaTreeModel
- Direct Known Subclasses:
RenderPagesModel
This is the model for the area tree object.
The model implementation can handle the page sequence,
page and off-document items.
The methods to access the page viewports can only
assume the PageViewport is valid as it remains for
the life of the area tree model.
-
Field Summary
Modifier and TypeFieldDescriptionprotected PageSequence
the current page sequenceprotected static final org.apache.commons.logging.Log
logger instance -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addPage
(PageViewport page) Add a page to this model.void
Signal the end of the document for any processing.Returns the currently active page-sequence.getPage
(int seq, int count) Get the page for a position in the document.int
getPageCount
(int seq) Get the page count.int
Get the page sequence count.void
Handle an OffDocumentItemvoid
setDocumentLocale
(Locale locale) void
startPageSequence
(PageSequence pageSequence) Start a page sequence on this model.
-
Field Details
-
currentPageSequence
the current page sequence -
log
protected static final org.apache.commons.logging.Log loglogger instance
-
-
Constructor Details
-
AreaTreeModel
public AreaTreeModel()Create a new store pages model
-
-
Method Details
-
startPageSequence
Start a page sequence on this model.- Parameters:
pageSequence
- the page sequence about to start
-
addPage
Add a page to this model.- Parameters:
page
- the page to add to the model.
-
handleOffDocumentItem
Handle an OffDocumentItem- Parameters:
ext
- the extension to handle
-
endDocument
Signal the end of the document for any processing.- Throws:
SAXException
- if a problem was encountered.
-
getCurrentPageSequence
Returns the currently active page-sequence.- Returns:
- the currently active page-sequence
-
getPageSequenceCount
public int getPageSequenceCount()Get the page sequence count.- Returns:
- the number of page sequences in the document.
-
getPageCount
public int getPageCount(int seq) Get the page count.- Parameters:
seq
- the page sequence to count.- Returns:
- returns the number of pages in a page sequence
-
getPage
Get the page for a position in the document.- Parameters:
seq
- the page sequence numbercount
- the page count in the sequence- Returns:
- the PageViewport for the particular page
-
setDocumentLocale
- Parameters:
locale
- The locale of the document
-