jdk/test/java/awt/print/PrinterJob/ValidatePage/ValidatePage.java

/*
 * Copyright 2007 Sun Microsystems, Inc.  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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
 * CA 95054 USA or visit www.sun.com if you need additional information or
 * have any questions.
 */

/**
 * @test
 * @bug 4252108 6229507
 * @summary PrinterJob.validatePage() is unimplemented.
 * @author prr
 * @run main/manual ValidatePage
 */

import java.awt.*;
import java.awt.event.*;
import java.awt.print.*;

public class ValidatePage extends Frame implements Printable {

PrinterJob myPrinterJob;
PageFormat myPageFormat;
Label pw, ph, pglm, pgrm, pgiw, pgih, pgtm, pgbm;
TextField tpw, tph, tpglm, tpgtm, tpgiw, tpgih;
Label myWidthLabel;
Label myHeightLabel;
Label myImageableXLabel;
Label myImageableYLabel;
Label myImageableRightLabel;
Label myImageableBottomLabel;
Label myImageableWidthLabel;
Label myImageableHeightLabel;
Label myOrientationLabel;

  protected void displayPageFormatAttributes() {
    myWidthLabel.setText ("Format Width = " + drnd(myPageFormat.getWidth()));
    myHeightLabel.setText ("Format Height = " + drnd(myPageFormat.getHeight()));
    myImageableXLabel.setText
        ("Format Left Margin = " + drnd(myPageFormat.getImageableX()));
    myImageableRightLabel.setText
        ("Format Right Margin = " + drnd(myPageFormat.getWidth() -
        (myPageFormat.getImageableX() + myPageFormat.getImageableWidth())));
    myImageableWidthLabel.setText
        ("Format ImageableWidth = " + drnd(myPageFormat.getImageableWidth()));
    myImageableYLabel.setText
        ("Format Top Margin = " + drnd(myPageFormat.getImageableY()));
    myImageableBottomLabel.setText
        ("Format Bottom Margin = " + drnd(myPageFormat.getHeight() -
        (myPageFormat.getImageableY() + myPageFormat.getImageableHeight())));
    myImageableHeightLabel.setText
        ("Format ImageableHeight = " + drnd(myPageFormat.getImageableHeight()));
    int o = myPageFormat.getOrientation();
    myOrientationLabel.setText
        ("Format Orientation = " +
                (o == PageFormat.PORTRAIT ? "PORTRAIT" :
                 o == PageFormat.LANDSCAPE ? "LANDSCAPE" :
                 o == PageFormat.REVERSE_LANDSCAPE ? "REVERSE_LANDSCAPE" :
                 "<invalid>"));
    Paper p = myPageFormat.getPaper();
    pw.setText("Paper Width = " + drnd(p.getWidth()));
    ph.setText("Paper Height = " + drnd(p.getHeight()));
    pglm.setText("Paper Left Margin = " + drnd(p.getImageableX()));
    pgiw.setText("Paper Imageable Width = " + drnd(p.getImageableWidth()));
    pgih.setText("Paper Imageable Height = " + drnd(p.getImageableHeight()));

    pgrm.setText("Paper Right Margin = " +
         drnd(p.getWidth() - (p.getImageableX()+p.getImageableWidth())));
    pgtm.setText("Paper Top Margin = " + drnd(p.getImageableY()));
    pgbm.setText("Paper Bottom Margin = " +
       drnd(p.getHeight() - (p.getImageableY()+p.getImageableHeight())));
  }

  static String drnd(double d) {
      d = d * 10.0 + 0.5;
      d = Math.floor(d) /10.0;
      String ds = Double.toString(d);
      int decimal_pos = ds.indexOf(".");
      int len = ds.length();
      if (len > decimal_pos+2) {
          return ds.substring(0, decimal_pos+2);
      } else {
          return ds;
      }
  }

