Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Java Platform 1.2
Beta 4

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Interface java.awt.print.Pageable

All Known Implementing Classes:

Book

public abstract interface Pageable

A Pageable implementation represents a set of pages to be printed. The Pageable object returns the total number of pages in the set as well as the PageFormat and Printable for a given page.

See Also:

PageFormat, Printable

Field Summary

static int

UNKNOWN_NUMBER_OF_PAGES If a Pageable implementation does not know the number of pages in its set, then this constant should be returned from the getNumberOfPages() method.

Method Summary

int	getNumberOfPages() Returns the number of pages in the set.
PageFormat	getPageFormat(int pageIndex) Return the PageFormat of the page specified by 'pageIndex'.
Printable	getPrintable(int pageIndex) Return the Printable instance responsible for rendering the page specified by 'pageIndex'.

Field Detail

UNKNOWN_NUMBER_OF_PAGES

public static final int UNKNOWN_NUMBER_OF_PAGES

If a Pageable implementation does not know the number of pages in its set, then this constant should be returned from the getNumberOfPages() method.

Method Detail

getNumberOfPages

public int getNumberOfPages()

Returns the number of pages in the set. To enable advanced printing features, it is recommended that Pageable implementations return the true number of pages rather than the UNKNOWN_NUMBER_OF_PAGES constant.

getPageFormat

public PageFormat getPageFormat(int pageIndex)
                         throws IndexOutOfBoundsException

Return the PageFormat of the page specified by 'pageIndex'.

Parameters:

int - The zero based index of the page whose PageFormat is being requested.

Returns:

The PageFormat describing the size and orientation

Throws:

IndexOutOfBoundsException - the Pageable does not contain the requested page.

getPrintable

public Printable getPrintable(int pageIndex)
                       throws IndexOutOfBoundsException

Return the Printable instance responsible for rendering the page specified by 'pageIndex'.

Parameters:

int - The zero based index of the page whose Printable is being requested.

Returns:

The Printable that will draw the page.

Throws:

IndexOutOfBoundsException - the Pageable does not contain the requested page.