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