libjava/java/awt/print/PrinterJob.java

   1 /* PrinterJob.java -- This job is the printer control class
   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 class controls printing.
  43   *
  44   * @author Aaron M. Renn (arenn@urbanophile.com)
  45   */
  46 public abstract class PrinterJob
  47 {
  48
  49 /*
  50  * Class Methods
  51  */
  52
  53 /**
  54   * Creates a new print job.
  55   *
  56   * @return A <code>PrinterJob</code> object for the newly created print job.
  57   */
  58 public static PrinterJob
  59 getPrinterJob()
  60 {
  61   // FIXME: Need to fix this to load a default implementation instance.
  62   return(null);
  63 }
  64
  65 /*************************************************************************/
  66
  67 /*
  68  * Constructors
  69  */
  70
  71 /**
  72   * Initializes a new instance of <code>PrinterJob</code>.
  73   */
  74 public
  75 PrinterJob()
  76 {
  77   ;
  78 }
  79
  80 /*************************************************************************/
  81
  82 /*
  83  * Instance Methods
  84  */
  85
  86 /**
  87   * Returns the number of copies to be printed.
  88   *
  89   * @return The number of copies to be printed.
  90   */
  91 public abstract int
  92 getCopies();
  93
  94 /*************************************************************************/
  95
  96 /**
  97   * Sets the number of copies to be printed.
  98   *
  99   * @param copies The number of copies to be printed.
 100   */
 101 public abstract void
 102 setCopies();
 103
 104 /*************************************************************************/
 105
 106 /**
 107   * Returns the name of the print job.
 108   *
 109   * @return The name of the print job.
 110   */
 111 public abstract String
 112 getJobName();
 113
 114 /*************************************************************************/
 115
 116 /**
 117   * Sets the name of the print job.
 118   *
 119   * @param job_name The name of the print job.
 120   */
 121 public abstract void setJobName (String job_name);
 122
 123 /*************************************************************************/
 124
 125 /**
 126   * Returns the printing user name.
 127   *
 128   * @return The printing username.
 129   */
 130 public abstract String
 131 getUserName();
 132
 133 /*************************************************************************/
 134
 135 /**
 136   * Cancels an in progress print job.
 137   */
 138 public abstract void
 139 cancel();
 140
 141 /*************************************************************************/
 142
 143 /**
 144   * Tests whether or not this job has been cancelled.
 145   *
 146   * @param <code>true</code> if this job has been cancelled, <code>false</code>
 147   * otherwise.
 148   */
 149 public abstract boolean
 150 isCancelled();
 151
 152 /*************************************************************************/
 153
 154 /**
 155   * Returns an instance of the default page which will have the default
 156   * paper and orientation.
 157   *
 158   * @return A default instance of <code>PageFormat</code>.
 159   */
 160 public PageFormat
 161 defaultPage()
 162 {
 163   return(new PageFormat());
 164 }
 165
 166 /*************************************************************************/
 167
 168 /**
 169   * Clones the specified <code>PageFormat</code> object then alters the
 170   * clone so that it represents the default page format.
 171   *
 172   * @param page_format The <code>PageFormat</code> to clone.
 173   *
 174   * @return A new default page format.
 175   */
 176 public abstract PageFormat
 177 defaultPage(PageFormat page_format);
 178
 179 /*************************************************************************/
 180
 181 /**
 182   * Displays a dialog box to the user which allows the page format
 183   * attributes to be modified.
 184   *
 185   * @param page_format The <code>PageFormat</code> object to modify.
 186   *
 187   * @return The modified <code>PageFormat</code>.
 188   */
 189 public abstract PageFormat
 190 pageDialog(PageFormat page_format);
 191
 192 /*************************************************************************/
 193
 194 /**
 195   * Prints the pages.
 196   */
 197 public abstract void print () throws PrinterException;
 198
 199 /**
 200   * Displays a dialog box to the user which allows the print job
 201   * attributes to be modified.
 202   *
 203   * @return <code>false</code> if the user cancels the dialog box,
 204   * <code>true</code> otherwise.
 205   */
 206 public abstract boolean
 207 printDialog();
 208
 209 /*************************************************************************/
 210
 211 /**
 212   * This sets the pages that are to be printed.
 213   *
 214   * @param pageable The pages to be printed, which may not be <code>null</code>.
 215   */
 216 public abstract void
 217 setPageable(Pageable pageable);
 218
 219 /*************************************************************************/
 220
 221 /**
 222   * Sets this specified <code>Printable</code> as the one to use for
 223   * rendering the pages on the print device.
 224   *
 225   * @param printable The <code>Printable</code> for the print job.
 226   */
 227 public abstract void
 228 setPrintable(Printable printable);
 229
 230 /*************************************************************************/
 231
 232 /**
 233   * Sets the <code>Printable</code> and the page format for the pages
 234   * to be printed.
 235   *
 236   * @param printable The <code>Printable</code> for the print job.
 237   * @param page_format The <code>PageFormat</code> for the print job.
 238   */
 239 public abstract void
 240 setPrintable(Printable printable, PageFormat page_format);
 241
 242 /*************************************************************************/
 243
 244 /**
 245   * Makes any alterations to the specified <code>PageFormat</code>
 246   * necessary to make it work with the current printer.  The alterations
 247   * are made to a clone of the input object, which is then returned.
 248   *
 249   * @param page_format The <code>PageFormat</code> to validate.
 250   *
 251   * @return The validated <code>PageFormat</code>.
 252   */
 253 public abstract PageFormat
 254 validatePage(PageFormat page);
 255
 256 } // class PrinterJob
 257