Index (Frames) | Index (No Frames) | Package | Package Tree | Tree
java.awt.print

Class PageFormat

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

All 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.

Author:

Field Summary

static intLANDSCAPE

A constant for a landscaped page orientation.
static intPORTRAIT

A constant for a portrait page orientation.
static intREVERSE_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

java.lang.Objectclone()

This method returns a copy of this object.
doublegetHeight()

This method returns the height of the page, in 1/72nd's of an inch.
doublegetImageableHeigth()

This method returns the imageable height of the paper, in 1/72nd's of an inch.
doublegetImageableWidth()

This method returns the imageable width of the paper, in 1/72nd's of an inch.
doublegetImageableX()

This method returns the X coordinate value of the upper leftmost drawable area of the paper.
doublegetImageableY()

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.
intgetOrientation()

This method returns the current page orientation.
java.awt.print.PapergetPaper()

Returns a copy of the paper object being used for this page format.
doublegetWidth()

This method returns the width of the page, in 1/72nd's of an inch.
voidsetOrientation(int orientation)

This method sets the page orientation for this format to the specified value.
voidsetPaper(java.awt.print.Paper paper)

Sets the Paper object to be used by this page format.

Field Details

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.


Constructor Details

PageFormat

public PageFormat()

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


Method Details

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:


getImageableWidth

public double getImageableWidth()

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

Returns:


getImageableX

public double getImageableX()

This method returns the X coordinate value of the upper leftmost drawable area of the paper.

Returns:


getImageableY

public double getImageableY()

This method returns the Y coordinate value of the upper leftmost drawable area of the paper.

Returns:


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:


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:


getPaper

public Paper getPaper()

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

Returns:


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: