| org.jfree.report.PageDefinition
All known Subclasses: org.jfree.report.SimplePageDefinition, org.jfree.report.CustomPageDefinition,
| PageDefinition | | public interface PageDefinition extends Cloneable,Serializable(Code) | | A logical page definition for a report.
Page oriented reports use the page definition to distribute the content of one logical page to the physical pages.
The order of the physical pages in the page definition defines the content order in the generated documents.
Flow oriented reports will use the page-definitions width as default width for the layouting.
If a logical page is completly empty, it will be removed from the report and a pageCanceled event is fired. If a
physical page within a non empty logical page is empty, if depends on the ReportProcessor whether the page is printed
as empty page or whether it will be removed from the report.
Areas of the logical page not covered by the physical pages will not cause errors, the content in these areas will be
ignored and not printed.
Page definitions must not be changed during the report processing, or funny things will happen.
author:
Thomas Morgner |
| Method Summary | |
| public Object | clone()
Creates a copy of the page definition. | | public float | getHeight()
Returns the total height of the logical page. | | public int | getPageCount()
Returns the number of physical pages in this logical page definition. | | public PageFormat | getPageFormat(int pos)
Returns the page format for the given page number. | | public Rectangle2D | getPagePosition(int index)
Describes the internal position of the given page within the logical page. | | public Rectangle2D[] | getPagePositions()
Returns all page positions as array. | | public float | getWidth()
Returns the total width of the logical page. |
| getHeight | | public float getHeight()(Code) | | Returns the total height of the logical page.
the height of the page. |
| getPageCount | | public int getPageCount()(Code) | | Returns the number of physical pages in this logical page definition.
the number of physical pages in the page definition. |
| getPageFormat | | public PageFormat getPageFormat(int pos)(Code) | | Returns the page format for the given page number. The page format contains local coordinates - that means that the
point (0,0) denotes the upper left corner of this returned page format and not global coordinates.
Parameters:
pos - the position of the pageformat within the page the given pageformat. |
| getPagePosition | | public Rectangle2D getPagePosition(int index)(Code) | | Describes the internal position of the given page within the logical page. The logical page does not include any
page margins, the printable area for a page starts at (0,0).
Parameters:
index - the index of the physical pageformat the bounds for the page. |
| getWidth | | public float getWidth()(Code) | | Returns the total width of the logical page.
the width of the page. |
|
|