  public ValidatePage() {
    super ("Validate Page Test");
    myPrinterJob = PrinterJob.getPrinterJob();
    myPageFormat = new PageFormat();
    Paper p = new Paper();
    p.setSize(28*72, 21.5 * 72);
    myPageFormat.setPaper(p);
    setLayout(new FlowLayout());
    Panel pfp = new Panel();
    pfp.setLayout (new GridLayout (9, 1, 0, 0));
    pfp.add (myOrientationLabel = new Label());
    pfp.add (myWidthLabel = new Label());
    pfp.add (myImageableXLabel = new Label());
    pfp.add (myImageableRightLabel = new Label());
    pfp.add (myImageableWidthLabel = new Label());
    pfp.add (myHeightLabel = new Label());
    pfp.add (myImageableYLabel = new Label());
    pfp.add (myImageableBottomLabel = new Label());
    pfp.add (myImageableHeightLabel = new Label());

    add(pfp);

    Panel pp = new Panel();
    pp.setLayout (new GridLayout (8, 1, 0, 0));
    pp.add (pw = new Label());
    pp.add (pglm = new Label());
    pp.add (pgtm = new Label());
    pp.add (ph = new Label());
    pp.add (pgiw = new Label());
    pp.add (pgih = new Label());
    pp.add (pgrm = new Label());
    pp.add (pgbm = new Label());

    add(pp);

    Panel epp = new Panel();
    epp.setLayout (new GridLayout (6, 2, 0, 0));

    epp.add(new Label("Page width:"));
    epp.add (tpw = new TextField());
    epp.add(new Label("Page height:"));
    epp.add (tph = new TextField());
    epp.add(new Label("Left Margin:"));
    epp.add (tpglm = new TextField());
    epp.add(new Label("Top margin:"));
    epp.add (tpgtm = new TextField());
    epp.add(new Label("Imageable Wid:"));
    epp.add (tpgiw = new TextField());
    epp.add(new Label("Imageable Hgt:"));
    epp.add (tpgih = new TextField());

    add(epp);
       displayPageFormatAttributes();

    Panel panel = new Panel();
    Button defButton = new Button ("Default Page");
    defButton.addActionListener(new ActionListener() {
                public void actionPerformed (ActionEvent e) {
                        myPageFormat = myPrinterJob.defaultPage();
                        displayPageFormatAttributes();
                }
    });

    Button pageButton = new Button ("Page Setup..");
    pageButton.addActionListener(new ActionListener() {
                public void actionPerformed (ActionEvent e) {
                        myPageFormat = myPrinterJob.pageDialog (myPageFormat);
                        displayPageFormatAttributes();
                }
    });
    Button printButton = new Button ("Print");
    printButton.addActionListener(new ActionListener() {
                public void actionPerformed (ActionEvent e) {
                    try {
                         //if (myPrinterJob.printDialog()) {
                             myPrinterJob.setPrintable(ValidatePage.this,
                                                       myPageFormat);
                             myPrinterJob.print();
                   // }
                    } catch (PrinterException pe ) {
                    }
                }
    });

    Button chooseButton = new Button ("Printer..");
    chooseButton.addActionListener(new ActionListener() {
                public void actionPerformed (ActionEvent e) {
                            myPrinterJob.printDialog();
                }
    });

    Button validateButton = new Button ("Validate Page");
    validateButton.addActionListener(new ActionListener() {
                public void actionPerformed (ActionEvent e) {
                        myPageFormat = myPrinterJob.validatePage(myPageFormat);
                        displayPageFormatAttributes();
                }
    });
    Button setButton = new Button ("Set Paper");
    setButton.addActionListener(new ActionListener() {
                public void actionPerformed (ActionEvent e) {
                  try {
                      Paper p = new Paper();
                      double pwid = Double.parseDouble(tpw.getText());
                      double phgt = Double.parseDouble(tph.getText());
                      double pimx = Double.parseDouble(tpglm.getText());
                      double pimy = Double.parseDouble(tpgtm.getText());
                      double pimwid = Double.parseDouble(tpgiw.getText());
                      double pimhgt = Double.parseDouble(tpgih.getText());
                      p.setSize(pwid, phgt);
                      p.setImageableArea(pimx, pimy, pimwid, pimhgt);
                      myPageFormat.setPaper(p);
                            displayPageFormatAttributes();
                  } catch (NumberFormatException nfe) {
                  }
                }
    });
    panel.add (setButton);
    panel.add (defButton);
    panel.add (pageButton);
    panel.add (chooseButton);
    panel.add (validateButton);
    panel.add (printButton);
    add(panel);
    TextArea ta = new TextArea(7, 60);
    String ls = System.getProperty("line.Separator", "\n");
    ta.setText(
        "When validating a page, the process is 1st to find the closest matching " + ls +
        "paper size, next to make sure the requested imageable area fits within " + ls +
        "the printer's imageable area for that paper size. Finally the top and " + ls +
        "left margins will be shrunk if they are too great for the adjusted " + ls +
        "imageable area to fit at that position. They will shrink by the minimum" + ls +
        "needed to accomodate the imageable area."+ls+ls+
        "To test 6229507, put the minimum margins (all 0s) in Page Setup dialog."+ls+
        "Compare Imageable width, height, and margins of portrait against landscape.");
    ta.setEditable(false);
    add(ta);

    addWindowListener (new WindowAdapter() {
         public void windowClosing (WindowEvent e) {
            dispose();
            System.exit (0);
         }

      });
      setSize (500, 630);
      setVisible (true);
  }

