libjava/java/awt/print/Pageable.java

   1 /* Pageable.java -- Pages to be printed
   2    Copyright (C) 1999 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package java.awt.print;
  40
  41 /**
  42   * This interface represents pages that are to be printed.
  43   *
  44   * @author Aaron M. Renn (arenn@urbanophile.com)
  45   */
  46 public interface Pageable
  47 {
  48
  49 /*
  50  * Static Variables
  51  */
  52
  53 /**
  54   * This constant is returned when <code>getNumberOfPages()</code>
  55   * cannot determine the number of pages available for printing.
  56   */
  57 int UNKNOWN_NUMBER_OF_PAGES = -1;
  58
  59 /*************************************************************************/
  60
  61 /*
  62  * Instance Methods
  63  */
  64
  65 /**
  66   * This method returns the number of pages this object contains, or
  67   * <code>UNKNOWN_NUMBER_OF_PAGES</code> if it cannot determine the number
  68   * of pages to be printed.
  69   *
  70   * @return The number of pages to be printed, or
  71   * <code>UNKNOWN_NUMBER_OF_PAGES</code> if this is unknown.
  72   */
  73 int
  74 getNumberOfPages();
  75
  76 /*************************************************************************/
  77
  78 /**
  79   * This method returns the <code>PageFormat</code> instance for the
  80   * specified page.  Page numbers start at zero.  An exception is thrown if
  81   * the requested page does not exist.
  82   *
  83   * @param pageIndex The index of the page to return the
  84   * <code>PageFormat</code> for.
  85   *
  86   * @return The <code>PageFormat</code> for the requested page.
  87   *
  88   * @exception IndexOutOfBoundsException If the requested page number does
  89   * not exist.
  90   */
  91 PageFormat
  92 getPageFormat(int pageIndex) throws IndexOutOfBoundsException;
  93
  94 /*************************************************************************/
  95
  96 /**
  97   * This method returns the <code>Printable</code> instance for the
  98   * specified page.  Page numbers start at zero.  An exception is thrown if
  99   * the requested page does not exist.
 100   *
 101   * @param pageIndex The index of the page to return the
 102   * <code>Printable</code> for.
 103   *
 104   * @return The <code>Printable</code> for the requested page.
 105   *
 106   * @exception IndexOutOfBoundsException If the requested page number does
 107   * not exist.
 108   */
 109 Printable
 110 getPrintable(int pageIndex) throws IndexOutOfBoundsException;
 111
 112 } // interface Pageable
 113