fop 0.92beta

org.apache.fop.area
Class AreaTreeModel

java.lang.Object
  |
  +--org.apache.fop.area.AreaTreeModel
Direct Known Subclasses:
RenderPagesModel

public class AreaTreeModel
extends java.lang.Object

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
protected  PageSequence currentPageSequence
          the current page sequence
protected static org.apache.commons.logging.Log log
           
 
Constructor Summary
AreaTreeModel()
          Create a new store pages model
 
Method Summary
 void addPage(PageViewport page)
          Add a page to this model.
 void endDocument()
          Signal the end of the document for any processing.
 PageViewport getPage(int seq, int count)
          Get the page for a position in the document.
 int getPageCount(int seq)
          Get the page count.
 int getPageSequenceCount()
          Get the page sequence count.
 void handleOffDocumentItem(OffDocumentItem ext)
          Handle an OffDocumentItem
 void startPageSequence(LineArea title)
          Start a page sequence on this model.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

currentPageSequence

protected PageSequence currentPageSequence
the current page sequence

log

protected static org.apache.commons.logging.Log log
Constructor Detail

AreaTreeModel

public AreaTreeModel()
Create a new store pages model
Method Detail

startPageSequence

public void startPageSequence(LineArea title)
Start a page sequence on this model.
Parameters:
title - the title of the new page sequence

addPage

public void addPage(PageViewport page)
Add a page to this model.
Parameters:
page - the page to add to the model.

handleOffDocumentItem

public void handleOffDocumentItem(OffDocumentItem ext)
Handle an OffDocumentItem
Parameters:
ext - the extension to handle

endDocument

public void endDocument()
                 throws org.xml.sax.SAXException
Signal the end of the document for any processing.
Throws:
org.xml.sax.SAXException - if a problem was encountered.

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

public PageViewport getPage(int seq,
                            int count)
Get the page for a position in the document.
Parameters:
seq - the page sequence number
count - the page count in the sequence
Returns:
the PageViewport for the particular page

fop 0.92beta

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