1 /*
   2  * Copyright (c) 1998, 2014, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package sun.print;
  27 
  28 import java.io.FilePermission;
  29 
  30 import java.awt.Color;
  31 import java.awt.Dialog;
  32 import java.awt.Frame;
  33 import java.awt.Graphics;
  34 import java.awt.Graphics2D;
  35 import java.awt.GraphicsConfiguration;
  36 import java.awt.GraphicsEnvironment;
  37 import java.awt.HeadlessException;
  38 import java.awt.KeyboardFocusManager;
  39 import java.awt.Rectangle;
  40 import java.awt.Shape;
  41 import java.awt.geom.AffineTransform;
  42 import java.awt.geom.Area;
  43 import java.awt.geom.Point2D;
  44 import java.awt.geom.Rectangle2D;
  45 import java.awt.image.BufferedImage;
  46 import java.awt.print.Book;
  47 import java.awt.print.Pageable;
  48 import java.awt.print.PageFormat;
  49 import java.awt.print.Paper;
  50 import java.awt.print.Printable;
  51 import java.awt.print.PrinterAbortException;
  52 import java.awt.print.PrinterException;
  53 import java.awt.print.PrinterJob;
  54 import java.awt.Window;
  55 import java.io.File;
  56 import java.io.IOException;
  57 import java.util.ArrayList;
  58 import java.util.Enumeration;
  59 import java.util.Locale;
  60 import sun.awt.image.ByteInterleavedRaster;
  61 
  62 import javax.print.Doc;
  63 import javax.print.DocFlavor;
  64 import javax.print.DocPrintJob;
  65 import javax.print.PrintException;
  66 import javax.print.PrintService;
  67 import javax.print.PrintServiceLookup;
  68 import javax.print.ServiceUI;
  69 import javax.print.StreamPrintService;
  70 import javax.print.StreamPrintServiceFactory;
  71 import javax.print.attribute.Attribute;
  72 import javax.print.attribute.AttributeSet;
  73 import javax.print.attribute.HashPrintRequestAttributeSet;
  74 import javax.print.attribute.PrintRequestAttributeSet;
  75 import javax.print.attribute.ResolutionSyntax;
  76 import javax.print.attribute.Size2DSyntax;
  77 import javax.print.attribute.standard.Chromaticity;
  78 import javax.print.attribute.standard.Copies;
  79 import javax.print.attribute.standard.Destination;
  80 import javax.print.attribute.standard.DialogTypeSelection;
  81 import javax.print.attribute.standard.Fidelity;
  82 import javax.print.attribute.standard.JobName;
  83 import javax.print.attribute.standard.JobSheets;
  84 import javax.print.attribute.standard.Media;
  85 import javax.print.attribute.standard.MediaPrintableArea;
  86 import javax.print.attribute.standard.MediaSize;
  87 import javax.print.attribute.standard.MediaSizeName;
  88 import javax.print.attribute.standard.OrientationRequested;
  89 import javax.print.attribute.standard.PageRanges;
  90 import javax.print.attribute.standard.PrinterResolution;
  91 import javax.print.attribute.standard.PrinterState;
  92 import javax.print.attribute.standard.PrinterStateReason;
  93 import javax.print.attribute.standard.PrinterStateReasons;
  94 import javax.print.attribute.standard.PrinterIsAcceptingJobs;
  95 import javax.print.attribute.standard.RequestingUserName;
  96 import javax.print.attribute.standard.SheetCollate;
  97 import javax.print.attribute.standard.Sides;
  98 
  99 import sun.print.PageableDoc;
 100 import sun.print.ServiceDialog;
 101 import sun.print.SunPrinterJobService;
 102 import sun.print.SunPageSelection;
 103 
 104 /**
 105  * A class which rasterizes a printer job.
 106  *
 107  * @author Richard Blanchard
 108  */
 109 public abstract class RasterPrinterJob extends PrinterJob {
 110 
 111  /* Class Constants */
 112 
 113      /* Printer destination type. */
 114     protected static final int PRINTER = 0;
 115 
 116      /* File destination type.  */
 117     protected static final int FILE = 1;
 118 
 119     /* Stream destination type.  */
 120     protected static final int STREAM = 2;
 121 
 122     /**
 123      * Pageable MAX pages
 124      */
 125     protected static final int MAX_UNKNOWN_PAGES = 9999;
 126 
 127     protected static final int PD_ALLPAGES = 0x00000000;
 128     protected static final int PD_SELECTION = 0x00000001;
 129     protected static final int PD_PAGENUMS = 0x00000002;
 130     protected static final int PD_NOSELECTION = 0x00000004;
 131 
 132     /**
 133      * Maximum amount of memory in bytes to use for the
 134      * buffered image "band". 4Mb is a compromise between
 135      * limiting the number of bands on hi-res printers and
 136      * not using too much of the Java heap or causing paging
 137      * on systems with little RAM.
 138      */
 139     private static final int MAX_BAND_SIZE = (1024 * 1024 * 4);
 140 
 141     /* Dots Per Inch */
 142     private static final float DPI = 72.0f;
 143 
 144     /**
 145      * Useful mainly for debugging, this system property
 146      * can be used to force the printing code to print
 147      * using a particular pipeline. The two currently
 148      * supported values are FORCE_RASTER and FORCE_PDL.
 149      */
 150     private static final String FORCE_PIPE_PROP = "sun.java2d.print.pipeline";
 151 
 152     /**
 153      * When the system property FORCE_PIPE_PROP has this value
 154      * then each page of a print job will be rendered through
 155      * the raster pipeline.
 156      */
 157     private static final String FORCE_RASTER = "raster";
 158 
 159     /**
 160      * When the system property FORCE_PIPE_PROP has this value
 161      * then each page of a print job will be rendered through
 162      * the PDL pipeline.
 163      */
 164     private static final String FORCE_PDL = "pdl";
 165 
 166     /**
 167      * When the system property SHAPE_TEXT_PROP has this value
 168      * then text is always rendered as a shape, and no attempt is made
 169      * to match the font through GDI
 170      */
 171     private static final String SHAPE_TEXT_PROP = "sun.java2d.print.shapetext";
 172 
 173     /**
 174      * values obtained from System properties in static initialiser block
 175      */
 176     public static boolean forcePDL = false;
 177     public static boolean forceRaster = false;
 178     public static boolean shapeTextProp = false;
 179 
 180     static {
 181         /* The system property FORCE_PIPE_PROP
 182          * can be used to force the printing code to
 183          * use a particular pipeline. Either the raster
 184          * pipeline or the pdl pipeline can be forced.
 185          */
 186         String forceStr = java.security.AccessController.doPrivileged(
 187                    new sun.security.action.GetPropertyAction(FORCE_PIPE_PROP));
 188 
 189         if (forceStr != null) {
 190             if (forceStr.equalsIgnoreCase(FORCE_PDL)) {
 191                 forcePDL = true;
 192             } else if (forceStr.equalsIgnoreCase(FORCE_RASTER)) {
 193                 forceRaster = true;
 194             }
 195         }
 196 
 197         String shapeTextStr =java.security.AccessController.doPrivileged(
 198                    new sun.security.action.GetPropertyAction(SHAPE_TEXT_PROP));
 199 
 200         if (shapeTextStr != null) {
 201             shapeTextProp = true;
 202         }
 203     }
 204 
 205     /* Instance Variables */
 206 
 207     /**
 208      * Used to minimize GC & reallocation of band when printing
 209      */
 210     private int cachedBandWidth = 0;
 211     private int cachedBandHeight = 0;
 212     private BufferedImage cachedBand = null;
 213 
 214     /**
 215      * The number of book copies to be printed.
 216      */
 217     private int mNumCopies = 1;
 218 
 219     /**
 220      * Collation effects the order of the pages printed
 221      * when multiple copies are requested. For two copies
 222      * of a three page document the page order is:
 223      *  mCollate true: 1, 2, 3, 1, 2, 3
 224      *  mCollate false: 1, 1, 2, 2, 3, 3
 225      */
 226     private boolean mCollate = false;
 227 
 228     /**
 229      * The zero based indices of the first and last
 230      * pages to be printed. If 'mFirstPage' is
 231      * UNDEFINED_PAGE_NUM then the first page to
 232      * be printed is page 0. If 'mLastPage' is
 233      * UNDEFINED_PAGE_NUM then the last page to
 234      * be printed is the last one in the book.
 235      */
 236     private int mFirstPage = Pageable.UNKNOWN_NUMBER_OF_PAGES;
 237     private int mLastPage = Pageable.UNKNOWN_NUMBER_OF_PAGES;
 238 
 239     /**
 240      * The previous print stream Paper
 241      * Used to check if the paper size has changed such that the
 242      * implementation needs to emit the new paper size information
 243      * into the print stream.
 244      * Since we do our own rotation, and the margins aren't relevant,
 245      * Its strictly the dimensions of the paper that we will check.
 246      */
 247     private Paper previousPaper;
 248 
 249     /**
 250      * The document to be printed. It is initialized to an
 251      * empty (zero pages) book.
 252      */
 253 // MacOSX - made protected so subclasses can reference it.
 254     protected Pageable mDocument = new Book();
 255 
 256     /**
 257      * The name of the job being printed.
 258      */
 259     private String mDocName = "Java Printing";
 260 
 261 
 262     /**
 263      * Printing cancellation flags
 264      */
 265  // MacOSX - made protected so subclasses can reference it.
 266     protected boolean performingPrinting = false;
 267  // MacOSX - made protected so subclasses can reference it.
 268     protected boolean userCancelled = false;
 269 
 270    /**
 271     * Print to file permission variables.
 272     */
 273     private FilePermission printToFilePermission;
 274 
 275     /**
 276      * List of areas & the graphics state for redrawing
 277      */
 278     private ArrayList<GraphicsState> redrawList = new ArrayList<>();
 279 
 280 
 281     /* variables representing values extracted from an attribute set.
 282      * These take precedence over values set on a printer job
 283      */
 284     private int copiesAttr;
 285     private String jobNameAttr;
 286     private String userNameAttr;
 287     private PageRanges pageRangesAttr;
 288     protected PrinterResolution printerResAttr;
 289     protected Sides sidesAttr;
 290     protected String destinationAttr;
 291     protected boolean noJobSheet = false;
 292     protected int mDestType = RasterPrinterJob.FILE;
 293     protected String mDestination = "";
 294     protected boolean collateAttReq = false;
 295 
 296     /**
 297      * Device rotation flag, if it support 270, this is set to true;
 298      */
 299     protected boolean landscapeRotates270 = false;
 300 
 301    /**
 302      * attributes used by no-args page and print dialog and print method to
 303      * communicate state
 304      */
 305     protected PrintRequestAttributeSet attributes = null;
 306 
 307     /**
 308      * Class to keep state information for redrawing areas
 309      * "region" is an area at as a high a resolution as possible.
 310      * The redrawing code needs to look at sx, sy to calculate the scale
 311      * to device resolution.
 312      */
 313     private class GraphicsState {
 314         Rectangle2D region;  // Area of page to repaint
 315         Shape theClip;       // image drawing clip.
 316         AffineTransform theTransform; // to transform clip to dev coords.
 317         double sx;           // X scale from region to device resolution
 318         double sy;           // Y scale from region to device resolution
 319     }
 320 
 321     /**
 322      * Service for this job
 323      */
 324     protected PrintService myService;
 325 
 326  /* Constructors */
 327 
 328     public RasterPrinterJob()
 329     {
 330     }
 331 
 332 /* Abstract Methods */
 333 
 334     /**
 335      * Returns the resolution in dots per inch across the width
 336      * of the page.
 337      */
 338     protected abstract double getXRes();
 339 
 340     /**
 341      * Returns the resolution in dots per inch down the height
 342      * of the page.
 343      */
 344     protected abstract double getYRes();
 345 
 346     /**
 347      * Must be obtained from the current printer.
 348      * Value is in device pixels.
 349      * Not adjusted for orientation of the paper.
 350      */
 351     protected abstract double getPhysicalPrintableX(Paper p);
 352 
 353     /**
 354      * Must be obtained from the current printer.
 355      * Value is in device pixels.
 356      * Not adjusted for orientation of the paper.
 357      */
 358     protected abstract double getPhysicalPrintableY(Paper p);
 359 
 360     /**
 361      * Must be obtained from the current printer.
 362      * Value is in device pixels.
 363      * Not adjusted for orientation of the paper.
 364      */
 365     protected abstract double getPhysicalPrintableWidth(Paper p);
 366 
 367     /**
 368      * Must be obtained from the current printer.
 369      * Value is in device pixels.
 370      * Not adjusted for orientation of the paper.
 371      */
 372     protected abstract double getPhysicalPrintableHeight(Paper p);
 373 
 374     /**
 375      * Must be obtained from the current printer.
 376      * Value is in device pixels.
 377      * Not adjusted for orientation of the paper.
 378      */
 379     protected abstract double getPhysicalPageWidth(Paper p);
 380 
 381     /**
 382      * Must be obtained from the current printer.
 383      * Value is in device pixels.
 384      * Not adjusted for orientation of the paper.
 385      */
 386     protected abstract double getPhysicalPageHeight(Paper p);
 387 
 388     /**
 389      * Begin a new page.
 390      */
 391     protected abstract void startPage(PageFormat format, Printable painter,
 392                                       int index, boolean paperChanged)
 393         throws PrinterException;
 394 
 395     /**
 396      * End a page.
 397      */
 398     protected abstract void endPage(PageFormat format, Printable painter,
 399                                     int index)
 400         throws PrinterException;
 401 
 402     /**
 403      * Prints the contents of the array of ints, 'data'
 404      * to the current page. The band is placed at the
 405      * location (x, y) in device coordinates on the
 406      * page. The width and height of the band is
 407      * specified by the caller.
 408      */
 409     protected abstract void printBand(byte[] data, int x, int y,
 410                                       int width, int height)
 411         throws PrinterException;
 412 
 413 /* Instance Methods */
 414 
 415     /**
 416       * save graphics state of a PathGraphics for later redrawing
 417       * of part of page represented by the region in that state
 418       */
 419 
 420     public void saveState(AffineTransform at, Shape clip,
 421                           Rectangle2D region, double sx, double sy) {
 422         GraphicsState gstate = new GraphicsState();
 423         gstate.theTransform = at;
 424         gstate.theClip = clip;
 425         gstate.region = region;
 426         gstate.sx = sx;
 427         gstate.sy = sy;
 428         redrawList.add(gstate);
 429     }
 430 
 431 
 432     /*
 433      * A convenience method which returns the default service
 434      * for 2D <code>PrinterJob</code>s.
 435      * May return null if there is no suitable default (although there
 436      * may still be 2D services available).
 437      * @return default 2D print service, or null.
 438      * @since     1.4
 439      */
 440     protected static PrintService lookupDefaultPrintService() {
 441         PrintService service = PrintServiceLookup.lookupDefaultPrintService();
 442 
 443         /* Pageable implies Printable so checking both isn't strictly needed */
 444         if (service != null &&
 445             service.isDocFlavorSupported(
 446                                 DocFlavor.SERVICE_FORMATTED.PAGEABLE) &&
 447             service.isDocFlavorSupported(
 448                                 DocFlavor.SERVICE_FORMATTED.PRINTABLE)) {
 449             return service;
 450         } else {
 451            PrintService []services =
 452              PrintServiceLookup.lookupPrintServices(
 453                                 DocFlavor.SERVICE_FORMATTED.PAGEABLE, null);
 454            if (services.length > 0) {
 455                return services[0];
 456            }
 457         }
 458         return null;
 459     }
 460 
 461    /**
 462      * Returns the service (printer) for this printer job.
 463      * Implementations of this class which do not support print services
 464      * may return null;
 465      * @return the service for this printer job.
 466      *
 467      */
 468     public PrintService getPrintService() {
 469         if (myService == null) {
 470             PrintService svc = PrintServiceLookup.lookupDefaultPrintService();
 471             if (svc != null &&
 472                 svc.isDocFlavorSupported(
 473                      DocFlavor.SERVICE_FORMATTED.PAGEABLE)) {
 474                 try {
 475                     setPrintService(svc);
 476                     myService = svc;
 477                 } catch (PrinterException e) {
 478                 }
 479             }
 480             if (myService == null) {
 481                 PrintService[] svcs = PrintServiceLookup.lookupPrintServices(
 482                     DocFlavor.SERVICE_FORMATTED.PAGEABLE, null);
 483                 if (svcs.length > 0) {
 484                     try {
 485                         setPrintService(svcs[0]);
 486                         myService = svcs[0];
 487                     } catch (PrinterException e) {
 488                     }
 489                 }
 490             }
 491         }
 492         return myService;
 493     }
 494 
 495     /**
 496      * Associate this PrinterJob with a new PrintService.
 497      *
 498      * Throws <code>PrinterException</code> if the specified service
 499      * cannot support the <code>Pageable</code> and
 500      * <code>Printable</code> interfaces necessary to support 2D printing.
 501      * @param service print service which supports 2D printing.
 502      *
 503      * @throws PrinterException if the specified service does not support
 504      * 2D printing or no longer available.
 505      */
 506     public void setPrintService(PrintService service)
 507         throws PrinterException {
 508         if (service == null) {
 509             throw new PrinterException("Service cannot be null");
 510         } else if (!(service instanceof StreamPrintService) &&
 511                    service.getName() == null) {
 512             throw new PrinterException("Null PrintService name.");
 513         } else {
 514             // Check the list of services.  This service may have been
 515             // deleted already
 516             PrinterState prnState = service.getAttribute(PrinterState.class);
 517             if (prnState == PrinterState.STOPPED) {
 518                 PrinterStateReasons prnStateReasons =
 519                     service.getAttribute(PrinterStateReasons.class);
 520                 if ((prnStateReasons != null) &&
 521                     (prnStateReasons.containsKey(PrinterStateReason.SHUTDOWN)))
 522                 {
 523                     throw new PrinterException("PrintService is no longer available.");
 524                 }
 525             }
 526 
 527 
 528             if (service.isDocFlavorSupported(
 529                                              DocFlavor.SERVICE_FORMATTED.PAGEABLE) &&
 530                 service.isDocFlavorSupported(
 531                                              DocFlavor.SERVICE_FORMATTED.PRINTABLE)) {
 532                 myService = service;
 533             } else {
 534                 throw new PrinterException("Not a 2D print service: " + service);
 535             }
 536         }
 537     }
 538 
 539     private PageFormat attributeToPageFormat(PrintService service,
 540                                                PrintRequestAttributeSet attSet) {
 541         PageFormat page = defaultPage();
 542 
 543         if (service == null) {
 544             return page;
 545         }
 546 
 547         OrientationRequested orient = (OrientationRequested)
 548                                       attSet.get(OrientationRequested.class);
 549         if (orient == null) {
 550             orient = (OrientationRequested)
 551                     service.getDefaultAttributeValue(OrientationRequested.class);
 552         }
 553         if (orient == OrientationRequested.REVERSE_LANDSCAPE) {
 554             page.setOrientation(PageFormat.REVERSE_LANDSCAPE);
 555         } else if (orient == OrientationRequested.LANDSCAPE) {
 556             page.setOrientation(PageFormat.LANDSCAPE);
 557         } else {
 558             page.setOrientation(PageFormat.PORTRAIT);
 559         }
 560 
 561         Media media = (Media)attSet.get(Media.class);
 562         MediaSize size = getMediaSize(media, service, page);
 563 
 564         Paper paper = new Paper();
 565         float dim[] = size.getSize(1); //units == 1 to avoid FP error
 566         double w = Math.rint((dim[0]*72.0)/Size2DSyntax.INCH);
 567         double h = Math.rint((dim[1]*72.0)/Size2DSyntax.INCH);
 568         paper.setSize(w, h);
 569         MediaPrintableArea area =
 570              (MediaPrintableArea)
 571              attSet.get(MediaPrintableArea.class);
 572         if (area == null) {
 573             area = getDefaultPrintableArea(page, w, h);
 574         }
 575 
 576         double ix, iw, iy, ih;
 577         // Should pass in same unit as updatePageAttributes
 578         // to avoid rounding off errors.
 579         ix = Math.rint(
 580                 area.getX(MediaPrintableArea.INCH) * DPI);
 581         iy = Math.rint(
 582                 area.getY(MediaPrintableArea.INCH) * DPI);
 583         iw = Math.rint(
 584                 area.getWidth(MediaPrintableArea.INCH) * DPI);
 585         ih = Math.rint(
 586                 area.getHeight(MediaPrintableArea.INCH) * DPI);
 587         paper.setImageableArea(ix, iy, iw, ih);
 588         page.setPaper(paper);
 589         return page;
 590     }
 591     protected MediaSize getMediaSize(Media media, PrintService service,
 592             PageFormat page) {
 593         if (media == null) {
 594             media = (Media)service.getDefaultAttributeValue(Media.class);
 595         }
 596         if (!(media instanceof MediaSizeName)) {
 597             media = MediaSizeName.NA_LETTER;
 598         }
 599         MediaSize size = MediaSize.getMediaSizeForName((MediaSizeName) media);
 600         return size != null ? size : MediaSize.NA.LETTER;
 601     }
 602 
 603     protected MediaPrintableArea getDefaultPrintableArea(PageFormat page,
 604             double w, double h) {
 605         double ix, iw, iy, ih;
 606         if (w >= 72.0 * 6.0) {
 607             ix = 72.0;
 608             iw = w - 2 * 72.0;
 609         } else {
 610             ix = w / 6.0;
 611             iw = w * 0.75;
 612         }
 613         if (h >= 72.0 * 6.0) {
 614             iy = 72.0;
 615             ih = h - 2 * 72.0;
 616         } else {
 617             iy = h / 6.0;
 618             ih = h * 0.75;
 619         }
 620 
 621         return new MediaPrintableArea((float) (ix / DPI), (float) (iy / DPI),
 622                 (float) (iw / DPI), (float) (ih / DPI), MediaPrintableArea.INCH);
 623     }
 624 
 625     protected void updatePageAttributes(PrintService service,
 626                                         PageFormat page) {
 627         if (this.attributes == null) {
 628             this.attributes = new HashPrintRequestAttributeSet();
 629         }
 630 
 631         updateAttributesWithPageFormat(service, page, this.attributes);
 632     }
 633 
 634     protected void updateAttributesWithPageFormat(PrintService service,
 635                                         PageFormat page,
 636                                         PrintRequestAttributeSet pageAttributes) {
 637         if (service == null || page == null || pageAttributes == null) {
 638             return;
 639         }
 640 
 641         float x = (float)Math.rint(
 642                          (page.getPaper().getWidth()*Size2DSyntax.INCH)/
 643                          (72.0))/(float)Size2DSyntax.INCH;
 644         float y = (float)Math.rint(
 645                          (page.getPaper().getHeight()*Size2DSyntax.INCH)/
 646                          (72.0))/(float)Size2DSyntax.INCH;
 647 
 648         // We should limit the list where we search the matching
 649         // media, this will prevent mapping to wrong media ex. Ledger
 650         // can be mapped to B.  Especially useful when creating
 651         // custom MediaSize.
 652         Media[] mediaList = (Media[])service.getSupportedAttributeValues(
 653                                       Media.class, null, null);
 654         Media media = null;
 655         try {
 656             media = CustomMediaSizeName.findMedia(mediaList, x, y,
 657                                    Size2DSyntax.INCH);
 658         } catch (IllegalArgumentException iae) {
 659         }
 660         if ((media == null) ||
 661              !(service.isAttributeValueSupported(media, null, null))) {
 662             media = (Media)service.getDefaultAttributeValue(Media.class);
 663         }
 664 
 665         OrientationRequested orient;
 666         switch (page.getOrientation()) {
 667         case PageFormat.LANDSCAPE :
 668             orient = OrientationRequested.LANDSCAPE;
 669             break;
 670         case PageFormat.REVERSE_LANDSCAPE:
 671             orient = OrientationRequested.REVERSE_LANDSCAPE;
 672             break;
 673         default:
 674             orient = OrientationRequested.PORTRAIT;
 675         }
 676 
 677         if (media != null) {
 678             pageAttributes.add(media);
 679         }
 680         pageAttributes.add(orient);
 681 
 682         float ix = (float)(page.getPaper().getImageableX()/DPI);
 683         float iw = (float)(page.getPaper().getImageableWidth()/DPI);
 684         float iy = (float)(page.getPaper().getImageableY()/DPI);
 685         float ih = (float)(page.getPaper().getImageableHeight()/DPI);
 686         if (ix < 0) ix = 0f; if (iy < 0) iy = 0f;
 687         try {
 688             pageAttributes.add(new MediaPrintableArea(ix, iy, iw, ih,
 689                                                   MediaPrintableArea.INCH));
 690         } catch (IllegalArgumentException iae) {
 691         }
 692     }
 693 
 694    /**
 695      * Display a dialog to the user allowing the modification of a
 696      * PageFormat instance.
 697      * The <code>page</code> argument is used to initialize controls
 698      * in the page setup dialog.
 699      * If the user cancels the dialog, then the method returns the
 700      * original <code>page</code> object unmodified.
 701      * If the user okays the dialog then the method returns a new
 702      * PageFormat object with the indicated changes.
 703      * In either case the original <code>page</code> object will
 704      * not be modified.
 705      * @param     page    the default PageFormat presented to the user
 706      *                    for modification
 707      * @return    the original <code>page</code> object if the dialog
 708      *            is cancelled, or a new PageFormat object containing
 709      *            the format indicated by the user if the dialog is
 710      *            acknowledged
 711      * @exception HeadlessException if GraphicsEnvironment.isHeadless()
 712      * returns true.
 713      * @see java.awt.GraphicsEnvironment#isHeadless
 714      * @since     1.2
 715      */
 716     public PageFormat pageDialog(PageFormat page)
 717         throws HeadlessException {
 718         if (GraphicsEnvironment.isHeadless()) {
 719             throw new HeadlessException();
 720         }
 721 
 722         final GraphicsConfiguration gc =
 723           GraphicsEnvironment.getLocalGraphicsEnvironment().
 724           getDefaultScreenDevice().getDefaultConfiguration();
 725 
 726         PrintService service = java.security.AccessController.doPrivileged(
 727                                new java.security.PrivilegedAction<PrintService>() {
 728                 public PrintService run() {
 729                     PrintService service = getPrintService();
 730                     if (service == null) {
 731                         ServiceDialog.showNoPrintService(gc);
 732                         return null;
 733                     }
 734                     return service;
 735                 }
 736             });
 737 
 738         if (service == null) {
 739             return page;
 740         }
 741         updatePageAttributes(service, page);
 742 
 743         PageFormat newPage = null;
 744         DialogTypeSelection dts =
 745             (DialogTypeSelection)attributes.get(DialogTypeSelection.class);
 746         if (dts == DialogTypeSelection.NATIVE) {
 747             // Remove DialogTypeSelection.NATIVE to prevent infinite loop in
 748             // RasterPrinterJob.
 749             attributes.remove(DialogTypeSelection.class);
 750             newPage = pageDialog(attributes);
 751             // restore attribute
 752             attributes.add(DialogTypeSelection.NATIVE);
 753         } else {
 754             newPage = pageDialog(attributes);
 755         }
 756 
 757         if (newPage == null) {
 758             return page;
 759         } else {
 760             return newPage;
 761         }
 762     }
 763 
 764     /**
 765      * return a PageFormat corresponding to the updated attributes,
 766      * or null if the user cancelled the dialog.
 767      */
 768     @SuppressWarnings("deprecation")
 769     public PageFormat pageDialog(final PrintRequestAttributeSet attributes)
 770         throws HeadlessException {
 771         if (GraphicsEnvironment.isHeadless()) {
 772             throw new HeadlessException();
 773         }
 774 
 775         DialogTypeSelection dlg =
 776             (DialogTypeSelection)attributes.get(DialogTypeSelection.class);
 777 
 778         // Check for native, note that default dialog is COMMON.
 779         if (dlg == DialogTypeSelection.NATIVE) {
 780             PrintService pservice = getPrintService();
 781             PageFormat pageFrmAttrib = attributeToPageFormat(pservice,
 782                                                              attributes);
 783             PageFormat page = pageDialog(pageFrmAttrib);
 784 
 785             // If user cancels the dialog, pageDialog() will return the original
 786             // page object and as per spec, we should return null in that case.
 787             if (page == pageFrmAttrib) {
 788                 return null;
 789             }
 790             updateAttributesWithPageFormat(pservice, page, attributes);
 791             return page;
 792         }
 793 
 794         final GraphicsConfiguration gc =
 795             GraphicsEnvironment.getLocalGraphicsEnvironment().
 796             getDefaultScreenDevice().getDefaultConfiguration();
 797         Rectangle bounds = gc.getBounds();
 798         int x = bounds.x+bounds.width/3;
 799         int y = bounds.y+bounds.height/3;
 800 
 801         PrintService service = java.security.AccessController.doPrivileged(
 802                                new java.security.PrivilegedAction<PrintService>() {
 803                 public PrintService run() {
 804                     PrintService service = getPrintService();
 805                     if (service == null) {
 806                         ServiceDialog.showNoPrintService(gc);
 807                         return null;
 808                     }
 809                     return service;
 810                 }
 811             });
 812 
 813         if (service == null) {
 814             return null;
 815         }
 816 
 817         ServiceDialog pageDialog = new ServiceDialog(gc, x, y, service,
 818                                        DocFlavor.SERVICE_FORMATTED.PAGEABLE,
 819                                        attributes, (Frame)null);
 820         pageDialog.show();
 821 
 822         if (pageDialog.getStatus() == ServiceDialog.APPROVE) {
 823             PrintRequestAttributeSet newas =
 824                 pageDialog.getAttributes();
 825             Class<?> amCategory = SunAlternateMedia.class;
 826 
 827             if (attributes.containsKey(amCategory) &&
 828                 !newas.containsKey(amCategory)) {
 829                 attributes.remove(amCategory);
 830             }
 831             attributes.addAll(newas);
 832             return attributeToPageFormat(service, attributes);
 833         } else {
 834             return null;
 835         }
 836    }
 837 
 838    protected PageFormat getPageFormatFromAttributes() {
 839        if (attributes == null || attributes.isEmpty()) {
 840             return null;
 841         }
 842         return attributeToPageFormat(getPrintService(), this.attributes);
 843    }
 844 
 845 
 846    /**
 847      * Presents the user a dialog for changing properties of the
 848      * print job interactively.
 849      * The services browsable here are determined by the type of
 850      * service currently installed.
 851      * If the application installed a StreamPrintService on this
 852      * PrinterJob, only the available StreamPrintService (factories) are
 853      * browsable.
 854      *
 855      * @param attributes to store changed properties.
 856      * @return false if the user cancels the dialog and true otherwise.
 857      * @exception HeadlessException if GraphicsEnvironment.isHeadless()
 858      * returns true.
 859      * @see java.awt.GraphicsEnvironment#isHeadless
 860      */
 861     public boolean printDialog(final PrintRequestAttributeSet attributes)
 862         throws HeadlessException {
 863         if (GraphicsEnvironment.isHeadless()) {
 864             throw new HeadlessException();
 865         }
 866 
 867         DialogTypeSelection dlg =
 868             (DialogTypeSelection)attributes.get(DialogTypeSelection.class);
 869 
 870         // Check for native, note that default dialog is COMMON.
 871         if (dlg == DialogTypeSelection.NATIVE) {
 872             this.attributes = attributes;
 873             try {
 874                 debug_println("calling setAttributes in printDialog");
 875                 setAttributes(attributes);
 876 
 877             } catch (PrinterException e) {
 878 
 879             }
 880 
 881             boolean ret = printDialog();
 882             this.attributes = attributes;
 883             return ret;
 884 
 885         }
 886 
 887         /* A security check has already been performed in the
 888          * java.awt.print.printerJob.getPrinterJob method.
 889          * So by the time we get here, it is OK for the current thread
 890          * to print either to a file (from a Dialog we control!) or
 891          * to a chosen printer.
 892          *
 893          * We raise privilege when we put up the dialog, to avoid
 894          * the "warning applet window" banner.
 895          */
 896         final GraphicsConfiguration gc =
 897             GraphicsEnvironment.getLocalGraphicsEnvironment().
 898             getDefaultScreenDevice().getDefaultConfiguration();
 899 
 900         PrintService service = java.security.AccessController.doPrivileged(
 901                                new java.security.PrivilegedAction<PrintService>() {
 902                 public PrintService run() {
 903                     PrintService service = getPrintService();
 904                     if (service == null) {
 905                         ServiceDialog.showNoPrintService(gc);
 906                         return null;
 907                     }
 908                     return service;
 909                 }
 910             });
 911 
 912         if (service == null) {
 913             return false;
 914         }
 915 
 916         PrintService[] services;
 917         StreamPrintServiceFactory[] spsFactories = null;
 918         if (service instanceof StreamPrintService) {
 919             spsFactories = lookupStreamPrintServices(null);
 920             services = new StreamPrintService[spsFactories.length];
 921             for (int i=0; i<spsFactories.length; i++) {
 922                 services[i] = spsFactories[i].getPrintService(null);
 923             }
 924         } else {
 925             services = java.security.AccessController.doPrivileged(
 926                        new java.security.PrivilegedAction<PrintService[]>() {
 927                 public PrintService[] run() {
 928                     PrintService[] services = PrinterJob.lookupPrintServices();
 929                     return services;
 930                 }
 931             });
 932 
 933             if ((services == null) || (services.length == 0)) {
 934                 /*
 935                  * No services but default PrintService exists?
 936                  * Create services using defaultService.
 937                  */
 938                 services = new PrintService[1];
 939                 services[0] = service;
 940             }
 941         }
 942 
 943         Rectangle bounds = gc.getBounds();
 944         int x = bounds.x+bounds.width/3;
 945         int y = bounds.y+bounds.height/3;
 946         PrintService newService;
 947         // temporarily add an attribute pointing back to this job.
 948         PrinterJobWrapper jobWrapper = new PrinterJobWrapper(this);
 949         attributes.add(jobWrapper);
 950         try {
 951             newService =
 952             ServiceUI.printDialog(gc, x, y,
 953                                   services, service,
 954                                   DocFlavor.SERVICE_FORMATTED.PAGEABLE,
 955                                   attributes);
 956         } catch (IllegalArgumentException iae) {
 957             newService = ServiceUI.printDialog(gc, x, y,
 958                                   services, services[0],
 959                                   DocFlavor.SERVICE_FORMATTED.PAGEABLE,
 960                                   attributes);
 961         }
 962         attributes.remove(PrinterJobWrapper.class);
 963 
 964         if (newService == null) {
 965             return false;
 966         }
 967 
 968         if (!service.equals(newService)) {
 969             try {
 970                 setPrintService(newService);
 971             } catch (PrinterException e) {
 972                 /*
 973                  * The only time it would throw an exception is when
 974                  * newService is no longer available but we should still
 975                  * select this printer.
 976                  */
 977                 myService = newService;
 978             }
 979         }
 980         return true;
 981     }
 982 
 983    /**
 984      * Presents the user a dialog for changing properties of the
 985      * print job interactively.
 986      * @return false if the user cancels the dialog and
 987      *         true otherwise.
 988      * @exception HeadlessException if GraphicsEnvironment.isHeadless()
 989      * returns true.
 990      * @see java.awt.GraphicsEnvironment#isHeadless
 991      */
 992     public boolean printDialog() throws HeadlessException {
 993 
 994         if (GraphicsEnvironment.isHeadless()) {
 995             throw new HeadlessException();
 996         }
 997 
 998         PrintRequestAttributeSet attributes =
 999           new HashPrintRequestAttributeSet();
1000         attributes.add(new Copies(getCopies()));
1001         attributes.add(new JobName(getJobName(), null));
1002         boolean doPrint = printDialog(attributes);
1003         if (doPrint) {
1004             JobName jobName = (JobName)attributes.get(JobName.class);
1005             if (jobName != null) {
1006                 setJobName(jobName.getValue());
1007             }
1008             Copies copies = (Copies)attributes.get(Copies.class);
1009             if (copies != null) {
1010                 setCopies(copies.getValue());
1011             }
1012 
1013             Destination dest = (Destination)attributes.get(Destination.class);
1014 
1015             if (dest != null) {
1016                 try {
1017                     mDestType = RasterPrinterJob.FILE;
1018                     mDestination = (new File(dest.getURI())).getPath();
1019                 } catch (Exception e) {
1020                     mDestination = "out.prn";
1021                     PrintService ps = getPrintService();
1022                     if (ps != null) {
1023                         Destination defaultDest = (Destination)ps.
1024                             getDefaultAttributeValue(Destination.class);
1025                         if (defaultDest != null) {
1026                             mDestination = (new File(defaultDest.getURI())).getPath();
1027                         }
1028                     }
1029                 }
1030             } else {
1031                 mDestType = RasterPrinterJob.PRINTER;
1032                 PrintService ps = getPrintService();
1033                 if (ps != null) {
1034                     mDestination = ps.getName();
1035                 }
1036             }
1037         }
1038 
1039         return doPrint;
1040     }
1041 
1042     /**
1043      * The pages in the document to be printed by this PrinterJob
1044      * are drawn by the Printable object 'painter'. The PageFormat
1045      * for each page is the default page format.
1046      * @param painter Called to render each page of the document.
1047      */
1048     public void setPrintable(Printable painter) {
1049         setPageable(new OpenBook(defaultPage(new PageFormat()), painter));
1050     }
1051 
1052     /**
1053      * The pages in the document to be printed by this PrinterJob
1054      * are drawn by the Printable object 'painter'. The PageFormat
1055      * of each page is 'format'.
1056      * @param painter Called to render each page of the document.
1057      * @param format  The size and orientation of each page to
1058      *                be printed.
1059      */
1060     public void setPrintable(Printable painter, PageFormat format) {
1061         setPageable(new OpenBook(format, painter));
1062         updatePageAttributes(getPrintService(), format);
1063     }
1064 
1065     /**
1066      * The pages in the document to be printed are held by the
1067      * Pageable instance 'document'. 'document' will be queried
1068      * for the number of pages as well as the PageFormat and
1069      * Printable for each page.
1070      * @param document The document to be printed. It may not be null.
1071      * @exception NullPointerException the Pageable passed in was null.
1072      * @see PageFormat
1073      * @see Printable
1074      */
1075     public void setPageable(Pageable document) throws NullPointerException {
1076         if (document != null) {
1077             mDocument = document;
1078 
1079         } else {
1080             throw new NullPointerException();
1081         }
1082     }
1083 
1084     protected void initPrinter() {
1085         return;
1086     }
1087 
1088     protected boolean isSupportedValue(Attribute attrval,
1089                                      PrintRequestAttributeSet attrset) {
1090         PrintService ps = getPrintService();
1091         return
1092             (attrval != null && ps != null &&
1093              ps.isAttributeValueSupported(attrval,
1094                                           DocFlavor.SERVICE_FORMATTED.PAGEABLE,
1095                                           attrset));
1096     }
1097 
1098     /**
1099      * Set the device resolution.
1100      * Overridden and used only by the postscript code.
1101      * Windows code pulls the information from the attribute set itself.
1102      */
1103     protected void setXYRes(double x, double y) {
1104     }
1105 
1106     /* subclasses may need to pull extra information out of the attribute set
1107      * They can override this method & call super.setAttributes()
1108      */
1109     protected  void setAttributes(PrintRequestAttributeSet attributes)
1110         throws PrinterException {
1111         /*  reset all values to defaults */
1112         setCollated(false);
1113         sidesAttr = null;
1114         printerResAttr = null;
1115         pageRangesAttr = null;
1116         copiesAttr = 0;
1117         jobNameAttr = null;
1118         userNameAttr = null;
1119         destinationAttr = null;
1120         collateAttReq = false;
1121 
1122         PrintService service = getPrintService();
1123         if (attributes == null  || service == null) {
1124             return;
1125         }
1126 
1127         boolean fidelity = false;
1128         Fidelity attrFidelity = (Fidelity)attributes.get(Fidelity.class);
1129         if (attrFidelity != null && attrFidelity == Fidelity.FIDELITY_TRUE) {
1130             fidelity = true;
1131         }
1132 
1133         if (fidelity == true) {
1134            AttributeSet unsupported =
1135                service.getUnsupportedAttributes(
1136                                          DocFlavor.SERVICE_FORMATTED.PAGEABLE,
1137                                          attributes);
1138            if (unsupported != null) {
1139                throw new PrinterException("Fidelity cannot be satisfied");
1140            }
1141         }
1142 
1143         /*
1144          * Since we have verified supported values if fidelity is true,
1145          * we can either ignore unsupported values, or substitute a
1146          * reasonable alternative
1147          */
1148 
1149         SheetCollate collateAttr =
1150             (SheetCollate)attributes.get(SheetCollate.class);
1151         if (isSupportedValue(collateAttr,  attributes)) {
1152             setCollated(collateAttr == SheetCollate.COLLATED);
1153         }
1154 
1155         sidesAttr = (Sides)attributes.get(Sides.class);
1156         if (!isSupportedValue(sidesAttr,  attributes)) {
1157             sidesAttr = Sides.ONE_SIDED;
1158         }
1159 
1160         printerResAttr = (PrinterResolution)attributes.get(PrinterResolution.class);
1161         if (service.isAttributeCategorySupported(PrinterResolution.class)) {
1162             if (!isSupportedValue(printerResAttr,  attributes)) {
1163                printerResAttr = (PrinterResolution)
1164                    service.getDefaultAttributeValue(PrinterResolution.class);
1165             }
1166             double xr =
1167                printerResAttr.getCrossFeedResolution(ResolutionSyntax.DPI);
1168             double yr = printerResAttr.getFeedResolution(ResolutionSyntax.DPI);
1169             setXYRes(xr, yr);
1170         }
1171 
1172         pageRangesAttr =  (PageRanges)attributes.get(PageRanges.class);
1173         if (!isSupportedValue(pageRangesAttr, attributes)) {
1174             pageRangesAttr = null;
1175         } else {
1176             if ((SunPageSelection)attributes.get(SunPageSelection.class)
1177                      == SunPageSelection.RANGE) {
1178                 // get to, from, min, max page ranges
1179                 int[][] range = pageRangesAttr.getMembers();
1180                 // setPageRanges uses 0-based indexing so we subtract 1
1181                 setPageRange(range[0][0] - 1, range[0][1] - 1);
1182             } else {
1183                setPageRange(-1, - 1);
1184             }
1185         }
1186 
1187         Copies copies = (Copies)attributes.get(Copies.class);
1188         if (isSupportedValue(copies,  attributes) ||
1189             (!fidelity && copies != null)) {
1190             copiesAttr = copies.getValue();
1191             setCopies(copiesAttr);
1192         } else {
1193             copiesAttr = getCopies();
1194         }
1195 
1196         Destination destination =
1197             (Destination)attributes.get(Destination.class);
1198 
1199         if (isSupportedValue(destination,  attributes)) {
1200             try {
1201                 // Old code (new File(destination.getURI())).getPath()
1202                 // would generate a "URI is not hierarchical" IAE
1203                 // for "file:out.prn" so we use getSchemeSpecificPart instead
1204                 destinationAttr = "" + new File(destination.getURI().
1205                                                 getSchemeSpecificPart());
1206             } catch (Exception e) { // paranoid exception
1207                 Destination defaultDest = (Destination)service.
1208                     getDefaultAttributeValue(Destination.class);
1209                 if (defaultDest != null) {
1210                     destinationAttr = "" + new File(defaultDest.getURI().
1211                                                 getSchemeSpecificPart());
1212                 }
1213             }
1214         }
1215 
1216         JobSheets jobSheets = (JobSheets)attributes.get(JobSheets.class);
1217         if (jobSheets != null) {
1218             noJobSheet = jobSheets == JobSheets.NONE;
1219         }
1220 
1221         JobName jobName = (JobName)attributes.get(JobName.class);
1222         if (isSupportedValue(jobName,  attributes) ||
1223             (!fidelity && jobName != null)) {
1224             jobNameAttr = jobName.getValue();
1225             setJobName(jobNameAttr);
1226         } else {
1227             jobNameAttr = getJobName();
1228         }
1229 
1230         RequestingUserName userName =
1231             (RequestingUserName)attributes.get(RequestingUserName.class);
1232         if (isSupportedValue(userName,  attributes) ||
1233             (!fidelity && userName != null)) {
1234             userNameAttr = userName.getValue();
1235         } else {
1236             try {
1237                 userNameAttr = getUserName();
1238             } catch (SecurityException e) {
1239                 userNameAttr = "";
1240             }
1241         }
1242 
1243         /* OpenBook is used internally only when app uses Printable.
1244          * This is the case when we use the values from the attribute set.
1245          */
1246         Media media = (Media)attributes.get(Media.class);
1247         OrientationRequested orientReq =
1248            (OrientationRequested)attributes.get(OrientationRequested.class);
1249         MediaPrintableArea mpa =
1250             (MediaPrintableArea)attributes.get(MediaPrintableArea.class);
1251 
1252         if ((orientReq != null || media != null || mpa != null) &&
1253             getPageable() instanceof OpenBook) {
1254 
1255             /* We could almost(!) use PrinterJob.getPageFormat() except
1256              * here we need to start with the PageFormat from the OpenBook :
1257              */
1258             Pageable pageable = getPageable();
1259             Printable printable = pageable.getPrintable(0);
1260             PageFormat pf = (PageFormat)pageable.getPageFormat(0).clone();
1261             Paper paper = pf.getPaper();
1262 
1263             /* If there's a media but no media printable area, we can try
1264              * to retrieve the default value for mpa and use that.
1265              */
1266             if (mpa == null && media != null &&
1267                 service.
1268                 isAttributeCategorySupported(MediaPrintableArea.class)) {
1269                 Object mpaVals = service.
1270                     getSupportedAttributeValues(MediaPrintableArea.class,
1271                                                 null, attributes);
1272                 if (mpaVals instanceof MediaPrintableArea[] &&
1273                     ((MediaPrintableArea[])mpaVals).length > 0) {
1274                     mpa = ((MediaPrintableArea[])mpaVals)[0];
1275                 }
1276             }
1277 
1278             if (isSupportedValue(orientReq, attributes) ||
1279                 (!fidelity && orientReq != null)) {
1280                 int orient;
1281                 if (orientReq.equals(OrientationRequested.REVERSE_LANDSCAPE)) {
1282                     orient = PageFormat.REVERSE_LANDSCAPE;
1283                 } else if (orientReq.equals(OrientationRequested.LANDSCAPE)) {
1284                     orient = PageFormat.LANDSCAPE;
1285                 } else {
1286                     orient = PageFormat.PORTRAIT;
1287                 }
1288                 pf.setOrientation(orient);
1289             }
1290 
1291             if (isSupportedValue(media, attributes) ||
1292                 (!fidelity && media != null)) {
1293                 if (media instanceof MediaSizeName) {
1294                     MediaSizeName msn = (MediaSizeName)media;
1295                     MediaSize msz = MediaSize.getMediaSizeForName(msn);
1296                     if (msz != null) {
1297                         float paperWid =  msz.getX(MediaSize.INCH) * 72.0f;
1298                         float paperHgt =  msz.getY(MediaSize.INCH) * 72.0f;
1299                         paper.setSize(paperWid, paperHgt);
1300                         if (mpa == null) {
1301                             paper.setImageableArea(72.0, 72.0,
1302                                                    paperWid-144.0,
1303                                                    paperHgt-144.0);
1304                         }
1305                     }
1306                 }
1307             }
1308 
1309             if (isSupportedValue(mpa, attributes) ||
1310                 (!fidelity && mpa != null)) {
1311                 float [] printableArea =
1312                     mpa.getPrintableArea(MediaPrintableArea.INCH);
1313                 for (int i=0; i < printableArea.length; i++) {
1314                     printableArea[i] = printableArea[i]*72.0f;
1315                 }
1316                 paper.setImageableArea(printableArea[0], printableArea[1],
1317                                        printableArea[2], printableArea[3]);
1318             }
1319 
1320             pf.setPaper(paper);
1321             pf = validatePage(pf);
1322             setPrintable(printable, pf);
1323         } else {
1324             // for AWT where pageable is not an instance of OpenBook,
1325             // we need to save paper info
1326             this.attributes = attributes;
1327         }
1328 
1329     }
1330 
1331     /*
1332      * Services we don't recognize as built-in services can't be
1333      * implemented as subclasses of PrinterJob, therefore we create
1334      * a DocPrintJob from their service and pass a Doc representing
1335      * the application's printjob
1336      */
1337 // MacOSX - made protected so subclasses can reference it.
1338     protected void spoolToService(PrintService psvc,
1339                                 PrintRequestAttributeSet attributes)
1340         throws PrinterException {
1341 
1342         if (psvc == null) {
1343             throw new PrinterException("No print service found.");
1344         }
1345 
1346         DocPrintJob job = psvc.createPrintJob();
1347         Doc doc = new PageableDoc(getPageable());
1348         if (attributes == null) {
1349             attributes = new HashPrintRequestAttributeSet();
1350         }
1351         try {
1352             job.print(doc, attributes);
1353         } catch (PrintException e) {
1354             throw new PrinterException(e.toString());
1355         }
1356     }
1357 
1358     /**
1359      * Prints a set of pages.
1360      * @exception java.awt.print.PrinterException an error in the print system
1361      *                                          caused the job to be aborted
1362      * @see java.awt.print.Book
1363      * @see java.awt.print.Pageable
1364      * @see java.awt.print.Printable
1365      */
1366     public void print() throws PrinterException {
1367         print(attributes);
1368     }
1369 
1370     public static boolean debugPrint = false;
1371     protected void debug_println(String str) {
1372         if (debugPrint) {
1373             System.out.println("RasterPrinterJob "+str+" "+this);
1374         }
1375     }
1376 
1377     public void print(PrintRequestAttributeSet attributes)
1378         throws PrinterException {
1379 
1380         /*
1381          * In the future PrinterJob will probably always dispatch
1382          * the print job to the PrintService.
1383          * This is how third party 2D Print Services will be invoked
1384          * when applications use the PrinterJob API.
1385          * However the JRE's concrete PrinterJob implementations have
1386          * not yet been re-worked to be implemented as standalone
1387          * services, and are implemented only as subclasses of PrinterJob.
1388          * So here we dispatch only those services we do not recognize
1389          * as implemented through platform subclasses of PrinterJob
1390          * (and this class).
1391          */
1392         PrintService psvc = getPrintService();
1393         debug_println("psvc = "+psvc);
1394         if (psvc == null) {
1395             throw new PrinterException("No print service found.");
1396         }
1397 
1398         // Check the list of services.  This service may have been
1399         // deleted already
1400         PrinterState prnState = psvc.getAttribute(PrinterState.class);
1401         if (prnState == PrinterState.STOPPED) {
1402             PrinterStateReasons prnStateReasons =
1403                     psvc.getAttribute(PrinterStateReasons.class);
1404                 if ((prnStateReasons != null) &&
1405                     (prnStateReasons.containsKey(PrinterStateReason.SHUTDOWN)))
1406                 {
1407                     throw new PrinterException("PrintService is no longer available.");
1408                 }
1409         }
1410 
1411         if ((psvc.getAttribute(PrinterIsAcceptingJobs.class)) ==
1412                          PrinterIsAcceptingJobs.NOT_ACCEPTING_JOBS) {
1413             throw new PrinterException("Printer is not accepting job.");
1414         }
1415 
1416         if ((psvc instanceof SunPrinterJobService) &&
1417             ((SunPrinterJobService)psvc).usesClass(getClass())) {
1418             setAttributes(attributes);
1419             // throw exception for invalid destination
1420             if (destinationAttr != null) {
1421                 validateDestination(destinationAttr);
1422             }
1423         } else {
1424             spoolToService(psvc, attributes);
1425             return;
1426         }
1427         /* We need to make sure that the collation and copies
1428          * settings are initialised */
1429         initPrinter();
1430 
1431         int numCollatedCopies = getCollatedCopies();
1432         int numNonCollatedCopies = getNoncollatedCopies();
1433         debug_println("getCollatedCopies()  "+numCollatedCopies
1434               + " getNoncollatedCopies() "+ numNonCollatedCopies);
1435 
1436         /* Get the range of pages we are to print. If the
1437          * last page to print is unknown, then we print to
1438          * the end of the document. Note that firstPage
1439          * and lastPage are 0 based page indices.
1440          */
1441         int numPages = mDocument.getNumberOfPages();
1442         if (numPages == 0) {
1443             return;
1444         }
1445 
1446         int firstPage = getFirstPage();
1447         int lastPage = getLastPage();
1448         if(lastPage == Pageable.UNKNOWN_NUMBER_OF_PAGES){
1449             int totalPages = mDocument.getNumberOfPages();
1450             if (totalPages != Pageable.UNKNOWN_NUMBER_OF_PAGES) {
1451                 lastPage = mDocument.getNumberOfPages() - 1;
1452             }
1453         }
1454 
1455         try {
1456             synchronized (this) {
1457                 performingPrinting = true;
1458                 userCancelled = false;
1459             }
1460 
1461             startDoc();
1462             if (isCancelled()) {
1463                 cancelDoc();
1464             }
1465 
1466             // PageRanges can be set even if RANGE is not selected
1467             // so we need to check if it is selected.
1468             boolean rangeIsSelected = true;
1469             if (attributes != null) {
1470                 SunPageSelection pages =
1471                     (SunPageSelection)attributes.get(SunPageSelection.class);
1472                 if ((pages != null) && (pages != SunPageSelection.RANGE)) {
1473                     rangeIsSelected = false;
1474                 }
1475             }
1476 
1477 
1478             debug_println("after startDoc rangeSelected? "+rangeIsSelected
1479                       + " numNonCollatedCopies "+ numNonCollatedCopies);
1480 
1481 
1482             /* Three nested loops iterate over the document. The outer loop
1483              * counts the number of collated copies while the inner loop
1484              * counts the number of nonCollated copies. Normally, one of
1485              * these two loops will only execute once; that is we will
1486              * either print collated copies or noncollated copies. The
1487              * middle loop iterates over the pages.
1488              * If a PageRanges attribute is used, it constrains the pages
1489              * that are imaged. If a platform subclass (though a user dialog)
1490              * requests a page range via setPageRange(). it too can
1491              * constrain the page ranges that are imaged.
1492              * It is expected that only one of these will be used in a
1493              * job but both should be able to co-exist.
1494              */
1495             for(int collated = 0; collated < numCollatedCopies; collated++) {
1496                 for(int i = firstPage, pageResult = Printable.PAGE_EXISTS;
1497                     (i <= lastPage ||
1498                      lastPage == Pageable.UNKNOWN_NUMBER_OF_PAGES)
1499                     && pageResult == Printable.PAGE_EXISTS;
1500                     i++)
1501                 {
1502 
1503                     if ((pageRangesAttr != null) && rangeIsSelected ){
1504                         int nexti = pageRangesAttr.next(i);
1505                         if (nexti == -1) {
1506                             break;
1507                         } else if (nexti != i+1) {
1508                             continue;
1509                         }
1510                     }
1511 
1512                     for(int nonCollated = 0;
1513                         nonCollated < numNonCollatedCopies
1514                         && pageResult == Printable.PAGE_EXISTS;
1515                         nonCollated++)
1516                     {
1517                         if (isCancelled()) {
1518                             cancelDoc();
1519                         }
1520                         debug_println("printPage "+i);
1521                         pageResult = printPage(mDocument, i);
1522 
1523                     }
1524                 }
1525             }
1526 
1527             if (isCancelled()) {
1528                 cancelDoc();
1529             }
1530 
1531         } finally {
1532             // reset previousPaper in case this job is invoked again.
1533             previousPaper = null;
1534             synchronized (this) {
1535                 if (performingPrinting) {
1536                     endDoc();
1537                 }
1538                 performingPrinting = false;
1539                 notify();
1540             }
1541         }
1542     }
1543 
1544     protected void validateDestination(String dest) throws PrinterException {
1545         if (dest == null) {
1546             return;
1547         }
1548         // dest is null for Destination(new URI(""))
1549         // because isAttributeValueSupported returns false in setAttributes
1550 
1551         // Destination(new URI(" ")) throws URISyntaxException
1552         File f = new File(dest);
1553         try {
1554             // check if this is a new file and if filename chars are valid
1555             if (f.createNewFile()) {
1556                 f.delete();
1557             }
1558         } catch (IOException ioe) {
1559             throw new PrinterException("Cannot write to file:"+
1560                                        dest);
1561         } catch (SecurityException se) {
1562             //There is already file read/write access so at this point
1563             // only delete access is denied.  Just ignore it because in
1564             // most cases the file created in createNewFile gets overwritten
1565             // anyway.
1566         }
1567 
1568         File pFile = f.getParentFile();
1569         if ((f.exists() &&
1570              (!f.isFile() || !f.canWrite())) ||
1571             ((pFile != null) &&
1572              (!pFile.exists() || (pFile.exists() && !pFile.canWrite())))) {
1573             throw new PrinterException("Cannot write to file:"+
1574                                        dest);
1575         }
1576     }
1577 
1578     /**
1579      * updates a Paper object to reflect the current printer's selected
1580      * paper size and imageable area for that paper size.
1581      * Default implementation copies settings from the original, applies
1582      * applies some validity checks, changes them only if they are
1583      * clearly unreasonable, then sets them into the new Paper.
1584      * Subclasses are expected to override this method to make more
1585      * informed decisons.
1586      */
1587     protected void validatePaper(Paper origPaper, Paper newPaper) {
1588         if (origPaper == null || newPaper == null) {
1589             return;
1590         } else {
1591             double wid = origPaper.getWidth();
1592             double hgt = origPaper.getHeight();
1593             double ix = origPaper.getImageableX();
1594             double iy = origPaper.getImageableY();
1595             double iw = origPaper.getImageableWidth();
1596             double ih = origPaper.getImageableHeight();
1597 
1598             /* Assume any +ve values are legal. Overall paper dimensions
1599              * take precedence. Make sure imageable area fits on the paper.
1600              */
1601             Paper defaultPaper = new Paper();
1602             wid = ((wid > 0.0) ? wid : defaultPaper.getWidth());
1603             hgt = ((hgt > 0.0) ? hgt : defaultPaper.getHeight());
1604             ix = ((ix > 0.0) ? ix : defaultPaper.getImageableX());
1605             iy = ((iy > 0.0) ? iy : defaultPaper.getImageableY());
1606             iw = ((iw > 0.0) ? iw : defaultPaper.getImageableWidth());
1607             ih = ((ih > 0.0) ? ih : defaultPaper.getImageableHeight());
1608             /* full width/height is not likely to be imageable, but since we
1609              * don't know the limits we have to allow it
1610              */
1611             if (iw > wid) {
1612                 iw = wid;
1613             }
1614             if (ih > hgt) {
1615                 ih = hgt;
1616             }
1617             if ((ix + iw) > wid) {
1618                 ix = wid - iw;
1619             }
1620             if ((iy + ih) > hgt) {
1621                 iy = hgt - ih;
1622             }
1623             newPaper.setSize(wid, hgt);
1624             newPaper.setImageableArea(ix, iy, iw, ih);
1625         }
1626     }
1627 
1628     /**
1629      * The passed in PageFormat will be copied and altered to describe
1630      * the default page size and orientation of the PrinterJob's
1631      * current printer.
1632      * Platform subclasses which can access the actual default paper size
1633      * for a printer may override this method.
1634      */
1635     public PageFormat defaultPage(PageFormat page) {
1636         PageFormat newPage = (PageFormat)page.clone();
1637         newPage.setOrientation(PageFormat.PORTRAIT);
1638         Paper newPaper = new Paper();
1639         double ptsPerInch = 72.0;
1640         double w, h;
1641         Media media = null;
1642 
1643         PrintService service = getPrintService();
1644         if (service != null) {
1645             MediaSize size;
1646             media =
1647                 (Media)service.getDefaultAttributeValue(Media.class);
1648 
1649             if (media instanceof MediaSizeName &&
1650                ((size = MediaSize.getMediaSizeForName((MediaSizeName)media)) !=
1651                 null)) {
1652                 w =  size.getX(MediaSize.INCH) * ptsPerInch;
1653                 h =  size.getY(MediaSize.INCH) * ptsPerInch;
1654                 newPaper.setSize(w, h);
1655                 newPaper.setImageableArea(ptsPerInch, ptsPerInch,
1656                                           w - 2.0*ptsPerInch,
1657                                           h - 2.0*ptsPerInch);
1658                 newPage.setPaper(newPaper);
1659                 return newPage;
1660 
1661             }
1662         }
1663 
1664         /* Default to A4 paper outside North America.
1665          */
1666         String defaultCountry = Locale.getDefault().getCountry();
1667         if (!Locale.getDefault().equals(Locale.ENGLISH) && // ie "C"
1668             defaultCountry != null &&
1669             !defaultCountry.equals(Locale.US.getCountry()) &&
1670             !defaultCountry.equals(Locale.CANADA.getCountry())) {
1671 
1672             double mmPerInch = 25.4;
1673             w = Math.rint((210.0*ptsPerInch)/mmPerInch);
1674             h = Math.rint((297.0*ptsPerInch)/mmPerInch);
1675             newPaper.setSize(w, h);
1676             newPaper.setImageableArea(ptsPerInch, ptsPerInch,
1677                                       w - 2.0*ptsPerInch,
1678                                       h - 2.0*ptsPerInch);
1679         }
1680 
1681         newPage.setPaper(newPaper);
1682 
1683         return newPage;
1684     }
1685 
1686     /**
1687      * The passed in PageFormat is cloned and altered to be usable on
1688      * the PrinterJob's current printer.
1689      */
1690     public PageFormat validatePage(PageFormat page) {
1691         PageFormat newPage = (PageFormat)page.clone();
1692         Paper newPaper = new Paper();
1693         validatePaper(newPage.getPaper(), newPaper);
1694         newPage.setPaper(newPaper);
1695 
1696         return newPage;
1697     }
1698 
1699     /**
1700      * Set the number of copies to be printed.
1701      */
1702     public void setCopies(int copies) {
1703         mNumCopies = copies;
1704     }
1705 
1706     /**
1707      * Get the number of copies to be printed.
1708      */
1709     public int getCopies() {
1710         return mNumCopies;
1711     }
1712 
1713    /* Used when executing a print job where an attribute set may
1714      * over ride API values.
1715      */
1716     protected int getCopiesInt() {
1717         return (copiesAttr > 0) ? copiesAttr : getCopies();
1718     }
1719 
1720     /**
1721      * Get the name of the printing user.
1722      * The caller must have security permission to read system properties.
1723      */
1724     public String getUserName() {
1725         return System.getProperty("user.name");
1726     }
1727 
1728    /* Used when executing a print job where an attribute set may
1729      * over ride API values.
1730      */
1731     protected String getUserNameInt() {
1732         if  (userNameAttr != null) {
1733             return userNameAttr;
1734         } else {
1735             try {
1736                 return  getUserName();
1737             } catch (SecurityException e) {
1738                 return "";
1739             }
1740         }
1741     }
1742 
1743     /**
1744      * Set the name of the document to be printed.
1745      * The document name can not be null.
1746      */
1747     public void setJobName(String jobName) {
1748         if (jobName != null) {
1749             mDocName = jobName;
1750         } else {
1751             throw new NullPointerException();
1752         }
1753     }
1754 
1755     /**
1756      * Get the name of the document to be printed.
1757      */
1758     public String getJobName() {
1759         return mDocName;
1760     }
1761 
1762     /* Used when executing a print job where an attribute set may
1763      * over ride API values.
1764      */
1765     protected String getJobNameInt() {
1766         return (jobNameAttr != null) ? jobNameAttr : getJobName();
1767     }
1768 
1769     /**
1770      * Set the range of pages from a Book to be printed.
1771      * Both 'firstPage' and 'lastPage' are zero based
1772      * page indices. If either parameter is less than
1773      * zero then the page range is set to be from the
1774      * first page to the last.
1775      */
1776     protected void setPageRange(int firstPage, int lastPage) {
1777         if(firstPage >= 0 && lastPage >= 0) {
1778             mFirstPage = firstPage;
1779             mLastPage = lastPage;
1780             if(mLastPage < mFirstPage) mLastPage = mFirstPage;
1781         } else {
1782             mFirstPage = Pageable.UNKNOWN_NUMBER_OF_PAGES;
1783             mLastPage = Pageable.UNKNOWN_NUMBER_OF_PAGES;
1784         }
1785     }
1786 
1787     /**
1788      * Return the zero based index of the first page to
1789      * be printed in this job.
1790      */
1791     protected int getFirstPage() {
1792         return mFirstPage == Book.UNKNOWN_NUMBER_OF_PAGES ? 0 : mFirstPage;
1793     }
1794 
1795     /**
1796      * Return the zero based index of the last page to
1797      * be printed in this job.
1798      */
1799     protected int getLastPage() {
1800         return mLastPage;
1801     }
1802 
1803     /**
1804      * Set whether copies should be collated or not.
1805      * Two collated copies of a three page document
1806      * print in this order: 1, 2, 3, 1, 2, 3 while
1807      * uncollated copies print in this order:
1808      * 1, 1, 2, 2, 3, 3.
1809      * This is set when request is using an attribute set.
1810      */
1811     protected void setCollated(boolean collate) {
1812         mCollate = collate;
1813         collateAttReq = true;
1814     }
1815 
1816     /**
1817      * Return true if collated copies will be printed as determined
1818      * in an attribute set.
1819      */
1820     protected boolean isCollated() {
1821             return mCollate;
1822     }
1823 
1824     protected final int getSelectAttrib() {
1825         if (attributes != null) {
1826             SunPageSelection pages =
1827                 (SunPageSelection)attributes.get(SunPageSelection.class);
1828             if (pages == SunPageSelection.RANGE) {
1829                 return PD_PAGENUMS;
1830             } else if (pages == SunPageSelection.SELECTION) {
1831                 return PD_SELECTION;
1832             } else if (pages ==  SunPageSelection.ALL) {
1833                 return PD_ALLPAGES;
1834             }
1835         }
1836         return PD_NOSELECTION;
1837     }
1838 
1839     //returns 1-based index for "From" page
1840     protected final int getFromPageAttrib() {
1841         if (attributes != null) {
1842             PageRanges pageRangesAttr =
1843                 (PageRanges)attributes.get(PageRanges.class);
1844             if (pageRangesAttr != null) {
1845                 int[][] range = pageRangesAttr.getMembers();
1846                 return range[0][0];
1847             }
1848         }
1849         return getMinPageAttrib();
1850     }
1851 
1852     //returns 1-based index for "To" page
1853     protected final int getToPageAttrib() {
1854         if (attributes != null) {
1855             PageRanges pageRangesAttr =
1856                 (PageRanges)attributes.get(PageRanges.class);
1857             if (pageRangesAttr != null) {
1858                 int[][] range = pageRangesAttr.getMembers();
1859                 return range[range.length-1][1];
1860             }
1861         }
1862         return getMaxPageAttrib();
1863     }
1864 
1865     protected final int getMinPageAttrib() {
1866         if (attributes != null) {
1867             SunMinMaxPage s =
1868                 (SunMinMaxPage)attributes.get(SunMinMaxPage.class);
1869             if (s != null) {
1870                 return s.getMin();
1871             }
1872         }
1873         return 1;
1874     }
1875 
1876     protected final int getMaxPageAttrib() {
1877         if (attributes != null) {
1878             SunMinMaxPage s =
1879                 (SunMinMaxPage)attributes.get(SunMinMaxPage.class);
1880             if (s != null) {
1881                 return s.getMax();
1882             }
1883         }
1884 
1885         Pageable pageable = getPageable();
1886         if (pageable != null) {
1887             int numPages = pageable.getNumberOfPages();
1888             if (numPages <= Pageable.UNKNOWN_NUMBER_OF_PAGES) {
1889                 numPages = MAX_UNKNOWN_PAGES;
1890             }
1891             return  ((numPages == 0) ? 1 : numPages);
1892         }
1893 
1894         return Integer.MAX_VALUE;
1895     }
1896     /**
1897      * Called by the print() method at the start of
1898      * a print job.
1899      */
1900     protected abstract void startDoc() throws PrinterException;
1901 
1902     /**
1903      * Called by the print() method at the end of
1904      * a print job.
1905      */
1906     protected abstract void endDoc() throws PrinterException;
1907 
1908     /* Called by cancelDoc */
1909     protected abstract void abortDoc();
1910 
1911 // MacOSX - made protected so subclasses can reference it.
1912     protected void cancelDoc() throws PrinterAbortException {
1913         abortDoc();
1914         synchronized (this) {
1915             userCancelled = false;
1916             performingPrinting = false;
1917             notify();
1918         }
1919         throw new PrinterAbortException();
1920     }
1921 
1922     /**
1923      * Returns how many times the entire book should
1924      * be printed by the PrintJob. If the printer
1925      * itself supports collation then this method
1926      * should return 1 indicating that the entire
1927      * book need only be printed once and the copies
1928      * will be collated and made in the printer.
1929      */
1930     protected int getCollatedCopies() {
1931         return isCollated() ? getCopiesInt() : 1;
1932     }
1933 
1934     /**
1935      * Returns how many times each page in the book
1936      * should be consecutively printed by PrintJob.
1937      * If the printer makes copies itself then this
1938      * method should return 1.
1939      */
1940     protected int getNoncollatedCopies() {
1941         return isCollated() ? 1 : getCopiesInt();
1942     }
1943 
1944 
1945     /* The printer graphics config is cached on the job, so that it can
1946      * be created once, and updated only as needed (for now only to change
1947      * the bounds if when using a Pageable the page sizes changes).
1948      */
1949 
1950     private int deviceWidth, deviceHeight;
1951     private AffineTransform defaultDeviceTransform;
1952     private PrinterGraphicsConfig pgConfig;
1953 
1954     synchronized void setGraphicsConfigInfo(AffineTransform at,
1955                                             double pw, double ph) {
1956         Point2D.Double pt = new Point2D.Double(pw, ph);
1957         at.transform(pt, pt);
1958 
1959         if (pgConfig == null ||
1960             defaultDeviceTransform == null ||
1961             !at.equals(defaultDeviceTransform) ||
1962             deviceWidth != (int)pt.getX() ||
1963             deviceHeight != (int)pt.getY()) {
1964 
1965                 deviceWidth = (int)pt.getX();
1966                 deviceHeight = (int)pt.getY();
1967                 defaultDeviceTransform = at;
1968                 pgConfig = null;
1969         }
1970     }
1971 
1972     synchronized PrinterGraphicsConfig getPrinterGraphicsConfig() {
1973         if (pgConfig != null) {
1974             return pgConfig;
1975         }
1976         String deviceID = "Printer Device";
1977         PrintService service = getPrintService();
1978         if (service != null) {
1979             deviceID = service.toString();
1980         }
1981         pgConfig = new PrinterGraphicsConfig(deviceID,
1982                                              defaultDeviceTransform,
1983                                              deviceWidth, deviceHeight);
1984         return pgConfig;
1985     }
1986 
1987     /**
1988      * Print a page from the provided document.
1989      * @return int Printable.PAGE_EXISTS if the page existed and was drawn and
1990      *             Printable.NO_SUCH_PAGE if the page did not exist.
1991      * @see java.awt.print.Printable
1992      */
1993     protected int printPage(Pageable document, int pageIndex)
1994         throws PrinterException
1995     {
1996         PageFormat page;
1997         PageFormat origPage;
1998         Printable painter;
1999         try {
2000             origPage = document.getPageFormat(pageIndex);
2001             page = (PageFormat)origPage.clone();
2002             painter = document.getPrintable(pageIndex);
2003         } catch (Exception e) {
2004             PrinterException pe =
2005                     new PrinterException("Error getting page or printable.[ " +
2006                                           e +" ]");
2007             pe.initCause(e);
2008             throw pe;
2009         }
2010 
2011         /* Get the imageable area from Paper instead of PageFormat
2012          * because we do not want it adjusted by the page orientation.
2013          */
2014         Paper paper = page.getPaper();
2015         // if non-portrait and 270 degree landscape rotation
2016         if (page.getOrientation() != PageFormat.PORTRAIT &&
2017             landscapeRotates270) {
2018 
2019             double left = paper.getImageableX();
2020             double top = paper.getImageableY();
2021             double width = paper.getImageableWidth();
2022             double height = paper.getImageableHeight();
2023             paper.setImageableArea(paper.getWidth()-left-width,
2024                                    paper.getHeight()-top-height,
2025                                    width, height);
2026             page.setPaper(paper);
2027             if (page.getOrientation() == PageFormat.LANDSCAPE) {
2028                 page.setOrientation(PageFormat.REVERSE_LANDSCAPE);
2029             } else {
2030                 page.setOrientation(PageFormat.LANDSCAPE);
2031             }
2032         }
2033 
2034         double xScale = getXRes() / 72.0;
2035         double yScale = getYRes() / 72.0;
2036 
2037         /* The deviceArea is the imageable area in the printer's
2038          * resolution.
2039          */
2040         Rectangle2D deviceArea =
2041             new Rectangle2D.Double(paper.getImageableX() * xScale,
2042                                    paper.getImageableY() * yScale,
2043                                    paper.getImageableWidth() * xScale,
2044                                    paper.getImageableHeight() * yScale);
2045 
2046         /* Build and hold on to a uniform transform so that
2047          * we can get back to device space at the beginning
2048          * of each band.
2049          */
2050         AffineTransform uniformTransform = new AffineTransform();
2051 
2052         /* The scale transform is used to switch from the
2053          * device space to the user's 72 dpi space.
2054          */
2055         AffineTransform scaleTransform = new AffineTransform();
2056         scaleTransform.scale(xScale, yScale);
2057 
2058         /* bandwidth is multiple of 4 as the data is used in a win32 DIB and
2059          * some drivers behave badly if scanlines aren't multiples of 4 bytes.
2060          */
2061         int bandWidth = (int) deviceArea.getWidth();
2062         if (bandWidth % 4 != 0) {
2063             bandWidth += (4 - (bandWidth % 4));
2064         }
2065         if (bandWidth <= 0) {
2066             throw new PrinterException("Paper's imageable width is too small.");
2067         }
2068 
2069         int deviceAreaHeight = (int)deviceArea.getHeight();
2070         if (deviceAreaHeight <= 0) {
2071             throw new PrinterException("Paper's imageable height is too small.");
2072         }
2073 
2074         /* Figure out the number of lines that will fit into
2075          * our maximum band size. The hard coded 3 reflects the
2076          * fact that we can only create 24 bit per pixel 3 byte BGR
2077          * BufferedImages. FIX.
2078          */
2079         int bandHeight = (MAX_BAND_SIZE / bandWidth / 3);
2080 
2081         int deviceLeft = (int)Math.rint(paper.getImageableX() * xScale);
2082         int deviceTop  = (int)Math.rint(paper.getImageableY() * yScale);
2083 
2084         /* The device transform is used to move the band down
2085          * the page using translates. Normally this is all it
2086          * would do, but since, when printing, the Window's
2087          * DIB format wants the last line to be first (lowest) in
2088          * memory, the deviceTransform moves the origin to the
2089          * bottom of the band and flips the origin. This way the
2090          * app prints upside down into the band which is the DIB
2091          * format.
2092          */
2093         AffineTransform deviceTransform = new AffineTransform();
2094         deviceTransform.translate(-deviceLeft, deviceTop);
2095         deviceTransform.translate(0, bandHeight);
2096         deviceTransform.scale(1, -1);
2097 
2098         /* Create a BufferedImage to hold the band. We set the clip
2099          * of the band to be tight around the bits so that the
2100          * application can use it to figure what part of the
2101          * page needs to be drawn. The clip is never altered in
2102          * this method, but we do translate the band's coordinate
2103          * system so that the app will see the clip moving down the
2104          * page though it s always around the same set of pixels.
2105          */
2106         BufferedImage pBand = new BufferedImage(1, 1,
2107                                                 BufferedImage.TYPE_3BYTE_BGR);
2108 
2109         /* Have the app draw into a PeekGraphics object so we can
2110          * learn something about the needs of the print job.
2111          */
2112 
2113         PeekGraphics peekGraphics = createPeekGraphics(pBand.createGraphics(),
2114                                                        this);
2115 
2116         Rectangle2D.Double pageFormatArea =
2117             new Rectangle2D.Double(page.getImageableX(),
2118                                    page.getImageableY(),
2119                                    page.getImageableWidth(),
2120                                    page.getImageableHeight());
2121         peekGraphics.transform(scaleTransform);
2122         peekGraphics.translate(-getPhysicalPrintableX(paper) / xScale,
2123                                -getPhysicalPrintableY(paper) / yScale);
2124         peekGraphics.transform(new AffineTransform(page.getMatrix()));
2125         initPrinterGraphics(peekGraphics, pageFormatArea);
2126         AffineTransform pgAt = peekGraphics.getTransform();
2127 
2128         /* Update the information used to return a GraphicsConfiguration
2129          * for this printer device. It needs to be updated per page as
2130          * not all pages in a job may be the same size (different bounds)
2131          * The transform is the scaling transform as this corresponds to
2132          * the default transform for the device. The width and height are
2133          * those of the paper, not the page format, as we want to describe
2134          * the bounds of the device in its natural coordinate system of
2135          * device coordinate whereas a page format may be in a rotated context.
2136          */
2137         setGraphicsConfigInfo(scaleTransform,
2138                               paper.getWidth(), paper.getHeight());
2139         int pageResult = painter.print(peekGraphics, origPage, pageIndex);
2140         debug_println("pageResult "+pageResult);
2141         if (pageResult == Printable.PAGE_EXISTS) {
2142             debug_println("startPage "+pageIndex);
2143 
2144             /* We need to check if the paper size is changed.
2145              * Note that it is not sufficient to ask for the pageformat
2146              * of "pageIndex-1", since PageRanges mean that pages can be
2147              * skipped. So we have to look at the actual last paper size used.
2148              */
2149             Paper thisPaper = page.getPaper();
2150             boolean paperChanged =
2151                 previousPaper == null ||
2152                 thisPaper.getWidth() != previousPaper.getWidth() ||
2153                 thisPaper.getHeight() != previousPaper.getHeight();
2154             previousPaper = thisPaper;
2155 
2156             startPage(page, painter, pageIndex, paperChanged);
2157             Graphics2D pathGraphics = createPathGraphics(peekGraphics, this,
2158                                                          painter, page,
2159                                                          pageIndex);
2160 
2161             /* If we can convert the page directly to the
2162              * underlying graphics system then we do not
2163              * need to rasterize. We also may not need to
2164              * create the 'band' if all the pages can take
2165              * this path.
2166              */
2167             if (pathGraphics != null) {
2168                 pathGraphics.transform(scaleTransform);
2169                 // user (0,0) should be origin of page, not imageable area
2170                 pathGraphics.translate(-getPhysicalPrintableX(paper) / xScale,
2171                                        -getPhysicalPrintableY(paper) / yScale);
2172                 pathGraphics.transform(new AffineTransform(page.getMatrix()));
2173                 initPrinterGraphics(pathGraphics, pageFormatArea);
2174 
2175                 redrawList.clear();
2176 
2177                 AffineTransform initialTx = pathGraphics.getTransform();
2178 
2179                 painter.print(pathGraphics, origPage, pageIndex);
2180 
2181                 for (int i=0;i<redrawList.size();i++) {
2182                    GraphicsState gstate = redrawList.get(i);
2183                    pathGraphics.setTransform(initialTx);
2184                    ((PathGraphics)pathGraphics).redrawRegion(
2185                                                          gstate.region,
2186                                                          gstate.sx,
2187                                                          gstate.sy,
2188                                                          gstate.theClip,
2189                                                          gstate.theTransform);
2190                 }
2191 
2192             /* This is the banded-raster printing loop.
2193              * It should be moved into its own method.
2194              */
2195             } else {
2196                 BufferedImage band = cachedBand;
2197                 if (cachedBand == null ||
2198                     bandWidth != cachedBandWidth ||
2199                     bandHeight != cachedBandHeight) {
2200                     band = new BufferedImage(bandWidth, bandHeight,
2201                                              BufferedImage.TYPE_3BYTE_BGR);
2202                     cachedBand = band;
2203                     cachedBandWidth = bandWidth;
2204                     cachedBandHeight = bandHeight;
2205                 }
2206                 Graphics2D bandGraphics = band.createGraphics();
2207 
2208                 Rectangle2D.Double clipArea =
2209                     new Rectangle2D.Double(0, 0, bandWidth, bandHeight);
2210 
2211                 initPrinterGraphics(bandGraphics, clipArea);
2212 
2213                 ProxyGraphics2D painterGraphics =
2214                     new ProxyGraphics2D(bandGraphics, this);
2215 
2216                 Graphics2D clearGraphics = band.createGraphics();
2217                 clearGraphics.setColor(Color.white);
2218 
2219                 /* We need the actual bits of the BufferedImage to send to
2220                  * the native Window's code. 'data' points to the actual
2221                  * pixels. Right now these are in ARGB format with 8 bits
2222                  * per component. We need to use a monochrome BufferedImage
2223                  * for monochrome printers when this is supported by
2224                  * BufferedImage. FIX
2225                  */
2226                 ByteInterleavedRaster tile = (ByteInterleavedRaster)band.getRaster();
2227                 byte[] data = tile.getDataStorage();
2228 
2229                 /* Loop over the page moving our band down the page,
2230                  * calling the app to render the band, and then send the band
2231                  * to the printer.
2232                  */
2233                 int deviceBottom = deviceTop + deviceAreaHeight;
2234 
2235                 /* device's printable x,y is really addressable origin
2236                  * we address relative to media origin so when we print a
2237                  * band we need to adjust for the different methods of
2238                  * addressing it.
2239                  */
2240                 int deviceAddressableX = (int)getPhysicalPrintableX(paper);
2241                 int deviceAddressableY = (int)getPhysicalPrintableY(paper);
2242 
2243                 for (int bandTop = 0; bandTop <= deviceAreaHeight;
2244                      bandTop += bandHeight)
2245                 {
2246 
2247                     /* Put the band back into device space and
2248                      * erase the contents of the band.
2249                      */
2250                     clearGraphics.fillRect(0, 0, bandWidth, bandHeight);
2251 
2252                     /* Put the band into the correct location on the
2253                      * page. Once the band is moved we translate the
2254                      * device transform so that the band will move down
2255                      * the page on the next iteration of the loop.
2256                      */
2257                     bandGraphics.setTransform(uniformTransform);
2258                     bandGraphics.transform(deviceTransform);
2259                     deviceTransform.translate(0, -bandHeight);
2260 
2261                     /* Switch the band from device space to user,
2262                      * 72 dpi, space.
2263                      */
2264                     bandGraphics.transform(scaleTransform);
2265                     bandGraphics.transform(new AffineTransform(page.getMatrix()));
2266 
2267                     Rectangle clip = bandGraphics.getClipBounds();
2268                     clip = pgAt.createTransformedShape(clip).getBounds();
2269 
2270                     if ((clip == null) || peekGraphics.hitsDrawingArea(clip) &&
2271                         (bandWidth > 0 && bandHeight > 0)) {
2272 
2273                         /* if the client has specified an imageable X or Y
2274                          * which is off than the physically addressable
2275                          * area of the page, then we need to adjust for that
2276                          * here so that we pass only non -ve band coordinates
2277                          * We also need to translate by the adjusted amount
2278                          * so that printing appears in the correct place.
2279                          */
2280                         int bandX = deviceLeft - deviceAddressableX;
2281                         if (bandX < 0) {
2282                             bandGraphics.translate(bandX/xScale,0);
2283                             bandX = 0;
2284                         }
2285                         int bandY = deviceTop + bandTop - deviceAddressableY;
2286                         if (bandY < 0) {
2287                             bandGraphics.translate(0,bandY/yScale);
2288                             bandY = 0;
2289                         }
2290                         /* Have the app's painter image into the band
2291                          * and then send the band to the printer.
2292                          */
2293                         painterGraphics.setDelegate((Graphics2D) bandGraphics.create());
2294                         painter.print(painterGraphics, origPage, pageIndex);
2295                         painterGraphics.dispose();
2296                         printBand(data, bandX, bandY, bandWidth, bandHeight);
2297                     }
2298                 }
2299 
2300                 clearGraphics.dispose();
2301                 bandGraphics.dispose();
2302 
2303             }
2304             debug_println("calling endPage "+pageIndex);
2305             endPage(page, painter, pageIndex);
2306         }
2307 
2308         return pageResult;
2309     }
2310 
2311     /**
2312      * If a print job is in progress, print() has been
2313      * called but has not returned, then this signals
2314      * that the job should be cancelled and the next
2315      * chance. If there is no print job in progress then
2316      * this call does nothing.
2317      */
2318     public void cancel() {
2319         synchronized (this) {
2320             if (performingPrinting) {
2321                 userCancelled = true;
2322             }
2323             notify();
2324         }
2325     }
2326 
2327     /**
2328      * Returns true is a print job is ongoing but will
2329      * be cancelled and the next opportunity. false is
2330      * returned otherwise.
2331      */
2332     public boolean isCancelled() {
2333 
2334         boolean cancelled = false;
2335 
2336         synchronized (this) {
2337             cancelled = (performingPrinting && userCancelled);
2338             notify();
2339         }
2340 
2341         return cancelled;
2342     }
2343 
2344     /**
2345      * Return the Pageable describing the pages to be printed.
2346      */
2347     protected Pageable getPageable() {
2348         return mDocument;
2349     }
2350 
2351     /**
2352      * Examine the metrics captured by the
2353      * <code>PeekGraphics</code> instance and
2354      * if capable of directly converting this
2355      * print job to the printer's control language
2356      * or the native OS's graphics primitives, then
2357      * return a <code>PathGraphics</code> to perform
2358      * that conversion. If there is not an object
2359      * capable of the conversion then return
2360      * <code>null</code>. Returning <code>null</code>
2361      * causes the print job to be rasterized.
2362      */
2363     protected Graphics2D createPathGraphics(PeekGraphics graphics,
2364                                             PrinterJob printerJob,
2365                                             Printable painter,
2366                                             PageFormat pageFormat,
2367                                             int pageIndex) {
2368 
2369         return null;
2370     }
2371 
2372     /**
2373      * Create and return an object that will
2374      * gather and hold metrics about the print
2375      * job. This method is passed a <code>Graphics2D</code>
2376      * object that can be used as a proxy for the
2377      * object gathering the print job matrics. The
2378      * method is also supplied with the instance
2379      * controlling the print job, <code>printerJob</code>.
2380      */
2381     protected PeekGraphics createPeekGraphics(Graphics2D graphics,
2382                                               PrinterJob printerJob) {
2383 
2384         return new PeekGraphics(graphics, printerJob);
2385     }
2386 
2387     /**
2388      * Configure the passed in Graphics2D so that
2389      * is contains the defined initial settings
2390      * for a print job. These settings are:
2391      *      color:  black.
2392      *      clip:   <as passed in>
2393      */
2394 // MacOSX - made protected so subclasses can reference it.
2395     protected void initPrinterGraphics(Graphics2D g, Rectangle2D clip) {
2396 
2397         g.setClip(clip);
2398         g.setPaint(Color.black);
2399     }
2400 
2401 
2402    /**
2403     * User dialogs should disable "File" buttons if this returns false.
2404     *
2405     */
2406     public boolean checkAllowedToPrintToFile() {
2407         try {
2408             throwPrintToFile();
2409             return true;
2410         } catch (SecurityException e) {
2411             return false;
2412         }
2413     }
2414 
2415     /**
2416      * Break this out as it may be useful when we allow API to
2417      * specify printing to a file. In that case its probably right
2418      * to throw a SecurityException if the permission is not granted
2419      */
2420     private void throwPrintToFile() {
2421         SecurityManager security = System.getSecurityManager();
2422         if (security != null) {
2423             if (printToFilePermission == null) {
2424                 printToFilePermission =
2425                     new FilePermission("<<ALL FILES>>", "read,write");
2426             }
2427             security.checkPermission(printToFilePermission);
2428         }
2429     }
2430 
2431     /* On-screen drawString renders most control chars as the missing glyph
2432      * and have the non-zero advance of that glyph.
2433      * Exceptions are \t, \n and \r which are considered zero-width.
2434      * This is a utility method used by subclasses to remove them so we
2435      * don't have to worry about platform or font specific handling of them.
2436      */
2437     protected String removeControlChars(String s) {
2438         char[] in_chars = s.toCharArray();
2439         int len = in_chars.length;
2440         char[] out_chars = new char[len];
2441         int pos = 0;
2442 
2443         for (int i = 0; i < len; i++) {
2444             char c = in_chars[i];
2445             if (c > '\r' || c < '\t' || c == '\u000b' || c == '\u000c')  {
2446                out_chars[pos++] = c;
2447             }
2448         }
2449         if (pos == len) {
2450             return s; // no need to make a new String.
2451         } else {
2452             return new String(out_chars, 0, pos);
2453         }
2454     }
2455 }