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