Package org.apache.fop.area
Class PageSequence
java.lang.Object
org.apache.fop.area.AreaTreeObject
org.apache.fop.area.PageSequence
- All Implemented Interfaces:
Cloneable
Represents a page sequence in the area tree.
-
Field Summary
Fields inherited from class org.apache.fop.area.AreaTreeObject
extensionAttachments, foreignAttributes
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addPage
(PageViewport page) Adds a new page to the page sequenceReturns the locale of this page-sequence.getPage
(int idx) Returns the page at the given index.int
getTitle()
boolean
isFirstPage
(PageViewport page) Indicates whether a page is the first in this page sequence.void
Sets the locale that applies to this page-sequence.void
Sets the page sequence's title.Methods inherited from class org.apache.fop.area.AreaTreeObject
addExtensionAttachment, clone, getExtensionAttachments, getForeignAttributes, getForeignAttributeValue, hasExtensionAttachments, setExtensionAttachments, setForeignAttribute, setForeignAttributes
-
Constructor Details
-
PageSequence
Main constructor- Parameters:
title
- the title for the page-sequence, may be null
-
-
Method Details
-
getTitle
- Returns:
- the title of the page sequence in form of a line area, or null if there's no title
-
setTitle
Sets the page sequence's title.- Parameters:
title
- the title
-
addPage
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
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
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
-
setLocale
Sets the locale that applies to this page-sequence.- Parameters:
locale
- the locale to set
-
getLocale
Returns the locale of this page-sequence.- Returns:
- the locale,
null
if not set
-