fop 0.95

org.apache.fop.area
Class PageSequence

java.lang.Object
  extended by org.apache.fop.area.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
 java.lang.String getCountry()
          Returns the country of the page-sequence.
 java.lang.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(java.lang.String country)
          Sets the country that applies to this page-sequence.
 void setLanguage(java.lang.String language)
          Sets the language that applies to this page-sequence.
 void setTitle(LineArea title)
          Sets the page sequence's title.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PageSequence

public PageSequence(LineArea title)
Main constructor

Parameters:
title - the title for the page-sequence, may be null
Method Detail

getTitle

public LineArea getTitle()
Returns:
the title of the page sequence in form of a line area, or null if there's no title

setTitle

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

Parameters:
title - the title

addPage

public void addPage(PageViewport page)
Adds a new page to the page sequence

Parameters:
page - the page to be added

getPageCount

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

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

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

getLanguage

public java.lang.String getLanguage()
Returns the language of the page-sequence.

Returns:
the language (the value of the language property, "none" is mapped to null)

setLanguage

public void setLanguage(java.lang.String language)
Sets the language that applies to this page-sequence.

Parameters:
language - the language to set ("none" is mapped to null)

getCountry

public java.lang.String getCountry()
Returns the country of the page-sequence.

Returns:
the country (the value of the country property, "none" is mapped to null)

setCountry

public void setCountry(java.lang.String country)
Sets the country that applies to this page-sequence.

Parameters:
country - the country to set ("none" is mapped to null)

fop 0.95

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