8295737: macOS: Print content cut off when width > height with portrait orientation

Reviewed-by: prr
This commit is contained in:
Alexander Scherbatiy 2023-03-06 07:48:37 +00:00
parent 15c76e4c02
commit d00a767047
2 changed files with 433 additions and 3 deletions

View File

@ -631,7 +631,8 @@ public final class CPrinterJob extends RasterPrinterJob {
} catch (Exception e) {
return null;
}
return page;
return FlipPageFormat.flipPage(page);
}
private Printable getPrintable(int pageIndex) {
@ -731,7 +732,7 @@ public final class CPrinterJob extends RasterPrinterJob {
Graphics2D pathGraphics = new CPrinterGraphics(delegate, printerJob); // Just stores delegate into an ivar
Rectangle2D pageFormatArea = getPageFormatArea(page);
initPrinterGraphics(pathGraphics, pageFormatArea);
painter.print(pathGraphics, page, pageIndex);
painter.print(pathGraphics, FlipPageFormat.getOriginal(page), pageIndex);
delegate.dispose();
delegate = null;
} catch (PrinterException pe) { throw new java.lang.reflect.UndeclaredThrowableException(pe); }
@ -758,7 +759,7 @@ public final class CPrinterJob extends RasterPrinterJob {
Runnable r = new Runnable() { public void run() { synchronized(ret) {
try {
Pageable pageable = getPageable();
PageFormat pageFormat = pageable.getPageFormat(pageIndex);
PageFormat pageFormat = getPageFormat(pageIndex);
if (pageFormat != null) {
Printable printable = pageable.getPrintable(pageIndex);
if (printable != null) {
@ -871,4 +872,75 @@ public final class CPrinterJob extends RasterPrinterJob {
(float) (paper.getImageableHeight() / dpi),
MediaPrintableArea.INCH);
}
// MacOS NSPrintInfo class has one to one correspondence
// between a paper size and its orientation.
// NSPrintInfo with paper width less than height
// has portrait orientation.
// NSPrintInfo with paper width greater than height
// has landscape orientation.
// (w < h) <-> portrait
// (w > h) <-> landscape
//
// Java PageFormat class has the following relation with NSPrintInfo:
// 1. PageFormat:
// page size: width < height
// orientation: portrait
// NSPrintInfo: width < height (portrait orientation)
// 2. PageFormat:
// page size: width < height
// orientation: landscape
// NSPrintInfo: width > height (landscape orientation)
//
// FlipPageFormat class establishes correspondence between
// Java PageFormat class which page width is greater than height
// with NSPrintInfo in the following way:
// 3. PageFormat:
// page size: width > height
// orientation: portrait
// FlipPageFormat
// page size: width < height
// orientation: landscape
// NSPrintInfo: width > height (landscape orientation)
// 4. PageFormat:
// page size: width > height
// orientation: landscape
// FlipPageFormat
// page size: width < height
// orientation: portrait
// NSPrintInfo: width < height (portrait orientation)
//
// FlipPageFormat preserves the original PageFormat class
// to pass it to Printable.print(Graphics, PageFormat, int)
// method overridden by a user.
private static class FlipPageFormat extends PageFormat {
private final PageFormat original;
private FlipPageFormat(PageFormat original) {
this.original = original;
Paper paper = original.getPaper();
Paper copyPaper = this.getPaper();
copyPaper.setSize(paper.getHeight(), paper.getWidth());
copyPaper.setImageableArea(
paper.getImageableY(), paper.getImageableX(),
paper.getImageableHeight(), paper.getImageableWidth());
this.setPaper(copyPaper);
this.setOrientation((original.getOrientation() == PageFormat.PORTRAIT)
? PageFormat.LANDSCAPE
: PageFormat.PORTRAIT);
}
private static PageFormat getOriginal(PageFormat page) {
return (page instanceof FlipPageFormat) ? ((FlipPageFormat) page).original : page;
}
private static PageFormat flipPage(PageFormat page) {
if (page == null) {
return null;
}
Paper paper = page.getPaper();
return (paper.getWidth() > paper.getHeight()) ? new FlipPageFormat(page) : page;
}
}
}

View File

@ -0,0 +1,358 @@
/*
* Copyright (c) 2022, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2022, BELLSOFT. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
/**
* @test
* @bug 8295737
* @summary macOS: Print content cut off when width > height with portrait orientation
* @run main/othervm/manual PrintContentCutOffTest
*/
import javax.swing.*;
import java.awt.*;
import java.awt.event.WindowAdapter;
import java.awt.event.WindowEvent;
import java.awt.font.FontRenderContext;
import java.awt.print.PageFormat;
import java.awt.print.Printable;
import java.awt.print.PrinterException;
import java.awt.print.PrinterJob;
import java.io.File;
import java.io.IOException;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;
import java.awt.print.Book;
import java.awt.image.BufferedImage;
import java.awt.print.Paper;
import javax.print.PrintServiceLookup;
import javax.print.attribute.Size2DSyntax;
import javax.print.attribute.standard.MediaSize;
import javax.print.attribute.standard.MediaSizeName;
public class PrintContentCutOffTest {
private static final String DESCRIPTION =
" 1. To run the test it is required to have a virtual PDF printer" +
" or any other printer supporting A4 paper size.\n" +
" 2. Press Print button to print 4 rectangles.\n" +
" - rectangle with paper width is less than height, orientation portrait\n" +
" - rectangle with paper width is less than height, orientation landscape\n" +
" - rectangle with paper width is greater than height, orientation portrait\n" +
" - rectangle with paper width is greater than height, orientation landscape\n" +
" [Note: PageFormat size returns transformed Paper size according to the set orientation value.\n" +
" 3. Check that 4 printed rectangles (one per page) have fully drawn 8 vertical areas\n" +
" labeled from 1 to 8, and that the blue diagonal lines end at the corners of the yellow rectangle.\n" +
" [Note: those are the pass/fail criteria. The messages printed in red are only informative\n" +
" and should not be used as a reason to file a bug].\n" +
" 4. If so, press PASS button, otherwise press FAIL button.\n";
private static final CountDownLatch testEndedSignal = new CountDownLatch(1);
private static final int testTimeout = 300000;
private static volatile String testFailureMsg;
private static volatile boolean testPassed;
private static volatile boolean testFinished;
private static final double DOC_WIDTH;
private static final double DOC_HEIGHT;
static {
MediaSize isoA4Size = MediaSize.getMediaSizeForName(MediaSizeName.ISO_A4);
float[] size = isoA4Size.getSize(Size2DSyntax.INCH);
DOC_WIDTH = size[0] * 72.0;
DOC_HEIGHT = size[1] * 72.0;
}
private static void paintImage(Graphics2D g, PageFormat page, int pageIndex) {
BufferedImage img = createImage(page, pageIndex);
g.drawImage(img, 0, 0, null);
}
private static void appendToBook(PrinterJob job, Book book, double width, double height, int orientation) {
PageFormat page = job.getPageFormat(null);
page.setOrientation(orientation);
Paper paper = page.getPaper();
paper.setSize(width, height);
paper.setImageableArea(0, 0, width, height);
page.setPaper(paper);
page.setOrientation(orientation);
book.append(new TestPrintable(), page);
}
private static void print(double width, double height) throws PrinterException {
PrinterJob job = PrinterJob.getPrinterJob();
job.setPrintService(PrintServiceLookup.lookupDefaultPrintService());
Book book = new Book();
appendToBook(job, book, width, height, PageFormat.PORTRAIT);
appendToBook(job, book, width, height, PageFormat.LANDSCAPE);
appendToBook(job, book, height, width, PageFormat.PORTRAIT);
appendToBook(job, book, height, width, PageFormat.LANDSCAPE);
job.setPageable(book);
if (job.printDialog()) {
job.print();
} else {
throw new RuntimeException("Printing was canceled!");
}
}
private static String getOrientation(int orientation) {
switch (orientation) {
case PageFormat.LANDSCAPE:
return "LANDSCAPE";
case PageFormat.PORTRAIT:
return "PORTRAIT";
case PageFormat.REVERSE_LANDSCAPE:
return "REVERSE_LANDSCAPE";
default:
return "UNKNOWN";
}
}
private static BufferedImage createImage(PageFormat page, int pageIndex) {
int w = (int) page.getWidth();
int h = (int) page.getHeight();
int x = 0;
int y = 0;
BufferedImage img = new BufferedImage(w, h, BufferedImage.TYPE_INT_ARGB);
Graphics2D g = img.createGraphics();
g.setClip(null);
g.setColor(Color.ORANGE);
g.fillRect(x, y, w, h);
g.setColor(Color.BLUE);
g.drawRect(x, y, w, h);
g.drawRect(x + 1, y + 1, w - 2, h - 2);
g.drawLine(x, y, x + w, y + h);
g.drawLine(x, y + h, x + w, y);
g.setFont(new Font(Font.MONOSPACED, Font.PLAIN, 12));
int N = 8;
int dx = w / N;
for (int i = 0; i < N; i++) {
int xx = i * dx + x;
g.setColor(Color.BLUE);
g.drawLine(xx, y, xx, y + h);
g.setColor(Color.BLUE);
g.drawString("" + (i + 1), xx + 3, y + h / 2);
}
int NN = 5;
int arrX = x + w / 2 - 4;
g.setColor(Color.RED);
for (int i = 0; i < NN; i++) {
g.drawLine(arrX + i, y + h / 3, arrX + i, y + 2 * h / 3);
}
int r = 7;
g.fillOval(arrX + NN / 2 - r, y + h / 3 - r - 5, 2 * r, 2 * r);
g.setColor(Color.RED);
g.setFont(g.getFont().deriveFont(Font.BOLD, 16.0f));
int textX = x + w / 18;
int textY = y + h / 3;
int textDelta = h / 16;
Paper paper = page.getPaper();
String paperSize = String.format("Paper size: %dx%d",
(int) paper.getWidth(), (int) paper.getHeight());
g.drawString(paperSize, textX, textY);
String pageFormatSize = String.format("PageFormat size: %dx%d", w, h);
g.drawString(pageFormatSize, textX, textY + textDelta);
String orientation = String.format("Orientation: %s",
getOrientation(page.getOrientation()));
g.drawString(orientation, textX, textY + 2 * textDelta);
g.setColor(Color.BLACK);
g.setFont(g.getFont().deriveFont(28.0f));
g.drawString(String.format("P:%d", pageIndex + 1), x + w / 2, y + 2 * h / 3);
g.dispose();
return img;
}
private static class TestPrintable implements Printable {
@Override
public int print(Graphics graphics, PageFormat pageFormat, int index) {
paintImage((Graphics2D) graphics, pageFormat, index);
return PAGE_EXISTS;
}
}
public static void main(String[] args) throws Exception {
SwingUtilities.invokeLater(() -> createAndShowTestDialog());
try {
if (!testEndedSignal.await(testTimeout, TimeUnit.MILLISECONDS)) {
throw new RuntimeException(String.format(
"Test timeout '%d ms' elapsed.", testTimeout));
}
if (!testPassed) {
String failureMsg = testFailureMsg;
if ((failureMsg != null) && (!failureMsg.trim().isEmpty())) {
throw new RuntimeException(failureMsg);
} else {
throw new RuntimeException("Test failed.");
}
}
} catch (InterruptedException ie) {
throw new RuntimeException(ie);
} finally {
testFinished = true;
}
}
private static void pass() {
testPassed = true;
testEndedSignal.countDown();
}
private static void fail(String failureMsg) {
testFailureMsg = failureMsg;
testPassed = false;
testEndedSignal.countDown();
}
private static String convertMillisToTimeStr(int millis) {
if (millis < 0) {
return "00:00:00";
}
int hours = millis / 3600000;
int minutes = (millis - hours * 3600000) / 60000;
int seconds = (millis - hours * 3600000 - minutes * 60000) / 1000;
return String.format("%02d:%02d:%02d", hours, minutes, seconds);
}
private static void createAndShowTestDialog() {
final JDialog dialog = new JDialog();
dialog.setDefaultCloseOperation(WindowConstants.DISPOSE_ON_CLOSE);
dialog.addWindowListener(new WindowAdapter() {
@Override
public void windowClosing(WindowEvent e) {
dialog.dispose();
fail("Main dialog was closed.");
}
});
final JLabel testTimeoutLabel = new JLabel(String.format(
"Test timeout: %s", convertMillisToTimeStr(testTimeout)));
final long startTime = System.currentTimeMillis();
final Timer timer = new Timer(0, null);
timer.setDelay(1000);
timer.addActionListener((e) -> {
int leftTime = testTimeout - (int) (System.currentTimeMillis() - startTime);
if ((leftTime < 0) || testFinished) {
timer.stop();
dialog.dispose();
}
testTimeoutLabel.setText(String.format(
"Test timeout: %s", convertMillisToTimeStr(leftTime)));
});
timer.start();
JTextArea textArea = new JTextArea(DESCRIPTION);
textArea.setEditable(false);
final JButton testButton = new JButton("Print");
final JButton passButton = new JButton("PASS");
final JButton failButton = new JButton("FAIL");
testButton.addActionListener((e) -> {
testButton.setEnabled(false);
new Thread(() -> {
try {
doTest();
SwingUtilities.invokeLater(() -> {
passButton.setEnabled(true);
failButton.setEnabled(true);
});
} catch (Throwable t) {
t.printStackTrace();
dialog.dispose();
fail("Exception occurred in a thread executing the test.");
}
}).start();
});
passButton.setEnabled(false);
passButton.addActionListener((e) -> {
dialog.dispose();
pass();
});
failButton.setEnabled(false);
failButton.addActionListener((e) -> {
dialog.dispose();
fail("TitledBorder label is cut off");
});
JPanel mainPanel = new JPanel(new BorderLayout());
JPanel labelPanel = new JPanel(new FlowLayout());
labelPanel.add(testTimeoutLabel);
mainPanel.add(labelPanel, BorderLayout.NORTH);
mainPanel.add(textArea, BorderLayout.CENTER);
JPanel buttonPanel = new JPanel(new FlowLayout());
buttonPanel.add(testButton);
buttonPanel.add(passButton);
buttonPanel.add(failButton);
mainPanel.add(buttonPanel, BorderLayout.SOUTH);
dialog.add(mainPanel);
dialog.pack();
dialog.setVisible(true);
}
private static void doTest() throws Exception {
SwingUtilities.invokeAndWait(() -> {
try {
print(DOC_WIDTH, DOC_HEIGHT);
} catch (PrinterException e) {
throw new RuntimeException(e);
}
});
}
}