/*
 * Copyright (c) 1997, 2013, 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;

import java.lang.annotation.Native;

The PageFormat class describes the size and orientation of a page to be printed. /**
 * The {@code PageFormat} 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.
/**
     *  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.
     */
    @Native 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.
/**
     *  The origin is at the top left of the paper with
     *  x running to the right and y running down the
     *  paper.
     */
    @Native 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.
/**
     *  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.
     */
    @Native public static final int REVERSE_LANDSCAPE = 2;

 /* Instance Variables */

    
A description of the physical piece of paper.
/**
     * A description of the physical piece of paper.
     */
    private Paper mPaper;

    
The orientation of the current page. This will be
one of the constants: PORTRAIT, LANDSCAPE, or
REVERSE_LANDSCAPE,
/**
     * The orientation of the current page. This will be
     * one of the constants: PORTRAIT, LANDSCAPE, or
     * REVERSE_LANDSCAPE,
     */
    private int mOrientation = PORTRAIT;

 /* Constructors */

    
Creates a default, portrait-oriented PageFormat. /**
     * Creates a default, portrait-oriented
     * {@code PageFormat}.
     */
    public PageFormat()
    {
        mPaper = new Paper();
    }

 /* Instance Methods */

    
Makes a copy of this PageFormat with the same contents as this PageFormat. 
Returns:
a copy of this PageFormat./**
     * Makes a copy of this {@code PageFormat} with the same
     * contents as this {@code PageFormat}.
     * @return a copy of this {@code PageFormat}.
     */
    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.
Returns:
the width of the page./**
     * 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.
Returns:
the height of the page./**
     * 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 Paper object associated with this PageFormat. This method takes into account the orientation of the page. 
Returns:
the x coordinate of the upper left point of the imageable area of the Paper object associated with this PageFormat./**
     * Returns the x coordinate of the upper left point of the
     * imageable area of the {@code Paper} object
     * associated with this {@code PageFormat}.
     * 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} object
     * associated with this {@code PageFormat}.
     */
    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 Paper object associated with this PageFormat. This method takes into account the orientation of the page. 
Returns:
the y coordinate of the upper left point of the imageable area of the Paper object associated with this PageFormat./**
     * Returns the y coordinate of the upper left point of the
     * imageable area of the {@code Paper} object
     * associated with this {@code PageFormat}.
     * 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} object
     * associated with this {@code PageFormat}.
     */
    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.
Returns:
the width of the page./**
     * 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.
Returns:
the height of the page./**
     * 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 Paper object associated with this PageFormat. Changes made to the Paper object returned from this method do not affect the Paper object of this PageFormat. To update the Paper object of this PageFormat, create a new Paper object and set it into this PageFormat by using the setPaper(Paper) method. 
See Also:
setPaper
Returns:
a copy of the Paper object associated with this PageFormat./**
     * Returns a copy of the {@link Paper} object associated
     * with this {@code PageFormat}.  Changes made to the
     * {@code Paper} object returned from this method do not
     * affect the {@code Paper} object of this
     * {@code PageFormat}.  To update the {@code Paper}
     * object of this {@code PageFormat}, create a new
     * {@code Paper} object and set it into this
     * {@code PageFormat} by using the {@link #setPaper(Paper)}
     * method.
     * @return a copy of the {@code Paper} object associated
     *          with this {@code PageFormat}.
     * @see #setPaper
     */
    public Paper getPaper() {
        return (Paper)mPaper.clone();
    }

    
Sets the Paper object for this PageFormat. 
Params:
paper – the Paper object to which to set the Paper object for this PageFormat.
Throws:
NullPointerException – 
             a null paper instance was passed as a parameter.
See Also:
getPaper/**
     * Sets the {@code Paper} object for this
     * {@code PageFormat}.
     * @param paper the {@code Paper} object to which to set
     * the {@code Paper} object for this {@code PageFormat}.
     * @exception NullPointerException
     *              a null paper instance was passed as a parameter.
     * @see #getPaper
     */
     public void setPaper(Paper paper) {
         mPaper = (Paper)paper.clone();
     }

    
Sets the page orientation. orientation must be one of the constants: PORTRAIT, LANDSCAPE, or REVERSE_LANDSCAPE. 
Params:
orientation – the new orientation for the page
Throws:
IllegalArgumentException – if
         an unknown orientation was requested
See Also:
getOrientation/**
     * Sets the page orientation. {@code orientation} 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 PageFormat. 
See Also:
setOrientation
Returns:
this PageFormat object's orientation./**
     * Returns the orientation of this {@code PageFormat}.
     * @return this {@code PageFormat} 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 AffineTransform constructor. 
See Also:
AffineTransform
Returns:
the matrix used to translate user space rendering
to the orientation of the page./**
     * Returns a transformation matrix that translates user
     * space rendering to the requested orientation
     * of the page.  The values are placed into the
     * array as
     * {&nbsp;m00,&nbsp;m10,&nbsp;m01,&nbsp;m11,&nbsp;m02,&nbsp;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;
    }
}