| java.lang.Object
 org.apache.fop.layoutmgr.PageProvider
| PageProvider | | public class PageProvider implements Constants(Code) | | This class delivers Page instances. It also caches them as necessary.
Additional functionality makes sure that surplus instances that are requested by the
page breaker are properly discarded, especially in situations where hard breaks cause
blank pages. The reason for that: The page breaker sometimes needs to preallocate
additional pages since it doesn't know exactly until the end how many pages it really needs.
|
| Field Summary | |
| final public static int | RELTO_CURRENT_ELEMENT_LIST
Indices are evaluated relative to the first page in the current element list. | | final public static int | RELTO_PAGE_SEQUENCE
Indices are evaluated relative to the first page in the page-sequence. |
| Method Summary | |
| public int | getAvailableBPD(int index)
Returns the available BPD for the part/page indicated by the index parameter. | | public Page | getPage(boolean isBlank, int index, int relativeTo)
Returns a Page.
Parameters:
isBlank - true if this page is supposed to be blank.
Parameters:
index - Index of the page (see relativeTo)
Parameters:
relativeTo - Defines which value the index parameter should be evaluated relative to. | | protected Page | getPage(boolean isBlank, int index)
| | public int | getStartingPartIndexForLastPage(int partCount)
Returns the part index (0 | | public void | setLastPageIndex(int index)
Sets the index of the last page. | | public void | setStartOfNextElementList(int startPage, int startColumn)
The page breaker notifies the provider about the page number an element list starts
on so it can later retrieve PageViewports relative to this first page.
Parameters:
startPage - the number of the first page for the element list.
Parameters:
startColumn - the starting column number for the element list. |
| RELTO_CURRENT_ELEMENT_LIST | | final public static int RELTO_CURRENT_ELEMENT_LIST(Code) | | Indices are evaluated relative to the first page in the current element list.
|
| RELTO_PAGE_SEQUENCE | | final public static int RELTO_PAGE_SEQUENCE(Code) | | Indices are evaluated relative to the first page in the page-sequence.
|
| getAvailableBPD | | public int getAvailableBPD(int index)(Code) | | Returns the available BPD for the part/page indicated by the index parameter.
The index is the part/page relative to the start of the current element list.
This method takes multiple columns into account.
Parameters:
index - zero-based index of the requested part/page the available BPD |
| getPage | | public Page getPage(boolean isBlank, int index, int relativeTo)(Code) | | Returns a Page.
Parameters:
isBlank - true if this page is supposed to be blank.
Parameters:
index - Index of the page (see relativeTo)
Parameters:
relativeTo - Defines which value the index parameter should be evaluated relative to. (One of PageProvider.RELTO_*) the requested Page |
| getPage | | protected Page getPage(boolean isBlank, int index)(Code) | |
Parameters:
isBlank -
Parameters:
index - |
| getStartingPartIndexForLastPage | | public int getStartingPartIndexForLastPage(int partCount)(Code) | | Returns the part index (0Parameters:
partCount - Number of parts determined by the breaking algorithm the requested part index |
| setLastPageIndex | | public void setLastPageIndex(int index)(Code) | | Sets the index of the last page. This is done as soon as the position of the last page
is known or assumed.
Parameters:
index - the index relative to the first page in the page-sequence |
| setStartOfNextElementList | | public void setStartOfNextElementList(int startPage, int startColumn)(Code) | | The page breaker notifies the provider about the page number an element list starts
on so it can later retrieve PageViewports relative to this first page.
Parameters:
startPage - the number of the first page for the element list.
Parameters:
startColumn - the starting column number for the element list. |
|
|