  public int print(Graphics graphics, PageFormat pageFormat, int pageIndex) {

     if (pageIndex > 0) {
        return Printable.NO_SUCH_PAGE;
     }

     Graphics2D g2d = (Graphics2D)graphics;

    int o = pageFormat.getOrientation();

     System.out.println("Format Orientation = " +
                (o == PageFormat.PORTRAIT ? "PORTRAIT" :
                 o == PageFormat.LANDSCAPE ? "LANDSCAPE" :
                 o == PageFormat.REVERSE_LANDSCAPE ? "REVERSE_LANDSCAPE" :
                 "<invalid>"));
     System.out.println(g2d.getTransform());
     System.out.println("ix="+pageFormat.getImageableX()+
                       " iy="+pageFormat.getImageableY());
     g2d.translate(pageFormat.getImageableX(), pageFormat.getImageableY());
     g2d.drawString("ORIGIN", 20, 20);
     g2d.drawString("X THIS WAY", 200, 50);
     g2d.drawString("Y THIS WAY", 60 , 200);
     g2d.drawRect(0,0,(int)pageFormat.getImageableWidth(),
                      (int)pageFormat.getImageableHeight());
     g2d.setColor(Color.blue);
     g2d.drawRect(1,1,(int)pageFormat.getImageableWidth()-2,
                      (int)pageFormat.getImageableHeight()-2);

     return  Printable.PAGE_EXISTS;
  }

  public static void main( String[] args) {
  String[] instructions =
        {
         "You must have a printer available to perform this test",
         "This test is very flexible and requires much interaction.",
         "There are several buttons.",
         "Set Paper: if all fields are valid numbers it sets the Paper object.",
         "This is used to create arbitrary nonsensical paper sizes to help",
         "test validatePage.",
         "Default Page: sets a default page. This should always be valid.",
         "Page Setup: brings up the page dialog. You must OK this dialog",
         "for it to have any effect. You can use this to set different size,",
         "orientation and margins - which of course affect imageable area.",
         "Printer: Used to set the current printer. Useful because current",
         "printer affects the choice of paper sizes available.",
         "You must OK this dialog for it to have any effect.",
         "Validate Page:",
         "The most important button in the test. By setting nonsensical",
         "or valid papers with varying margins etc, this should always find",
         "the closest",
         "match within the limits of what is possible on the current printer.",
         "Print: to the current printer. Not vital for this test.",
         "request."
       };
      Sysout.createDialog( );
      Sysout.printInstructions( instructions );

     new ValidatePage();
  }

}

class Sysout {
   private static TestDialog dialog;

   public static void createDialogWithInstructions( String[] instructions )
    {
      dialog = new TestDialog( new Frame(), "Instructions" );
      dialog.printInstructions( instructions );
      dialog.show();
      println( "Any messages for the tester will display here." );
    }

   public static void createDialog( )
    {
      dialog = new TestDialog( new Frame(), "Instructions" );
      String[] defInstr = { "Instructions will appear here. ", "" } ;
      dialog.printInstructions( defInstr );
      dialog.show();
      println( "Any messages for the tester will display here." );
    }


   public static void printInstructions( String[] instructions )
    {
      dialog.printInstructions( instructions );
    }


   public static void println( String messageIn )
    {
      dialog.displayMessage( messageIn );
    }

}// Sysout  class

/**
  This is part of the standard test machinery.  It provides a place for the
   test instructions to be displayed, and a place for interactive messages
   to the user to be displayed.
  To have the test instructions displayed, see Sysout.
  To have a message to the user be displayed, see Sysout.
  Do not call anything in this dialog directly.
  */
class TestDialog extends Dialog {

   TextArea instructionsText;
   TextArea messageText;
   int maxStringLength = 80;

   //DO NOT call this directly, go through Sysout
   public TestDialog( Frame frame, String name )
    {
      super( frame, name );
      int scrollBoth = TextArea.SCROLLBARS_BOTH;
      instructionsText = new TextArea( "", 15, maxStringLength, scrollBoth );
      add( "North", instructionsText );

      messageText = new TextArea( "", 5, maxStringLength, scrollBoth );
      add("Center", messageText);

      pack();

      show();
    }// TestDialog()

   //DO NOT call this directly, go through Sysout
   public void printInstructions( String[] instructions )
    {
      //Clear out any current instructions
      instructionsText.setText( "" );

      //Go down array of instruction strings

      String printStr, remainingStr;
      for( int i=0; i < instructions.length; i++ )
       {
         //chop up each into pieces maxSringLength long
         remainingStr = instructions[ i ];
         while( remainingStr.length() > 0 )
          {
            //if longer than max then chop off first max chars to print
            if( remainingStr.length() >= maxStringLength )
             {
               //Try to chop on a word boundary
               int posOfSpace = remainingStr.
                  lastIndexOf( ' ', maxStringLength - 1 );

               if( posOfSpace <= 0 ) posOfSpace = maxStringLength - 1;

               printStr = remainingStr.substring( 0, posOfSpace + 1 );
               remainingStr = remainingStr.substring( posOfSpace + 1 );
             }
            //else just print
            else
             {
               printStr = remainingStr;
               remainingStr = "";
             }

            instructionsText.append( printStr + "\n" );

          }// while

       }// for

    }//printInstructions()

   //DO NOT call this directly, go through Sysout
   public void displayMessage( String messageIn )
    {
      messageText.append( messageIn + "\n" );
    }

 }// TestDialog  class