java.awt.print

Interface Pageable

Known Implementing Classes:
Book

public interface Pageable

This interface represents pages that are to be printed.

Field Summary

static int
UNKNOWN_NUMBER_OF_PAGES
This constant is returned when getNumberOfPages() cannot determine the number of pages available for printing.

Method Summary

int
getNumberOfPages()
This method returns the number of pages this object contains, or UNKNOWN_NUMBER_OF_PAGES if it cannot determine the number of pages to be printed.
PageFormat
getPageFormat(int pageIndex)
This method returns the PageFormat instance for the specified page.
Printable
getPrintable(int pageIndex)
This method returns the Printable instance for the specified page.

Field Details

UNKNOWN_NUMBER_OF_PAGES

public static final int UNKNOWN_NUMBER_OF_PAGES
This constant is returned when getNumberOfPages() cannot determine the number of pages available for printing.
Field Value:
-1

Method Details

getNumberOfPages

public int getNumberOfPages()
This method returns the number of pages this object contains, or UNKNOWN_NUMBER_OF_PAGES if it cannot determine the number of pages to be printed.
Returns:
The number of pages to be printed, or UNKNOWN_NUMBER_OF_PAGES if this is unknown.

getPageFormat

public PageFormat getPageFormat(int pageIndex)
            throws IndexOutOfBoundsException
This method returns the PageFormat instance for the specified page. Page numbers start at zero. An exception is thrown if the requested page does not exist.
Parameters:
pageIndex - The index of the page to return the PageFormat for.
Returns:
The PageFormat for the requested page.
Throws:
IndexOutOfBoundsException - If the requested page number does not exist.

getPrintable

public Printable getPrintable(int pageIndex)
            throws IndexOutOfBoundsException
This method returns the Printable instance for the specified page. Page numbers start at zero. An exception is thrown if the requested page does not exist.
Parameters:
pageIndex - The index of the page to return the Printable for.
Returns:
The Printable for the requested page.
Throws:
IndexOutOfBoundsException - If the requested page number does not exist.

Pageable.java -- Pages to be printed Copyright (C) 1999, 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.