public class

PageFormat

extends Object
implements Cloneable
java.lang.Object
   ↳ java.awt.print.PageFormat

Class Overview

The PageFormat class describes the size and orientation of a page to be printed.

Summary

Constants
int LANDSCAPE The origin is at the bottom left of the paper with x running bottom to top and y running left to right.
int PORTRAIT The origin is at the top left of the paper with x running to the right and y running down the paper.
int REVERSE_LANDSCAPE The origin is at the top right of the paper with x running top to bottom and y running right to left.
Public Constructors
PageFormat()
Creates a default, portrait-oriented PageFormat.
Public Methods
Object clone()
Makes a copy of this PageFormat with the same contents as this PageFormat.
double getHeight()
Returns the height, in 1/72nds of an inch, of the page.
double getImageableHeight()
Return the height, in 1/72nds of an inch, of the imageable area of the page.
double getImageableWidth()
Returns the width, in 1/72nds of an inch, of the imageable area of the page.
double getImageableX()
Returns the x coordinate of the upper left point of the imageable area of the Paper object associated with this PageFormat.
double getImageableY()
Returns the y coordinate of the upper left point of the imageable area of the Paper object associated with this PageFormat.
double[] getMatrix()
Returns a transformation matrix that translates user space rendering to the requested orientation of the page.
int getOrientation()
Returns the orientation of this PageFormat.
Paper getPaper()
Returns a copy of the Paper object associated with this PageFormat.
double getWidth()
Returns the width, in 1/72nds of an inch, of the page.
void setOrientation(int orientation)
Sets the page orientation.
void setPaper(Paper paper)
Sets the Paper object for this PageFormat.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final int 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.

Constant Value: 0 (0x00000000)

public static final int PORTRAIT

The origin is at the top left of the paper with x running to the right and y running down the paper.

Constant Value: 1 (0x00000001)

public static final int REVERSE_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.

Constant Value: 2 (0x00000002)

Public Constructors

public PageFormat ()

Creates a default, portrait-oriented PageFormat.

Public Methods

public Object clone ()

Makes a copy of this PageFormat with the same contents as this PageFormat.

Returns
  • a copy of this PageFormat.

public double getHeight ()

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.

public double getImageableHeight ()

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.

public double getImageableWidth ()

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.

public double getImageableX ()

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.

public double getImageableY ()

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.

public double[] getMatrix ()

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.

Returns
  • the matrix used to translate user space rendering to the orientation of the page.
See Also

public int getOrientation ()

Returns the orientation of this PageFormat.

Returns
  • this PageFormat object's orientation.
See Also

public Paper getPaper ()

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.

Returns
  • a copy of the Paper object associated with this PageFormat.
See Also

public double getWidth ()

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.

public void setOrientation (int orientation)

Sets the page orientation. orientation must be one of the constants: PORTRAIT, LANDSCAPE, or REVERSE_LANDSCAPE.

Parameters
orientation the new orientation for the page
Throws
IllegalArgumentException if an unknown orientation was requested
See Also

public void setPaper (Paper paper)

Sets the Paper object for this PageFormat.

Parameters
paper the Paper object to which to set the Paper object for this PageFormat.
Throws
a null paper instance was passed as a parameter.
See Also