/*
* Copyright (c) 1997, 2000, Oracle and/or its affiliates. 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. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* 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.
*/
package java.awt.print;
import java.awt.geom.AffineTransform;
import java.awt.geom.Point2D;
import java.awt.geom.Rectangle2D;
/**
* The <code>PageFormat</code> class describes the size and
* orientation of a page to be printed.
*/
public class PageFormat implements Cloneable
{
/* Class Constants */
/**
* The origin is at the bottom left of the paper with
* x running bottom to top and y running left to right.
* Note that this is not the Macintosh landscape but
* is the Window's and PostScript landscape.
*/
public static final int LANDSCAPE = 0;
/**
* The origin is at the top left of the paper with
* x running to the right and y running down the
* paper.
*/
public static final int PORTRAIT = 1;
/**
* The origin is at the top right of the paper with x
* running top to bottom and y running right to left.
* Note that this is the Macintosh landscape.
*/
public static final int REVERSE_LANDSCAPE = 2;
/* Instance Variables */
/**
* A description of the physical piece of paper.
*/
private Paper mPaper;
/**
* The orientation of the current page. This will be
* one of the constants: PORTRIAT, LANDSCAPE, or
* REVERSE_LANDSCAPE,
*/
private int mOrientation = PORTRAIT;
/* Constructors */
/**
* Creates a default, portrait-oriented
* <code>PageFormat</code>.
*/
public PageFormat()
{
mPaper = new Paper();
}
/* Instance Methods */
/**
* Makes a copy of this <code>PageFormat</code> with the same
* contents as this <code>PageFormat</code>.
* @return a copy of this <code>PageFormat</code>.
*/
public Object clone() {
PageFormat newPage;
try {
newPage = (PageFormat) super.clone();
newPage.mPaper = (Paper)mPaper.clone();
} catch (CloneNotSupportedException e) {
e.printStackTrace();
newPage = null; // should never happen.
}
return newPage;
}
/**
* Returns the width, in 1/72nds of an inch, of the page.
* This method takes into account the orientation of the
* page when determining the width.
* @return the width of the page.
*/
public double getWidth() {
double width;
int orientation = getOrientation();
if (orientation == PORTRAIT) {
width = mPaper.getWidth();
} else {
width = mPaper.getHeight();
}
return width;
}
/**
* Returns the height, in 1/72nds of an inch, of the page.
* This method takes into account the orientation of the
* page when determining the height.
* @return the height of the page.
*/
public double getHeight() {
double height;
int orientation = getOrientation();
if (orientation == PORTRAIT) {
height = mPaper.getHeight();
} else {
height = mPaper.getWidth();
}
return height;
}
/**
* Returns the x coordinate of the upper left point of the
* imageable area of the <code>Paper</code> object
* associated with this <code>PageFormat</code>.
* This method takes into account the
* orientation of the page.
* @return the x coordinate of the upper left point of the
* imageable area of the <code>Paper</code> object
* associated with this <code>PageFormat</code>.
*/
public double getImageableX() {
double x;
switch (getOrientation()) {
case LANDSCAPE:
x = mPaper.getHeight()
- (mPaper.getImageableY() + mPaper.getImageableHeight());
break;
case PORTRAIT:
x = mPaper.getImageableX();
break;
case REVERSE_LANDSCAPE:
x = mPaper.getImageableY();
break;
default:
/* This should never happen since it signifies that the
* PageFormat is in an invalid orientation.
*/
throw new InternalError("unrecognized orientation");
}
return x;
}
/**
* Returns the y coordinate of the upper left point of the
* imageable area of the <code>Paper</code> object
* associated with this <code>PageFormat</code>.
* This method takes into account the
* orientation of the page.
* @return the y coordinate of the upper left point of the
* imageable area of the <code>Paper</code> object
* associated with this <code>PageFormat</code>.
*/
public double getImageableY() {
double y;
switch (getOrientation()) {
case LANDSCAPE:
y = mPaper.getImageableX();
break;
case PORTRAIT:
y = mPaper.getImageableY();
break;
case REVERSE_LANDSCAPE:
y = mPaper.getWidth()
- (mPaper.getImageableX() + mPaper.getImageableWidth());
break;
default:
/* This should never happen since it signifies that the
* PageFormat is in an invalid orientation.
*/
throw new InternalError("unrecognized orientation");
}
return y;
}
/**
* Returns the width, in 1/72nds of an inch, of the imageable
* area of the page. This method takes into account the orientation
* of the page.
* @return the width of the page.
*/
public double getImageableWidth() {
double width;
if (getOrientation() == PORTRAIT) {
width = mPaper.getImageableWidth();
} else {
width = mPaper.getImageableHeight();
}
return width;
}
/**
* Return the height, in 1/72nds of an inch, of the imageable
* area of the page. This method takes into account the orientation
* of the page.
* @return the height of the page.
*/
public double getImageableHeight() {
double height;
if (getOrientation() == PORTRAIT) {
height = mPaper.getImageableHeight();
} else {
height = mPaper.getImageableWidth();
}
return height;
}
/**
* Returns a copy of the {@link Paper} object associated
* with this <code>PageFormat</code>. Changes made to the
* <code>Paper</code> object returned from this method do not
* affect the <code>Paper</code> object of this
* <code>PageFormat</code>. To update the <code>Paper</code>
* object of this <code>PageFormat</code>, create a new
* <code>Paper</code> object and set it into this
* <code>PageFormat</code> by using the {@link #setPaper(Paper)}
* method.
* @return a copy of the <code>Paper</code> object associated
* with this <code>PageFormat</code>.
* @see #setPaper
*/
public Paper getPaper() {
return (Paper)mPaper.clone();
}
/**
* Sets the <code>Paper</code> object for this
* <code>PageFormat</code>.
* @param paper the <code>Paper</code> object to which to set
* the <code>Paper</code> object for this <code>PageFormat</code>.
* @exception <code>NullPointerException</code>
* a null paper instance was passed as a parameter.
* @see #getPaper
*/
public void setPaper(Paper paper) {
mPaper = (Paper)paper.clone();
}
/**
* Sets the page orientation. <code>orientation</code> must be
* one of the constants: PORTRAIT, LANDSCAPE,
* or REVERSE_LANDSCAPE.
* @param orientation the new orientation for the page
* @throws IllegalArgumentException if
* an unknown orientation was requested
* @see #getOrientation
*/
public void setOrientation(int orientation) throws IllegalArgumentException
{
if (0 <= orientation && orientation <= REVERSE_LANDSCAPE) {
mOrientation = orientation;
} else {
throw new IllegalArgumentException();
}
}
/**
* Returns the orientation of this <code>PageFormat</code>.
* @return this <code>PageFormat</code> object's orientation.
* @see #setOrientation
*/
public int getOrientation() {
return mOrientation;
}
/**
* Returns a transformation matrix that translates user
* space rendering to the requested orientation
* of the page. The values are placed into the
* array as
* { m00, m10, m01, m11, m02, m12} in
* the form required by the {@link AffineTransform}
* constructor.
* @return the matrix used to translate user space rendering
* to the orientation of the page.
* @see java.awt.geom.AffineTransform
*/
public double[] getMatrix() {
double[] matrix = new double[6];
switch (mOrientation) {
case LANDSCAPE:
matrix[0] = 0; matrix[1] = -1;
matrix[2] = 1; matrix[3] = 0;
matrix[4] = 0; matrix[5] = mPaper.getHeight();
break;
case PORTRAIT:
matrix[0] = 1; matrix[1] = 0;
matrix[2] = 0; matrix[3] = 1;
matrix[4] = 0; matrix[5] = 0;
break;
case REVERSE_LANDSCAPE:
matrix[0] = 0; matrix[1] = 1;
matrix[2] = -1; matrix[3] = 0;
matrix[4] = mPaper.getWidth(); matrix[5] = 0;
break;
default:
throw new IllegalArgumentException();
}
return matrix;
}
}