org.apache.fop.area
Class PageSequence
java.lang.Object
org.apache.fop.area.PageSequence
public class PageSequence
extends java.lang.Object
Represents a page sequence in the area tree.
PageSequence
public PageSequence(LineArea title)
Main constructor
title
- the title for the page-sequence, may be null
addPage
public void addPage(PageViewport page)
Adds a new page to the page sequence
page
- the page to be added
getCountry
public String getCountry()
Returns the country of the page-sequence.
- the country (the value of the country property, "none" is mapped to null)
getLanguage
public String getLanguage()
Returns the language of the page-sequence.
- the language (the value of the language property, "none" is mapped to null)
getPage
public PageViewport getPage(int idx)
Returns the page at the given index.
idx
- the index of the requested page
- the requested page or null if it was not found
getPageCount
public int getPageCount()
- the number of pages currently in this page sequence
getTitle
public LineArea getTitle()
- the title of the page sequence in form of a line area, or null if there's no title
isFirstPage
public boolean isFirstPage(PageViewport page)
Indicates whether a page is the first in this page sequence.
page
- the page to be inspected
- true if the page is the first in this page sequence, false otherwise
setCountry
public void setCountry(String country)
Sets the country that applies to this page-sequence.
country
- the country to set ("none" is mapped to null)
setLanguage
public void setLanguage(String language)
Sets the language that applies to this page-sequence.
language
- the language to set ("none" is mapped to null)
setTitle
public void setTitle(LineArea title)
Sets the page sequence's title.
Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.