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 abstract protected double getXRes();
339
340 /**
341 * Returns the resolution in dots per inch down the height
342 * of the page.
343 */
344 abstract protected 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 abstract protected 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 abstract protected 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 abstract protected 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 abstract protected 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 abstract protected 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 abstract protected double getPhysicalPageHeight(Paper p);
387
388 /**
389 * Begin a new page.
390 */
391 abstract protected void startPage(PageFormat format, Printable painter,
392 int index, boolean paperChanged)
393 throws PrinterException;
394
395 /**
396 * End a page.
397 */
398 abstract protected 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 abstract protected 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 page = pageDialog(attributeToPageFormat(pservice,
782 attributes));
783 updateAttributesWithPageFormat(pservice, page, attributes);
784 return page;
785 }
786
787 final GraphicsConfiguration gc =
788 GraphicsEnvironment.getLocalGraphicsEnvironment().
789 getDefaultScreenDevice().getDefaultConfiguration();
790 Rectangle bounds = gc.getBounds();
791 int x = bounds.x+bounds.width/3;
792 int y = bounds.y+bounds.height/3;
793
794 PrintService service = java.security.AccessController.doPrivileged(
795 new java.security.PrivilegedAction<PrintService>() {
796 public PrintService run() {
797 PrintService service = getPrintService();
798 if (service == null) {
799 ServiceDialog.showNoPrintService(gc);
800 return null;
801 }
802 return service;
803 }
804 });
805
806 if (service == null) {
807 return null;
808 }
809
810 ServiceDialog pageDialog = new ServiceDialog(gc, x, y, service,
811 DocFlavor.SERVICE_FORMATTED.PAGEABLE,
812 attributes, (Frame)null);
813 pageDialog.show();
814
815 if (pageDialog.getStatus() == ServiceDialog.APPROVE) {
816 PrintRequestAttributeSet newas =
817 pageDialog.getAttributes();
818 Class<?> amCategory = SunAlternateMedia.class;
819
820 if (attributes.containsKey(amCategory) &&
821 !newas.containsKey(amCategory)) {
822 attributes.remove(amCategory);
823 }
824 attributes.addAll(newas);
825 return attributeToPageFormat(service, attributes);
826 } else {
827 return null;
828 }
829 }
830
831 protected PageFormat getPageFormatFromAttributes() {
832 if (attributes == null || attributes.isEmpty()) {
833 return null;
834 }
835 return attributeToPageFormat(getPrintService(), this.attributes);
836 }
837
838
839 /**
840 * Presents the user a dialog for changing properties of the
841 * print job interactively.
842 * The services browsable here are determined by the type of
843 * service currently installed.
844 * If the application installed a StreamPrintService on this
845 * PrinterJob, only the available StreamPrintService (factories) are
846 * browsable.
847 *
848 * @param attributes to store changed properties.
849 * @return false if the user cancels the dialog and true otherwise.
850 * @exception HeadlessException if GraphicsEnvironment.isHeadless()
851 * returns true.
852 * @see java.awt.GraphicsEnvironment#isHeadless
853 */
854 public boolean printDialog(final PrintRequestAttributeSet attributes)
855 throws HeadlessException {
856 if (GraphicsEnvironment.isHeadless()) {
857 throw new HeadlessException();
858 }
859
860 DialogTypeSelection dlg =
861 (DialogTypeSelection)attributes.get(DialogTypeSelection.class);
862
863 // Check for native, note that default dialog is COMMON.
864 if (dlg == DialogTypeSelection.NATIVE) {
865 this.attributes = attributes;
866 try {
867 debug_println("calling setAttributes in printDialog");
868 setAttributes(attributes);
869
870 } catch (PrinterException e) {
871
872 }
873
874 boolean ret = printDialog();
875 this.attributes = attributes;
876 return ret;
877
878 }
879
880 /* A security check has already been performed in the
881 * java.awt.print.printerJob.getPrinterJob method.
882 * So by the time we get here, it is OK for the current thread
883 * to print either to a file (from a Dialog we control!) or
884 * to a chosen printer.
885 *
886 * We raise privilege when we put up the dialog, to avoid
887 * the "warning applet window" banner.
888 */
889 final GraphicsConfiguration gc =
890 GraphicsEnvironment.getLocalGraphicsEnvironment().
891 getDefaultScreenDevice().getDefaultConfiguration();
892
893 PrintService service = java.security.AccessController.doPrivileged(
894 new java.security.PrivilegedAction<PrintService>() {
895 public PrintService run() {
896 PrintService service = getPrintService();
897 if (service == null) {
898 ServiceDialog.showNoPrintService(gc);
899 return null;
900 }
901 return service;
902 }
903 });
904
905 if (service == null) {
906 return false;
907 }
908
909 PrintService[] services;
910 StreamPrintServiceFactory[] spsFactories = null;
911 if (service instanceof StreamPrintService) {
912 spsFactories = lookupStreamPrintServices(null);
913 services = new StreamPrintService[spsFactories.length];
914 for (int i=0; i<spsFactories.length; i++) {
915 services[i] = spsFactories[i].getPrintService(null);
916 }
917 } else {
918 services = java.security.AccessController.doPrivileged(
919 new java.security.PrivilegedAction<PrintService[]>() {
920 public PrintService[] run() {
921 PrintService[] services = PrinterJob.lookupPrintServices();
922 return services;
923 }
924 });
925
926 if ((services == null) || (services.length == 0)) {
927 /*
928 * No services but default PrintService exists?
929 * Create services using defaultService.
930 */
931 services = new PrintService[1];
932 services[0] = service;
933 }
934 }
935
936 Rectangle bounds = gc.getBounds();
937 int x = bounds.x+bounds.width/3;
938 int y = bounds.y+bounds.height/3;
939 PrintService newService;
940 // temporarily add an attribute pointing back to this job.
941 PrinterJobWrapper jobWrapper = new PrinterJobWrapper(this);
942 attributes.add(jobWrapper);
943 try {
944 newService =
945 ServiceUI.printDialog(gc, x, y,
946 services, service,
947 DocFlavor.SERVICE_FORMATTED.PAGEABLE,
948 attributes);
949 } catch (IllegalArgumentException iae) {
950 newService = ServiceUI.printDialog(gc, x, y,
951 services, services[0],
952 DocFlavor.SERVICE_FORMATTED.PAGEABLE,
953 attributes);
954 }
955 attributes.remove(PrinterJobWrapper.class);
956
957 if (newService == null) {
958 return false;
959 }
960
961 if (!service.equals(newService)) {
962 try {
963 setPrintService(newService);
964 } catch (PrinterException e) {
965 /*
966 * The only time it would throw an exception is when
967 * newService is no longer available but we should still
968 * select this printer.
969 */
970 myService = newService;
971 }
972 }
973 return true;
974 }
975
976 /**
977 * Presents the user a dialog for changing properties of the
978 * print job interactively.
979 * @return false if the user cancels the dialog and
980 * true otherwise.
981 * @exception HeadlessException if GraphicsEnvironment.isHeadless()
982 * returns true.
983 * @see java.awt.GraphicsEnvironment#isHeadless
984 */
985 public boolean printDialog() throws HeadlessException {
986
987 if (GraphicsEnvironment.isHeadless()) {
988 throw new HeadlessException();
989 }
990
991 PrintRequestAttributeSet attributes =
992 new HashPrintRequestAttributeSet();
993 attributes.add(new Copies(getCopies()));
994 attributes.add(new JobName(getJobName(), null));
995 boolean doPrint = printDialog(attributes);
996 if (doPrint) {
997 JobName jobName = (JobName)attributes.get(JobName.class);
998 if (jobName != null) {
999 setJobName(jobName.getValue());
1000 }
1001 Copies copies = (Copies)attributes.get(Copies.class);
1002 if (copies != null) {
1003 setCopies(copies.getValue());
1004 }
1005
1006 Destination dest = (Destination)attributes.get(Destination.class);
1007
1008 if (dest != null) {
1009 try {
1010 mDestType = RasterPrinterJob.FILE;
1011 mDestination = (new File(dest.getURI())).getPath();
1012 } catch (Exception e) {
1013 mDestination = "out.prn";
1014 PrintService ps = getPrintService();
1015 if (ps != null) {
1016 Destination defaultDest = (Destination)ps.
1017 getDefaultAttributeValue(Destination.class);
1018 if (defaultDest != null) {
1019 mDestination = (new File(defaultDest.getURI())).getPath();
1020 }
1021 }
1022 }
1023 } else {
1024 mDestType = RasterPrinterJob.PRINTER;
1025 PrintService ps = getPrintService();
1026 if (ps != null) {
1027 mDestination = ps.getName();
1028 }
1029 }
1030 }
1031
1032 return doPrint;
1033 }
1034
1035 /**
1036 * The pages in the document to be printed by this PrinterJob
1037 * are drawn by the Printable object 'painter'. The PageFormat
1038 * for each page is the default page format.
1039 * @param painter Called to render each page of the document.
1040 */
1041 public void setPrintable(Printable painter) {
1042 setPageable(new OpenBook(defaultPage(new PageFormat()), painter));
1043 }
1044
1045 /**
1046 * The pages in the document to be printed by this PrinterJob
1047 * are drawn by the Printable object 'painter'. The PageFormat
1048 * of each page is 'format'.
1049 * @param painter Called to render each page of the document.
1050 * @param format The size and orientation of each page to
1051 * be printed.
1052 */
1053 public void setPrintable(Printable painter, PageFormat format) {
1054 setPageable(new OpenBook(format, painter));
1055 updatePageAttributes(getPrintService(), format);
1056 }
1057
1058 /**
1059 * The pages in the document to be printed are held by the
1060 * Pageable instance 'document'. 'document' will be queried
1061 * for the number of pages as well as the PageFormat and
1062 * Printable for each page.
1063 * @param document The document to be printed. It may not be null.
1064 * @exception NullPointerException the Pageable passed in was null.
1065 * @see PageFormat
1066 * @see Printable
1067 */
1068 public void setPageable(Pageable document) throws NullPointerException {
1069 if (document != null) {
1070 mDocument = document;
1071
1072 } else {
1073 throw new NullPointerException();
1074 }
1075 }
1076
1077 protected void initPrinter() {
1078 return;
1079 }
1080
1081 protected boolean isSupportedValue(Attribute attrval,
1082 PrintRequestAttributeSet attrset) {
1083 PrintService ps = getPrintService();
1084 return
1085 (attrval != null && ps != null &&
1086 ps.isAttributeValueSupported(attrval,
1087 DocFlavor.SERVICE_FORMATTED.PAGEABLE,
1088 attrset));
1089 }
1090
1091 /**
1092 * Set the device resolution.
1093 * Overridden and used only by the postscript code.
1094 * Windows code pulls the information from the attribute set itself.
1095 */
1096 protected void setXYRes(double x, double y) {
1097 }
1098
1099 /* subclasses may need to pull extra information out of the attribute set
1100 * They can override this method & call super.setAttributes()
1101 */
1102 protected void setAttributes(PrintRequestAttributeSet attributes)
1103 throws PrinterException {
1104 /* reset all values to defaults */
1105 setCollated(false);
1106 sidesAttr = null;
1107 printerResAttr = null;
1108 pageRangesAttr = null;
1109 copiesAttr = 0;
1110 jobNameAttr = null;
1111 userNameAttr = null;
1112 destinationAttr = null;
1113 collateAttReq = false;
1114
1115 PrintService service = getPrintService();
1116 if (attributes == null || service == null) {
1117 return;
1118 }
1119
1120 boolean fidelity = false;
1121 Fidelity attrFidelity = (Fidelity)attributes.get(Fidelity.class);
1122 if (attrFidelity != null && attrFidelity == Fidelity.FIDELITY_TRUE) {
1123 fidelity = true;
1124 }
1125
1126 if (fidelity == true) {
1127 AttributeSet unsupported =
1128 service.getUnsupportedAttributes(
1129 DocFlavor.SERVICE_FORMATTED.PAGEABLE,
1130 attributes);
1131 if (unsupported != null) {
1132 throw new PrinterException("Fidelity cannot be satisfied");
1133 }
1134 }
1135
1136 /*
1137 * Since we have verified supported values if fidelity is true,
1138 * we can either ignore unsupported values, or substitute a
1139 * reasonable alternative
1140 */
1141
1142 SheetCollate collateAttr =
1143 (SheetCollate)attributes.get(SheetCollate.class);
1144 if (isSupportedValue(collateAttr, attributes)) {
1145 setCollated(collateAttr == SheetCollate.COLLATED);
1146 }
1147
1148 sidesAttr = (Sides)attributes.get(Sides.class);
1149 if (!isSupportedValue(sidesAttr, attributes)) {
1150 sidesAttr = Sides.ONE_SIDED;
1151 }
1152
1153 printerResAttr = (PrinterResolution)attributes.get(PrinterResolution.class);
1154 if (service.isAttributeCategorySupported(PrinterResolution.class)) {
1155 if (!isSupportedValue(printerResAttr, attributes)) {
1156 printerResAttr = (PrinterResolution)
1157 service.getDefaultAttributeValue(PrinterResolution.class);
1158 }
1159 double xr =
1160 printerResAttr.getCrossFeedResolution(ResolutionSyntax.DPI);
1161 double yr = printerResAttr.getFeedResolution(ResolutionSyntax.DPI);
1162 setXYRes(xr, yr);
1163 }
1164
1165 pageRangesAttr = (PageRanges)attributes.get(PageRanges.class);
1166 if (!isSupportedValue(pageRangesAttr, attributes)) {
1167 pageRangesAttr = null;
1168 } else {
1169 if ((SunPageSelection)attributes.get(SunPageSelection.class)
1170 == SunPageSelection.RANGE) {
1171 // get to, from, min, max page ranges
1172 int[][] range = pageRangesAttr.getMembers();
1173 // setPageRanges uses 0-based indexing so we subtract 1
1174 setPageRange(range[0][0] - 1, range[0][1] - 1);
1175 } else {
1176 setPageRange(-1, - 1);
1177 }
1178 }
1179
1180 Copies copies = (Copies)attributes.get(Copies.class);
1181 if (isSupportedValue(copies, attributes) ||
1182 (!fidelity && copies != null)) {
1183 copiesAttr = copies.getValue();
1184 setCopies(copiesAttr);
1185 } else {
1186 copiesAttr = getCopies();
1187 }
1188
1189 Destination destination =
1190 (Destination)attributes.get(Destination.class);
1191
1192 if (isSupportedValue(destination, attributes)) {
1193 try {
1194 // Old code (new File(destination.getURI())).getPath()
1195 // would generate a "URI is not hierarchical" IAE
1196 // for "file:out.prn" so we use getSchemeSpecificPart instead
1197 destinationAttr = "" + new File(destination.getURI().
1198 getSchemeSpecificPart());
1199 } catch (Exception e) { // paranoid exception
1200 Destination defaultDest = (Destination)service.
1201 getDefaultAttributeValue(Destination.class);
1202 if (defaultDest != null) {
1203 destinationAttr = "" + new File(defaultDest.getURI().
1204 getSchemeSpecificPart());
1205 }
1206 }
1207 }
1208
1209 JobSheets jobSheets = (JobSheets)attributes.get(JobSheets.class);
1210 if (jobSheets != null) {
1211 noJobSheet = jobSheets == JobSheets.NONE;
1212 }
1213
1214 JobName jobName = (JobName)attributes.get(JobName.class);
1215 if (isSupportedValue(jobName, attributes) ||
1216 (!fidelity && jobName != null)) {
1217 jobNameAttr = jobName.getValue();
1218 setJobName(jobNameAttr);
1219 } else {
1220 jobNameAttr = getJobName();
1221 }
1222
1223 RequestingUserName userName =
1224 (RequestingUserName)attributes.get(RequestingUserName.class);
1225 if (isSupportedValue(userName, attributes) ||
1226 (!fidelity && userName != null)) {
1227 userNameAttr = userName.getValue();
1228 } else {
1229 try {
1230 userNameAttr = getUserName();
1231 } catch (SecurityException e) {
1232 userNameAttr = "";
1233 }
1234 }
1235
1236 /* OpenBook is used internally only when app uses Printable.
1237 * This is the case when we use the values from the attribute set.
1238 */
1239 Media media = (Media)attributes.get(Media.class);
1240 OrientationRequested orientReq =
1241 (OrientationRequested)attributes.get(OrientationRequested.class);
1242 MediaPrintableArea mpa =
1243 (MediaPrintableArea)attributes.get(MediaPrintableArea.class);
1244
1245 if ((orientReq != null || media != null || mpa != null) &&
1246 getPageable() instanceof OpenBook) {
1247
1248 /* We could almost(!) use PrinterJob.getPageFormat() except
1249 * here we need to start with the PageFormat from the OpenBook :
1250 */
1251 Pageable pageable = getPageable();
1252 Printable printable = pageable.getPrintable(0);
1253 PageFormat pf = (PageFormat)pageable.getPageFormat(0).clone();
1254 Paper paper = pf.getPaper();
1255
1256 /* If there's a media but no media printable area, we can try
1257 * to retrieve the default value for mpa and use that.
1258 */
1259 if (mpa == null && media != null &&
1260 service.
1261 isAttributeCategorySupported(MediaPrintableArea.class)) {
1262 Object mpaVals = service.
1263 getSupportedAttributeValues(MediaPrintableArea.class,
1264 null, attributes);
1265 if (mpaVals instanceof MediaPrintableArea[] &&
1266 ((MediaPrintableArea[])mpaVals).length > 0) {
1267 mpa = ((MediaPrintableArea[])mpaVals)[0];
1268 }
1269 }
1270
1271 if (isSupportedValue(orientReq, attributes) ||
1272 (!fidelity && orientReq != null)) {
1273 int orient;
1274 if (orientReq.equals(OrientationRequested.REVERSE_LANDSCAPE)) {
1275 orient = PageFormat.REVERSE_LANDSCAPE;
1276 } else if (orientReq.equals(OrientationRequested.LANDSCAPE)) {
1277 orient = PageFormat.LANDSCAPE;
1278 } else {
1279 orient = PageFormat.PORTRAIT;
1280 }
1281 pf.setOrientation(orient);
1282 }
1283
1284 if (isSupportedValue(media, attributes) ||
1285 (!fidelity && media != null)) {
1286 if (media instanceof MediaSizeName) {
1287 MediaSizeName msn = (MediaSizeName)media;
1288 MediaSize msz = MediaSize.getMediaSizeForName(msn);
1289 if (msz != null) {
1290 float paperWid = msz.getX(MediaSize.INCH) * 72.0f;
1291 float paperHgt = msz.getY(MediaSize.INCH) * 72.0f;
1292 paper.setSize(paperWid, paperHgt);
1293 if (mpa == null) {
1294 paper.setImageableArea(72.0, 72.0,
1295 paperWid-144.0,
1296 paperHgt-144.0);
1297 }
1298 }
1299 }
1300 }
1301
1302 if (isSupportedValue(mpa, attributes) ||
1303 (!fidelity && mpa != null)) {
1304 float [] printableArea =
1305 mpa.getPrintableArea(MediaPrintableArea.INCH);
1306 for (int i=0; i < printableArea.length; i++) {
1307 printableArea[i] = printableArea[i]*72.0f;
1308 }
1309 paper.setImageableArea(printableArea[0], printableArea[1],
1310 printableArea[2], printableArea[3]);
1311 }
1312
1313 pf.setPaper(paper);
1314 pf = validatePage(pf);
1315 setPrintable(printable, pf);
1316 } else {
1317 // for AWT where pageable is not an instance of OpenBook,
1318 // we need to save paper info
1319 this.attributes = attributes;
1320 }
1321
1322 }
1323
1324 /*
1325 * Services we don't recognize as built-in services can't be
1326 * implemented as subclasses of PrinterJob, therefore we create
1327 * a DocPrintJob from their service and pass a Doc representing
1328 * the application's printjob
1329 */
1330 // MacOSX - made protected so subclasses can reference it.
1331 protected void spoolToService(PrintService psvc,
1332 PrintRequestAttributeSet attributes)
1333 throws PrinterException {
1334
1335 if (psvc == null) {
1336 throw new PrinterException("No print service found.");
1337 }
1338
1339 DocPrintJob job = psvc.createPrintJob();
1340 Doc doc = new PageableDoc(getPageable());
1341 if (attributes == null) {
1342 attributes = new HashPrintRequestAttributeSet();
1343 }
1344 try {
1345 job.print(doc, attributes);
1346 } catch (PrintException e) {
1347 throw new PrinterException(e.toString());
1348 }
1349 }
1350
1351 /**
1352 * Prints a set of pages.
1353 * @exception java.awt.print.PrinterException an error in the print system
1354 * caused the job to be aborted
1355 * @see java.awt.print.Book
1356 * @see java.awt.print.Pageable
1357 * @see java.awt.print.Printable
1358 */
1359 public void print() throws PrinterException {
1360 print(attributes);
1361 }
1362
1363 public static boolean debugPrint = false;
1364 protected void debug_println(String str) {
1365 if (debugPrint) {
1366 System.out.println("RasterPrinterJob "+str+" "+this);
1367 }
1368 }
1369
1370 public void print(PrintRequestAttributeSet attributes)
1371 throws PrinterException {
1372
1373 /*
1374 * In the future PrinterJob will probably always dispatch
1375 * the print job to the PrintService.
1376 * This is how third party 2D Print Services will be invoked
1377 * when applications use the PrinterJob API.
1378 * However the JRE's concrete PrinterJob implementations have
1379 * not yet been re-worked to be implemented as standalone
1380 * services, and are implemented only as subclasses of PrinterJob.
1381 * So here we dispatch only those services we do not recognize
1382 * as implemented through platform subclasses of PrinterJob
1383 * (and this class).
1384 */
1385 PrintService psvc = getPrintService();
1386 debug_println("psvc = "+psvc);
1387 if (psvc == null) {
1388 throw new PrinterException("No print service found.");
1389 }
1390
1391 // Check the list of services. This service may have been
1392 // deleted already
1393 PrinterState prnState = psvc.getAttribute(PrinterState.class);
1394 if (prnState == PrinterState.STOPPED) {
1395 PrinterStateReasons prnStateReasons =
1396 psvc.getAttribute(PrinterStateReasons.class);
1397 if ((prnStateReasons != null) &&
1398 (prnStateReasons.containsKey(PrinterStateReason.SHUTDOWN)))
1399 {
1400 throw new PrinterException("PrintService is no longer available.");
1401 }
1402 }
1403
1404 if ((psvc.getAttribute(PrinterIsAcceptingJobs.class)) ==
1405 PrinterIsAcceptingJobs.NOT_ACCEPTING_JOBS) {
1406 throw new PrinterException("Printer is not accepting job.");
1407 }
1408
1409 if ((psvc instanceof SunPrinterJobService) &&
1410 ((SunPrinterJobService)psvc).usesClass(getClass())) {
1411 setAttributes(attributes);
1412 // throw exception for invalid destination
1413 if (destinationAttr != null) {
1414 validateDestination(destinationAttr);
1415 }
1416 } else {
1417 spoolToService(psvc, attributes);
1418 return;
1419 }
1420 /* We need to make sure that the collation and copies
1421 * settings are initialised */
1422 initPrinter();
1423
1424 int numCollatedCopies = getCollatedCopies();
1425 int numNonCollatedCopies = getNoncollatedCopies();
1426 debug_println("getCollatedCopies() "+numCollatedCopies
1427 + " getNoncollatedCopies() "+ numNonCollatedCopies);
1428
1429 /* Get the range of pages we are to print. If the
1430 * last page to print is unknown, then we print to
1431 * the end of the document. Note that firstPage
1432 * and lastPage are 0 based page indices.
1433 */
1434 int numPages = mDocument.getNumberOfPages();
1435 if (numPages == 0) {
1436 return;
1437 }
1438
1439 int firstPage = getFirstPage();
1440 int lastPage = getLastPage();
1441 if(lastPage == Pageable.UNKNOWN_NUMBER_OF_PAGES){
1442 int totalPages = mDocument.getNumberOfPages();
1443 if (totalPages != Pageable.UNKNOWN_NUMBER_OF_PAGES) {
1444 lastPage = mDocument.getNumberOfPages() - 1;
1445 }
1446 }
1447
1448 try {
1449 synchronized (this) {
1450 performingPrinting = true;
1451 userCancelled = false;
1452 }
1453
1454 startDoc();
1455 if (isCancelled()) {
1456 cancelDoc();
1457 }
1458
1459 // PageRanges can be set even if RANGE is not selected
1460 // so we need to check if it is selected.
1461 boolean rangeIsSelected = true;
1462 if (attributes != null) {
1463 SunPageSelection pages =
1464 (SunPageSelection)attributes.get(SunPageSelection.class);
1465 if ((pages != null) && (pages != SunPageSelection.RANGE)) {
1466 rangeIsSelected = false;
1467 }
1468 }
1469
1470
1471 debug_println("after startDoc rangeSelected? "+rangeIsSelected
1472 + " numNonCollatedCopies "+ numNonCollatedCopies);
1473
1474
1475 /* Three nested loops iterate over the document. The outer loop
1476 * counts the number of collated copies while the inner loop
1477 * counts the number of nonCollated copies. Normally, one of
1478 * these two loops will only execute once; that is we will
1479 * either print collated copies or noncollated copies. The
1480 * middle loop iterates over the pages.
1481 * If a PageRanges attribute is used, it constrains the pages
1482 * that are imaged. If a platform subclass (though a user dialog)
1483 * requests a page range via setPageRange(). it too can
1484 * constrain the page ranges that are imaged.
1485 * It is expected that only one of these will be used in a
1486 * job but both should be able to co-exist.
1487 */
1488 for(int collated = 0; collated < numCollatedCopies; collated++) {
1489 for(int i = firstPage, pageResult = Printable.PAGE_EXISTS;
1490 (i <= lastPage ||
1491 lastPage == Pageable.UNKNOWN_NUMBER_OF_PAGES)
1492 && pageResult == Printable.PAGE_EXISTS;
1493 i++)
1494 {
1495
1496 if ((pageRangesAttr != null) && rangeIsSelected ){
1497 int nexti = pageRangesAttr.next(i);
1498 if (nexti == -1) {
1499 break;
1500 } else if (nexti != i+1) {
1501 continue;
1502 }
1503 }
1504
1505 for(int nonCollated = 0;
1506 nonCollated < numNonCollatedCopies
1507 && pageResult == Printable.PAGE_EXISTS;
1508 nonCollated++)
1509 {
1510 if (isCancelled()) {
1511 cancelDoc();
1512 }
1513 debug_println("printPage "+i);
1514 pageResult = printPage(mDocument, i);
1515
1516 }
1517 }
1518 }
1519
1520 if (isCancelled()) {
1521 cancelDoc();
1522 }
1523
1524 } finally {
1525 // reset previousPaper in case this job is invoked again.
1526 previousPaper = null;
1527 synchronized (this) {
1528 if (performingPrinting) {
1529 endDoc();
1530 }
1531 performingPrinting = false;
1532 notify();
1533 }
1534 }
1535 }
1536
1537 protected void validateDestination(String dest) throws PrinterException {
1538 if (dest == null) {
1539 return;
1540 }
1541 // dest is null for Destination(new URI(""))
1542 // because isAttributeValueSupported returns false in setAttributes
1543
1544 // Destination(new URI(" ")) throws URISyntaxException
1545 File f = new File(dest);
1546 try {
1547 // check if this is a new file and if filename chars are valid
1548 if (f.createNewFile()) {
1549 f.delete();
1550 }
1551 } catch (IOException ioe) {
1552 throw new PrinterException("Cannot write to file:"+
1553 dest);
1554 } catch (SecurityException se) {
1555 //There is already file read/write access so at this point
1556 // only delete access is denied. Just ignore it because in
1557 // most cases the file created in createNewFile gets overwritten
1558 // anyway.
1559 }
1560
1561 File pFile = f.getParentFile();
1562 if ((f.exists() &&
1563 (!f.isFile() || !f.canWrite())) ||
1564 ((pFile != null) &&
1565 (!pFile.exists() || (pFile.exists() && !pFile.canWrite())))) {
1566 throw new PrinterException("Cannot write to file:"+
1567 dest);
1568 }
1569 }
1570
1571 /**
1572 * updates a Paper object to reflect the current printer's selected
1573 * paper size and imageable area for that paper size.
1574 * Default implementation copies settings from the original, applies
1575 * applies some validity checks, changes them only if they are
1576 * clearly unreasonable, then sets them into the new Paper.
1577 * Subclasses are expected to override this method to make more
1578 * informed decisons.
1579 */
1580 protected void validatePaper(Paper origPaper, Paper newPaper) {
1581 if (origPaper == null || newPaper == null) {
1582 return;
1583 } else {
1584 double wid = origPaper.getWidth();
1585 double hgt = origPaper.getHeight();
1586 double ix = origPaper.getImageableX();
1587 double iy = origPaper.getImageableY();
1588 double iw = origPaper.getImageableWidth();
1589 double ih = origPaper.getImageableHeight();
1590
1591 /* Assume any +ve values are legal. Overall paper dimensions
1592 * take precedence. Make sure imageable area fits on the paper.
1593 */
1594 Paper defaultPaper = new Paper();
1595 wid = ((wid > 0.0) ? wid : defaultPaper.getWidth());
1596 hgt = ((hgt > 0.0) ? hgt : defaultPaper.getHeight());
1597 ix = ((ix > 0.0) ? ix : defaultPaper.getImageableX());
1598 iy = ((iy > 0.0) ? iy : defaultPaper.getImageableY());
1599 iw = ((iw > 0.0) ? iw : defaultPaper.getImageableWidth());
1600 ih = ((ih > 0.0) ? ih : defaultPaper.getImageableHeight());
1601 /* full width/height is not likely to be imageable, but since we
1602 * don't know the limits we have to allow it
1603 */
1604 if (iw > wid) {
1605 iw = wid;
1606 }
1607 if (ih > hgt) {
1608 ih = hgt;
1609 }
1610 if ((ix + iw) > wid) {
1611 ix = wid - iw;
1612 }
1613 if ((iy + ih) > hgt) {
1614 iy = hgt - ih;
1615 }
1616 newPaper.setSize(wid, hgt);
1617 newPaper.setImageableArea(ix, iy, iw, ih);
1618 }
1619 }
1620
1621 /**
1622 * The passed in PageFormat will be copied and altered to describe
1623 * the default page size and orientation of the PrinterJob's
1624 * current printer.
1625 * Platform subclasses which can access the actual default paper size
1626 * for a printer may override this method.
1627 */
1628 public PageFormat defaultPage(PageFormat page) {
1629 PageFormat newPage = (PageFormat)page.clone();
1630 newPage.setOrientation(PageFormat.PORTRAIT);
1631 Paper newPaper = new Paper();
1632 double ptsPerInch = 72.0;
1633 double w, h;
1634 Media media = null;
1635
1636 PrintService service = getPrintService();
1637 if (service != null) {
1638 MediaSize size;
1639 media =
1640 (Media)service.getDefaultAttributeValue(Media.class);
1641
1642 if (media instanceof MediaSizeName &&
1643 ((size = MediaSize.getMediaSizeForName((MediaSizeName)media)) !=
1644 null)) {
1645 w = size.getX(MediaSize.INCH) * ptsPerInch;
1646 h = size.getY(MediaSize.INCH) * ptsPerInch;
1647 newPaper.setSize(w, h);
1648 newPaper.setImageableArea(ptsPerInch, ptsPerInch,
1649 w - 2.0*ptsPerInch,
1650 h - 2.0*ptsPerInch);
1651 newPage.setPaper(newPaper);
1652 return newPage;
1653
1654 }
1655 }
1656
1657 /* Default to A4 paper outside North America.
1658 */
1659 String defaultCountry = Locale.getDefault().getCountry();
1660 if (!Locale.getDefault().equals(Locale.ENGLISH) && // ie "C"
1661 defaultCountry != null &&
1662 !defaultCountry.equals(Locale.US.getCountry()) &&
1663 !defaultCountry.equals(Locale.CANADA.getCountry())) {
1664
1665 double mmPerInch = 25.4;
1666 w = Math.rint((210.0*ptsPerInch)/mmPerInch);
1667 h = Math.rint((297.0*ptsPerInch)/mmPerInch);
1668 newPaper.setSize(w, h);
1669 newPaper.setImageableArea(ptsPerInch, ptsPerInch,
1670 w - 2.0*ptsPerInch,
1671 h - 2.0*ptsPerInch);
1672 }
1673
1674 newPage.setPaper(newPaper);
1675
1676 return newPage;
1677 }
1678
1679 /**
1680 * The passed in PageFormat is cloned and altered to be usable on
1681 * the PrinterJob's current printer.
1682 */
1683 public PageFormat validatePage(PageFormat page) {
1684 PageFormat newPage = (PageFormat)page.clone();
1685 Paper newPaper = new Paper();
1686 validatePaper(newPage.getPaper(), newPaper);
1687 newPage.setPaper(newPaper);
1688
1689 return newPage;
1690 }
1691
1692 /**
1693 * Set the number of copies to be printed.
1694 */
1695 public void setCopies(int copies) {
1696 mNumCopies = copies;
1697 }
1698
1699 /**
1700 * Get the number of copies to be printed.
1701 */
1702 public int getCopies() {
1703 return mNumCopies;
1704 }
1705
1706 /* Used when executing a print job where an attribute set may
1707 * over ride API values.
1708 */
1709 protected int getCopiesInt() {
1710 return (copiesAttr > 0) ? copiesAttr : getCopies();
1711 }
1712
1713 /**
1714 * Get the name of the printing user.
1715 * The caller must have security permission to read system properties.
1716 */
1717 public String getUserName() {
1718 return System.getProperty("user.name");
1719 }
1720
1721 /* Used when executing a print job where an attribute set may
1722 * over ride API values.
1723 */
1724 protected String getUserNameInt() {
1725 if (userNameAttr != null) {
1726 return userNameAttr;
1727 } else {
1728 try {
1729 return getUserName();
1730 } catch (SecurityException e) {
1731 return "";
1732 }
1733 }
1734 }
1735
1736 /**
1737 * Set the name of the document to be printed.
1738 * The document name can not be null.
1739 */
1740 public void setJobName(String jobName) {
1741 if (jobName != null) {
1742 mDocName = jobName;
1743 } else {
1744 throw new NullPointerException();
1745 }
1746 }
1747
1748 /**
1749 * Get the name of the document to be printed.
1750 */
1751 public String getJobName() {
1752 return mDocName;
1753 }
1754
1755 /* Used when executing a print job where an attribute set may
1756 * over ride API values.
1757 */
1758 protected String getJobNameInt() {
1759 return (jobNameAttr != null) ? jobNameAttr : getJobName();
1760 }
1761
1762 /**
1763 * Set the range of pages from a Book to be printed.
1764 * Both 'firstPage' and 'lastPage' are zero based
1765 * page indices. If either parameter is less than
1766 * zero then the page range is set to be from the
1767 * first page to the last.
1768 */
1769 protected void setPageRange(int firstPage, int lastPage) {
1770 if(firstPage >= 0 && lastPage >= 0) {
1771 mFirstPage = firstPage;
1772 mLastPage = lastPage;
1773 if(mLastPage < mFirstPage) mLastPage = mFirstPage;
1774 } else {
1775 mFirstPage = Pageable.UNKNOWN_NUMBER_OF_PAGES;
1776 mLastPage = Pageable.UNKNOWN_NUMBER_OF_PAGES;
1777 }
1778 }
1779
1780 /**
1781 * Return the zero based index of the first page to
1782 * be printed in this job.
1783 */
1784 protected int getFirstPage() {
1785 return mFirstPage == Book.UNKNOWN_NUMBER_OF_PAGES ? 0 : mFirstPage;
1786 }
1787
1788 /**
1789 * Return the zero based index of the last page to
1790 * be printed in this job.
1791 */
1792 protected int getLastPage() {
1793 return mLastPage;
1794 }
1795
1796 /**
1797 * Set whether copies should be collated or not.
1798 * Two collated copies of a three page document
1799 * print in this order: 1, 2, 3, 1, 2, 3 while
1800 * uncollated copies print in this order:
1801 * 1, 1, 2, 2, 3, 3.
1802 * This is set when request is using an attribute set.
1803 */
1804 protected void setCollated(boolean collate) {
1805 mCollate = collate;
1806 collateAttReq = true;
1807 }
1808
1809 /**
1810 * Return true if collated copies will be printed as determined
1811 * in an attribute set.
1812 */
1813 protected boolean isCollated() {
1814 return mCollate;
1815 }
1816
1817 protected final int getSelectAttrib() {
1818 if (attributes != null) {
1819 SunPageSelection pages =
1820 (SunPageSelection)attributes.get(SunPageSelection.class);
1821 if (pages == SunPageSelection.RANGE) {
1822 return PD_PAGENUMS;
1823 } else if (pages == SunPageSelection.SELECTION) {
1824 return PD_SELECTION;
1825 } else if (pages == SunPageSelection.ALL) {
1826 return PD_ALLPAGES;
1827 }
1828 }
1829 return PD_NOSELECTION;
1830 }
1831
1832 //returns 1-based index for "From" page
1833 protected final int getFromPageAttrib() {
1834 if (attributes != null) {
1835 PageRanges pageRangesAttr =
1836 (PageRanges)attributes.get(PageRanges.class);
1837 if (pageRangesAttr != null) {
1838 int[][] range = pageRangesAttr.getMembers();
1839 return range[0][0];
1840 }
1841 }
1842 return getMinPageAttrib();
1843 }
1844
1845 //returns 1-based index for "To" page
1846 protected final int getToPageAttrib() {
1847 if (attributes != null) {
1848 PageRanges pageRangesAttr =
1849 (PageRanges)attributes.get(PageRanges.class);
1850 if (pageRangesAttr != null) {
1851 int[][] range = pageRangesAttr.getMembers();
1852 return range[range.length-1][1];
1853 }
1854 }
1855 return getMaxPageAttrib();
1856 }
1857
1858 protected final int getMinPageAttrib() {
1859 if (attributes != null) {
1860 SunMinMaxPage s =
1861 (SunMinMaxPage)attributes.get(SunMinMaxPage.class);
1862 if (s != null) {
1863 return s.getMin();
1864 }
1865 }
1866 return 1;
1867 }
1868
1869 protected final int getMaxPageAttrib() {
1870 if (attributes != null) {
1871 SunMinMaxPage s =
1872 (SunMinMaxPage)attributes.get(SunMinMaxPage.class);
1873 if (s != null) {
1874 return s.getMax();
1875 }
1876 }
1877
1878 Pageable pageable = getPageable();
1879 if (pageable != null) {
1880 int numPages = pageable.getNumberOfPages();
1881 if (numPages <= Pageable.UNKNOWN_NUMBER_OF_PAGES) {
1882 numPages = MAX_UNKNOWN_PAGES;
1883 }
1884 return ((numPages == 0) ? 1 : numPages);
1885 }
1886
1887 return Integer.MAX_VALUE;
1888 }
1889 /**
1890 * Called by the print() method at the start of
1891 * a print job.
1892 */
1893 protected abstract void startDoc() throws PrinterException;
1894
1895 /**
1896 * Called by the print() method at the end of
1897 * a print job.
1898 */
1899 protected abstract void endDoc() throws PrinterException;
1900
1901 /* Called by cancelDoc */
1902 protected abstract void abortDoc();
1903
1904 // MacOSX - made protected so subclasses can reference it.
1905 protected void cancelDoc() throws PrinterAbortException {
1906 abortDoc();
1907 synchronized (this) {
1908 userCancelled = false;
1909 performingPrinting = false;
1910 notify();
1911 }
1912 throw new PrinterAbortException();
1913 }
1914
1915 /**
1916 * Returns how many times the entire book should
1917 * be printed by the PrintJob. If the printer
1918 * itself supports collation then this method
1919 * should return 1 indicating that the entire
1920 * book need only be printed once and the copies
1921 * will be collated and made in the printer.
1922 */
1923 protected int getCollatedCopies() {
1924 return isCollated() ? getCopiesInt() : 1;
1925 }
1926
1927 /**
1928 * Returns how many times each page in the book
1929 * should be consecutively printed by PrintJob.
1930 * If the printer makes copies itself then this
1931 * method should return 1.
1932 */
1933 protected int getNoncollatedCopies() {
1934 return isCollated() ? 1 : getCopiesInt();
1935 }
1936
1937
1938 /* The printer graphics config is cached on the job, so that it can
1939 * be created once, and updated only as needed (for now only to change
1940 * the bounds if when using a Pageable the page sizes changes).
1941 */
1942
1943 private int deviceWidth, deviceHeight;
1944 private AffineTransform defaultDeviceTransform;
1945 private PrinterGraphicsConfig pgConfig;
1946
1947 synchronized void setGraphicsConfigInfo(AffineTransform at,
1948 double pw, double ph) {
1949 Point2D.Double pt = new Point2D.Double(pw, ph);
1950 at.transform(pt, pt);
1951
1952 if (pgConfig == null ||
1953 defaultDeviceTransform == null ||
1954 !at.equals(defaultDeviceTransform) ||
1955 deviceWidth != (int)pt.getX() ||
1956 deviceHeight != (int)pt.getY()) {
1957
1958 deviceWidth = (int)pt.getX();
1959 deviceHeight = (int)pt.getY();
1960 defaultDeviceTransform = at;
1961 pgConfig = null;
1962 }
1963 }
1964
1965 synchronized PrinterGraphicsConfig getPrinterGraphicsConfig() {
1966 if (pgConfig != null) {
1967 return pgConfig;
1968 }
1969 String deviceID = "Printer Device";
1970 PrintService service = getPrintService();
1971 if (service != null) {
1972 deviceID = service.toString();
1973 }
1974 pgConfig = new PrinterGraphicsConfig(deviceID,
1975 defaultDeviceTransform,
1976 deviceWidth, deviceHeight);
1977 return pgConfig;
1978 }
1979
1980 /**
1981 * Print a page from the provided document.
1982 * @return int Printable.PAGE_EXISTS if the page existed and was drawn and
1983 * Printable.NO_SUCH_PAGE if the page did not exist.
1984 * @see java.awt.print.Printable
1985 */
1986 protected int printPage(Pageable document, int pageIndex)
1987 throws PrinterException
1988 {
1989 PageFormat page;
1990 PageFormat origPage;
1991 Printable painter;
1992 try {
1993 origPage = document.getPageFormat(pageIndex);
1994 page = (PageFormat)origPage.clone();
1995 painter = document.getPrintable(pageIndex);
1996 } catch (Exception e) {
1997 PrinterException pe =
1998 new PrinterException("Error getting page or printable.[ " +
1999 e +" ]");
2000 pe.initCause(e);
2001 throw pe;
2002 }
2003
2004 /* Get the imageable area from Paper instead of PageFormat
2005 * because we do not want it adjusted by the page orientation.
2006 */
2007 Paper paper = page.getPaper();
2008 // if non-portrait and 270 degree landscape rotation
2009 if (page.getOrientation() != PageFormat.PORTRAIT &&
2010 landscapeRotates270) {
2011
2012 double left = paper.getImageableX();
2013 double top = paper.getImageableY();
2014 double width = paper.getImageableWidth();
2015 double height = paper.getImageableHeight();
2016 paper.setImageableArea(paper.getWidth()-left-width,
2017 paper.getHeight()-top-height,
2018 width, height);
2019 page.setPaper(paper);
2020 if (page.getOrientation() == PageFormat.LANDSCAPE) {
2021 page.setOrientation(PageFormat.REVERSE_LANDSCAPE);
2022 } else {
2023 page.setOrientation(PageFormat.LANDSCAPE);
2024 }
2025 }
2026
2027 double xScale = getXRes() / 72.0;
2028 double yScale = getYRes() / 72.0;
2029
2030 /* The deviceArea is the imageable area in the printer's
2031 * resolution.
2032 */
2033 Rectangle2D deviceArea =
2034 new Rectangle2D.Double(paper.getImageableX() * xScale,
2035 paper.getImageableY() * yScale,
2036 paper.getImageableWidth() * xScale,
2037 paper.getImageableHeight() * yScale);
2038
2039 /* Build and hold on to a uniform transform so that
2040 * we can get back to device space at the beginning
2041 * of each band.
2042 */
2043 AffineTransform uniformTransform = new AffineTransform();
2044
2045 /* The scale transform is used to switch from the
2046 * device space to the user's 72 dpi space.
2047 */
2048 AffineTransform scaleTransform = new AffineTransform();
2049 scaleTransform.scale(xScale, yScale);
2050
2051 /* bandwidth is multiple of 4 as the data is used in a win32 DIB and
2052 * some drivers behave badly if scanlines aren't multiples of 4 bytes.
2053 */
2054 int bandWidth = (int) deviceArea.getWidth();
2055 if (bandWidth % 4 != 0) {
2056 bandWidth += (4 - (bandWidth % 4));
2057 }
2058 if (bandWidth <= 0) {
2059 throw new PrinterException("Paper's imageable width is too small.");
2060 }
2061
2062 int deviceAreaHeight = (int)deviceArea.getHeight();
2063 if (deviceAreaHeight <= 0) {
2064 throw new PrinterException("Paper's imageable height is too small.");
2065 }
2066
2067 /* Figure out the number of lines that will fit into
2068 * our maximum band size. The hard coded 3 reflects the
2069 * fact that we can only create 24 bit per pixel 3 byte BGR
2070 * BufferedImages. FIX.
2071 */
2072 int bandHeight = (MAX_BAND_SIZE / bandWidth / 3);
2073
2074 int deviceLeft = (int)Math.rint(paper.getImageableX() * xScale);
2075 int deviceTop = (int)Math.rint(paper.getImageableY() * yScale);
2076
2077 /* The device transform is used to move the band down
2078 * the page using translates. Normally this is all it
2079 * would do, but since, when printing, the Window's
2080 * DIB format wants the last line to be first (lowest) in
2081 * memory, the deviceTransform moves the origin to the
2082 * bottom of the band and flips the origin. This way the
2083 * app prints upside down into the band which is the DIB
2084 * format.
2085 */
2086 AffineTransform deviceTransform = new AffineTransform();
2087 deviceTransform.translate(-deviceLeft, deviceTop);
2088 deviceTransform.translate(0, bandHeight);
2089 deviceTransform.scale(1, -1);
2090
2091 /* Create a BufferedImage to hold the band. We set the clip
2092 * of the band to be tight around the bits so that the
2093 * application can use it to figure what part of the
2094 * page needs to be drawn. The clip is never altered in
2095 * this method, but we do translate the band's coordinate
2096 * system so that the app will see the clip moving down the
2097 * page though it s always around the same set of pixels.
2098 */
2099 BufferedImage pBand = new BufferedImage(1, 1,
2100 BufferedImage.TYPE_3BYTE_BGR);
2101
2102 /* Have the app draw into a PeekGraphics object so we can
2103 * learn something about the needs of the print job.
2104 */
2105
2106 PeekGraphics peekGraphics = createPeekGraphics(pBand.createGraphics(),
2107 this);
2108
2109 Rectangle2D.Double pageFormatArea =
2110 new Rectangle2D.Double(page.getImageableX(),
2111 page.getImageableY(),
2112 page.getImageableWidth(),
2113 page.getImageableHeight());
2114 peekGraphics.transform(scaleTransform);
2115 peekGraphics.translate(-getPhysicalPrintableX(paper) / xScale,
2116 -getPhysicalPrintableY(paper) / yScale);
2117 peekGraphics.transform(new AffineTransform(page.getMatrix()));
2118 initPrinterGraphics(peekGraphics, pageFormatArea);
2119 AffineTransform pgAt = peekGraphics.getTransform();
2120
2121 /* Update the information used to return a GraphicsConfiguration
2122 * for this printer device. It needs to be updated per page as
2123 * not all pages in a job may be the same size (different bounds)
2124 * The transform is the scaling transform as this corresponds to
2125 * the default transform for the device. The width and height are
2126 * those of the paper, not the page format, as we want to describe
2127 * the bounds of the device in its natural coordinate system of
2128 * device coordinate whereas a page format may be in a rotated context.
2129 */
2130 setGraphicsConfigInfo(scaleTransform,
2131 paper.getWidth(), paper.getHeight());
2132 int pageResult = painter.print(peekGraphics, origPage, pageIndex);
2133 debug_println("pageResult "+pageResult);
2134 if (pageResult == Printable.PAGE_EXISTS) {
2135 debug_println("startPage "+pageIndex);
2136
2137 /* We need to check if the paper size is changed.
2138 * Note that it is not sufficient to ask for the pageformat
2139 * of "pageIndex-1", since PageRanges mean that pages can be
2140 * skipped. So we have to look at the actual last paper size used.
2141 */
2142 Paper thisPaper = page.getPaper();
2143 boolean paperChanged =
2144 previousPaper == null ||
2145 thisPaper.getWidth() != previousPaper.getWidth() ||
2146 thisPaper.getHeight() != previousPaper.getHeight();
2147 previousPaper = thisPaper;
2148
2149 startPage(page, painter, pageIndex, paperChanged);
2150 Graphics2D pathGraphics = createPathGraphics(peekGraphics, this,
2151 painter, page,
2152 pageIndex);
2153
2154 /* If we can convert the page directly to the
2155 * underlying graphics system then we do not
2156 * need to rasterize. We also may not need to
2157 * create the 'band' if all the pages can take
2158 * this path.
2159 */
2160 if (pathGraphics != null) {
2161 pathGraphics.transform(scaleTransform);
2162 // user (0,0) should be origin of page, not imageable area
2163 pathGraphics.translate(-getPhysicalPrintableX(paper) / xScale,
2164 -getPhysicalPrintableY(paper) / yScale);
2165 pathGraphics.transform(new AffineTransform(page.getMatrix()));
2166 initPrinterGraphics(pathGraphics, pageFormatArea);
2167
2168 redrawList.clear();
2169
2170 AffineTransform initialTx = pathGraphics.getTransform();
2171
2172 painter.print(pathGraphics, origPage, pageIndex);
2173
2174 for (int i=0;i<redrawList.size();i++) {
2175 GraphicsState gstate = redrawList.get(i);
2176 pathGraphics.setTransform(initialTx);
2177 ((PathGraphics)pathGraphics).redrawRegion(
2178 gstate.region,
2179 gstate.sx,
2180 gstate.sy,
2181 gstate.theClip,
2182 gstate.theTransform);
2183 }
2184
2185 /* This is the banded-raster printing loop.
2186 * It should be moved into its own method.
2187 */
2188 } else {
2189 BufferedImage band = cachedBand;
2190 if (cachedBand == null ||
2191 bandWidth != cachedBandWidth ||
2192 bandHeight != cachedBandHeight) {
2193 band = new BufferedImage(bandWidth, bandHeight,
2194 BufferedImage.TYPE_3BYTE_BGR);
2195 cachedBand = band;
2196 cachedBandWidth = bandWidth;
2197 cachedBandHeight = bandHeight;
2198 }
2199 Graphics2D bandGraphics = band.createGraphics();
2200
2201 Rectangle2D.Double clipArea =
2202 new Rectangle2D.Double(0, 0, bandWidth, bandHeight);
2203
2204 initPrinterGraphics(bandGraphics, clipArea);
2205
2206 ProxyGraphics2D painterGraphics =
2207 new ProxyGraphics2D(bandGraphics, this);
2208
2209 Graphics2D clearGraphics = band.createGraphics();
2210 clearGraphics.setColor(Color.white);
2211
2212 /* We need the actual bits of the BufferedImage to send to
2213 * the native Window's code. 'data' points to the actual
2214 * pixels. Right now these are in ARGB format with 8 bits
2215 * per component. We need to use a monochrome BufferedImage
2216 * for monochrome printers when this is supported by
2217 * BufferedImage. FIX
2218 */
2219 ByteInterleavedRaster tile = (ByteInterleavedRaster)band.getRaster();
2220 byte[] data = tile.getDataStorage();
2221
2222 /* Loop over the page moving our band down the page,
2223 * calling the app to render the band, and then send the band
2224 * to the printer.
2225 */
2226 int deviceBottom = deviceTop + deviceAreaHeight;
2227
2228 /* device's printable x,y is really addressable origin
2229 * we address relative to media origin so when we print a
2230 * band we need to adjust for the different methods of
2231 * addressing it.
2232 */
2233 int deviceAddressableX = (int)getPhysicalPrintableX(paper);
2234 int deviceAddressableY = (int)getPhysicalPrintableY(paper);
2235
2236 for (int bandTop = 0; bandTop <= deviceAreaHeight;
2237 bandTop += bandHeight)
2238 {
2239
2240 /* Put the band back into device space and
2241 * erase the contents of the band.
2242 */
2243 clearGraphics.fillRect(0, 0, bandWidth, bandHeight);
2244
2245 /* Put the band into the correct location on the
2246 * page. Once the band is moved we translate the
2247 * device transform so that the band will move down
2248 * the page on the next iteration of the loop.
2249 */
2250 bandGraphics.setTransform(uniformTransform);
2251 bandGraphics.transform(deviceTransform);
2252 deviceTransform.translate(0, -bandHeight);
2253
2254 /* Switch the band from device space to user,
2255 * 72 dpi, space.
2256 */
2257 bandGraphics.transform(scaleTransform);
2258 bandGraphics.transform(new AffineTransform(page.getMatrix()));
2259
2260 Rectangle clip = bandGraphics.getClipBounds();
2261 clip = pgAt.createTransformedShape(clip).getBounds();
2262
2263 if ((clip == null) || peekGraphics.hitsDrawingArea(clip) &&
2264 (bandWidth > 0 && bandHeight > 0)) {
2265
2266 /* if the client has specified an imageable X or Y
2267 * which is off than the physically addressable
2268 * area of the page, then we need to adjust for that
2269 * here so that we pass only non -ve band coordinates
2270 * We also need to translate by the adjusted amount
2271 * so that printing appears in the correct place.
2272 */
2273 int bandX = deviceLeft - deviceAddressableX;
2274 if (bandX < 0) {
2275 bandGraphics.translate(bandX/xScale,0);
2276 bandX = 0;
2277 }
2278 int bandY = deviceTop + bandTop - deviceAddressableY;
2279 if (bandY < 0) {
2280 bandGraphics.translate(0,bandY/yScale);
2281 bandY = 0;
2282 }
2283 /* Have the app's painter image into the band
2284 * and then send the band to the printer.
2285 */
2286 painterGraphics.setDelegate((Graphics2D) bandGraphics.create());
2287 painter.print(painterGraphics, origPage, pageIndex);
2288 painterGraphics.dispose();
2289 printBand(data, bandX, bandY, bandWidth, bandHeight);
2290 }
2291 }
2292
2293 clearGraphics.dispose();
2294 bandGraphics.dispose();
2295
2296 }
2297 debug_println("calling endPage "+pageIndex);
2298 endPage(page, painter, pageIndex);
2299 }
2300
2301 return pageResult;
2302 }
2303
2304 /**
2305 * If a print job is in progress, print() has been
2306 * called but has not returned, then this signals
2307 * that the job should be cancelled and the next
2308 * chance. If there is no print job in progress then
2309 * this call does nothing.
2310 */
2311 public void cancel() {
2312 synchronized (this) {
2313 if (performingPrinting) {
2314 userCancelled = true;
2315 }
2316 notify();
2317 }
2318 }
2319
2320 /**
2321 * Returns true is a print job is ongoing but will
2322 * be cancelled and the next opportunity. false is
2323 * returned otherwise.
2324 */
2325 public boolean isCancelled() {
2326
2327 boolean cancelled = false;
2328
2329 synchronized (this) {
2330 cancelled = (performingPrinting && userCancelled);
2331 notify();
2332 }
2333
2334 return cancelled;
2335 }
2336
2337 /**
2338 * Return the Pageable describing the pages to be printed.
2339 */
2340 protected Pageable getPageable() {
2341 return mDocument;
2342 }
2343
2344 /**
2345 * Examine the metrics captured by the
2346 * <code>PeekGraphics</code> instance and
2347 * if capable of directly converting this
2348 * print job to the printer's control language
2349 * or the native OS's graphics primitives, then
2350 * return a <code>PathGraphics</code> to perform
2351 * that conversion. If there is not an object
2352 * capable of the conversion then return
2353 * <code>null</code>. Returning <code>null</code>
2354 * causes the print job to be rasterized.
2355 */
2356 protected Graphics2D createPathGraphics(PeekGraphics graphics,
2357 PrinterJob printerJob,
2358 Printable painter,
2359 PageFormat pageFormat,
2360 int pageIndex) {
2361
2362 return null;
2363 }
2364
2365 /**
2366 * Create and return an object that will
2367 * gather and hold metrics about the print
2368 * job. This method is passed a <code>Graphics2D</code>
2369 * object that can be used as a proxy for the
2370 * object gathering the print job matrics. The
2371 * method is also supplied with the instance
2372 * controlling the print job, <code>printerJob</code>.
2373 */
2374 protected PeekGraphics createPeekGraphics(Graphics2D graphics,
2375 PrinterJob printerJob) {
2376
2377 return new PeekGraphics(graphics, printerJob);
2378 }
2379
2380 /**
2381 * Configure the passed in Graphics2D so that
2382 * is contains the defined initial settings
2383 * for a print job. These settings are:
2384 * color: black.
2385 * clip: <as passed in>
2386 */
2387 // MacOSX - made protected so subclasses can reference it.
2388 protected void initPrinterGraphics(Graphics2D g, Rectangle2D clip) {
2389
2390 g.setClip(clip);
2391 g.setPaint(Color.black);
2392 }
2393
2394
2395 /**
2396 * User dialogs should disable "File" buttons if this returns false.
2397 *
2398 */
2399 public boolean checkAllowedToPrintToFile() {
2400 try {
2401 throwPrintToFile();
2402 return true;
2403 } catch (SecurityException e) {
2404 return false;
2405 }
2406 }
2407
2408 /**
2409 * Break this out as it may be useful when we allow API to
2410 * specify printing to a file. In that case its probably right
2411 * to throw a SecurityException if the permission is not granted
2412 */
2413 private void throwPrintToFile() {
2414 SecurityManager security = System.getSecurityManager();
2415 if (security != null) {
2416 if (printToFilePermission == null) {
2417 printToFilePermission =
2418 new FilePermission("<<ALL FILES>>", "read,write");
2419 }
2420 security.checkPermission(printToFilePermission);
2421 }
2422 }
2423
2424 /* On-screen drawString renders most control chars as the missing glyph
2425 * and have the non-zero advance of that glyph.
2426 * Exceptions are \t, \n and \r which are considered zero-width.
2427 * This is a utility method used by subclasses to remove them so we
2428 * don't have to worry about platform or font specific handling of them.
2429 */
2430 protected String removeControlChars(String s) {
2431 char[] in_chars = s.toCharArray();
2432 int len = in_chars.length;
2433 char[] out_chars = new char[len];
2434 int pos = 0;
2435
2436 for (int i = 0; i < len; i++) {
2437 char c = in_chars[i];
2438 if (c > '\r' || c < '\t' || c == '\u000b' || c == '\u000c') {
2439 out_chars[pos++] = c;
2440 }
2441 }
2442 if (pos == len) {
2443 return s; // no need to make a new String.
2444 } else {
2445 return new String(out_chars, 0, pos);
2446 }
2447 }
2448 }