001 /* Pageable.java -- Pages to be printed
002 Copyright (C) 1999, 2006 Free Software Foundation, Inc.
003
004 This file is part of GNU Classpath.
005
006 GNU Classpath is free software; you can redistribute it and/or modify
007 it under the terms of the GNU General Public License as published by
008 the Free Software Foundation; either version 2, or (at your option)
009 any later version.
010
011 GNU Classpath is distributed in the hope that it will be useful, but
012 WITHOUT ANY WARRANTY; without even the implied warranty of
013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014 General Public License for more details.
015
016 You should have received a copy of the GNU General Public License
017 along with GNU Classpath; see the file COPYING. If not, write to the
018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019 02110-1301 USA.
020
021 Linking this library statically or dynamically with other modules is
022 making a combined work based on this library. Thus, the terms and
023 conditions of the GNU General Public License cover the whole
024 combination.
025
026 As a special exception, the copyright holders of this library give you
027 permission to link this library with independent modules to produce an
028 executable, regardless of the license terms of these independent
029 modules, and to copy and distribute the resulting executable under
030 terms of your choice, provided that you also meet, for each linked
031 independent module, the terms and conditions of the license of that
032 module. An independent module is a module which is not derived from
033 or based on this library. If you modify this library, you may extend
034 this exception to your version of the library, but you are not
035 obligated to do so. If you do not wish to do so, delete this
036 exception statement from your version. */
037
038
039 package java.awt.print;
040
041 /**
042 * This interface represents pages that are to be printed.
043 *
044 * @author Aaron M. Renn (arenn@urbanophile.com)
045 */
046 public interface Pageable
047 {
048 /**
049 * This constant is returned when <code>getNumberOfPages()</code> cannot
050 * determine the number of pages available for printing.
051 */
052 int UNKNOWN_NUMBER_OF_PAGES = - 1;
053
054 /**
055 * This method returns the number of pages this object contains, or
056 * <code>UNKNOWN_NUMBER_OF_PAGES</code> if it cannot determine the number
057 * of pages to be printed.
058 *
059 * @return The number of pages to be printed, or
060 * <code>UNKNOWN_NUMBER_OF_PAGES</code> if this is unknown.
061 */
062 int getNumberOfPages();
063
064 /**
065 * This method returns the <code>PageFormat</code> instance for the
066 * specified page. Page numbers start at zero. An exception is thrown if the
067 * requested page does not exist.
068 *
069 * @param pageIndex The index of the page to return the
070 * <code>PageFormat</code> for.
071 * @return The <code>PageFormat</code> for the requested page.
072 * @exception IndexOutOfBoundsException If the requested page number does
073 * not exist.
074 */
075 PageFormat getPageFormat(int pageIndex) throws IndexOutOfBoundsException;
076
077 /**
078 * This method returns the <code>Printable</code> instance for the specified
079 * page. Page numbers start at zero. An exception is thrown if the requested
080 * page does not exist.
081 *
082 * @param pageIndex The index of the page to return the
083 * <code>Printable</code> for.
084 * @return The <code>Printable</code> for the requested page.
085 * @exception IndexOutOfBoundsException If the requested page number does
086 * not exist.
087 */
088 Printable getPrintable(int pageIndex) throws IndexOutOfBoundsException;
089
090 }