java.awt.print

Class PageFormat

java.lang.Object
- java.awt.print.PageFormat

Implemented Interfaces:: Cloneable

public class PageFormat

extends Object

implements Cloneable

This class contains information about the desired page format to use for printing a particular set of pages.

Field Summary
`static int`	`LANDSCAPE` A constant for a landscaped page orientation.
`static int`	`PORTRAIT` A constant for a portrait page orientation.
`static int`	`REVERSE_LANDSCAPE` A constant for a reversed landscaped page orientation.

Constructor Summary
`PageFormat()` This method creates a default page layout, which will be in portrait format.

Method Summary
`Object`	`clone()` This method returns a copy of this object.
`double`	`getHeight()` This method returns the height of the page, in 1/72nd's of an inch.
`double`	`getImageableHeight()` This method returns the imageable height of the paper, in 1/72nd's of an inch.
`double`	`getImageableWidth()` This method returns the imageable width of the paper, in 1/72nd's of an inch.
`double`	`getImageableX()` This method returns the X coordinate value of the upper leftmost drawable area of the paper.
`double`	`getImageableY()` This method returns the Y coordinate value of the upper leftmost drawable area of the paper.
`double[]`	`getMatrix()` This method returns a matrix used for transforming user space coordinates to page coordinates.
`int`	`getOrientation()` This method returns the current page orientation.
`Paper`	`getPaper()` Returns a copy of the `paper` object being used for this page format.
`double`	`getWidth()` This method returns the width of the page, in 1/72nd's of an inch.
`void`	`setOrientation(int orientation)` This method sets the page orientation for this format to the specified value.
`void`	`setPaper(Paper paper)` Sets the `Paper` object to be used by this page format.

Methods inherited from class java.lang.Object
`clone`, `equals`, `extends Object> getClass`, `finalize`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait`

LANDSCAPE

public static final int LANDSCAPE

A constant for a landscaped page orientation. Used by getOrientation and setOrientation.
Field Value:
0

PORTRAIT

public static final int PORTRAIT

A constant for a portrait page orientation. Used by getOrientation and setOrientation.
Field Value:
1

REVERSE_LANDSCAPE

public static final int REVERSE_LANDSCAPE

A constant for a reversed landscaped page orientation. This is the orientation used by Macintosh's for landscape. The origin is in the upper right hand corner instead of the upper left. The X and Y axes are reversed. Used by getOrientation and setOrientation.
Field Value:
2

PageFormat

public PageFormat()

This method creates a default page layout, which will be in portrait format.

clone

public Object clone()

This method returns a copy of this object.
Overrides:
clone in interface Object
Returns:
A copy of this object.

getHeight

public double getHeight()

This method returns the height of the page, in 1/72nd's of an inch. The "height" measured depends on the orientation.
Returns:
The height of the page.

getImageableHeight

public double getImageableHeight()

This method returns the imageable height of the paper, in 1/72nd's of an inch.
Returns:
The imageable height of the paper.

getImageableWidth

public double getImageableWidth()

This method returns the imageable width of the paper, in 1/72nd's of an inch.
Returns:
The imageable width of the paper.

getImageableX

public double getImageableX()

This method returns the X coordinate value of the upper leftmost drawable area of the paper.
Returns:
The upper leftmost imageable X coordinate.

getImageableY

public double getImageableY()

This method returns the Y coordinate value of the upper leftmost drawable area of the paper.
Returns:
The upper leftmost imageable Y coordinate.

getMatrix

public double[] getMatrix()

This method returns a matrix used for transforming user space coordinates to page coordinates. The value returned will be six doubles as described in java.awt.geom.AffineTransform.
Returns:
The transformation matrix for this page format.

getOrientation

public int getOrientation()

This method returns the current page orientation. The value returned will be one of the page orientation constants from this class.
Returns:
The current page orientation.

getPaper

public Paper getPaper()

Returns a copy of the paper object being used for this page format.
Returns:
A copy of the Paper object for this format.

getWidth

public double getWidth()

This method returns the width of the page, in 1/72nd's of an inch. The "width" measured depends on orientation.
Returns:
The width of the page.

setOrientation

public void setOrientation(int orientation)
            throws IllegalArgumentException

This method sets the page orientation for this format to the specified value. It must be one of the page orientation constants from this class or an exception will be thrown.
Parameters:
orientation - The new page orientation.
Throws:
IllegalArgumentException - If the specified page orientation value is not one of the constants from this class.

setPaper

public void setPaper(Paper paper)

Sets the Paper object to be used by this page format.
Parameters:
paper - The new Paper object for this page format.

PageFormat.java -- Information about the page format Copyright (C) 1999, 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath 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 for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About
Prev Class \| Next Class		Frames \| No Frames
Summary: Nested \| Field \| Method \| Constr	Detail: Nested \| Field \| Method \| Constr