org.apache.fop.area

Class PageSequence


public class PageSequence
extends java.lang.Object

Represents a page sequence in the area tree.

Constructor Summary

PageSequence(LineArea title)
Main constructor

Method Summary

void
addPage(PageViewport page)
Adds a new page to the page sequence
String
getCountry()
Returns the country of the page-sequence.
String
getLanguage()
Returns the language of the page-sequence.
PageViewport
getPage(int idx)
Returns the page at the given index.
int
getPageCount()
LineArea
getTitle()
boolean
isFirstPage(PageViewport page)
Indicates whether a page is the first in this page sequence.
void
setCountry(String country)
Sets the country that applies to this page-sequence.
void
setLanguage(String language)
Sets the language that applies to this page-sequence.
void
setTitle(LineArea title)
Sets the page sequence's title.

Constructor Details

PageSequence

public PageSequence(LineArea title)
Main constructor
Parameters:
title - the title for the page-sequence, may be null

Method Details

addPage

public void addPage(PageViewport page)
Adds a new page to the page sequence
Parameters:
page - the page to be added

getCountry

public String getCountry()
Returns the country of the page-sequence.
Returns:
the country (the value of the country property, "none" is mapped to null)

getLanguage

public String getLanguage()
Returns the language of the page-sequence.
Returns:
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.
Parameters:
idx - the index of the requested page
Returns:
the requested page or null if it was not found

getPageCount

public int getPageCount()
Returns:
the number of pages currently in this page sequence

getTitle

public LineArea getTitle()
Returns:
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.
Parameters:
page - the page to be inspected
Returns:
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.
Parameters:
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.
Parameters:
language - the language to set ("none" is mapped to null)

setTitle

public void setTitle(LineArea title)
Sets the page sequence's title.
Parameters:
title - the title

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