java.awt.print
Class PageFormat
java.lang.Object
|
+--java.awt.print.PageFormat
All Implemented Interfaces:
Cloneable
This class contains information about the desired page format to
use for printing a particular set of pages.
Author:- Aaron M. Renn (arenn@urbanophile.com)
LANDSCAPE
public static final int LANDSCAPE
A constant for a landscaped page orientation. Used by
getOrientation
and setOrientation
.
PORTRAIT
public static final int PORTRAIT
A constant for a portrait page orientation. Used by
getOrientation
and setOrientation
.
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
.
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.
Returns:
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:
getImageableHeigth
public double getImageableHeigth()
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:
setOrientation
public void setOrientation(int orientation)
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:
Throws:
setPaper
public void setPaper(java.awt.print.Paper paper)
Sets the Paper
object to be used by this page format.
Parameters: