APIdia Launch Partner
Top Description Fields Constructors Methods
java.awt.print

public Class Paper

extends Object
implements Cloneable
Class Inheritance
All Implemented Interfaces
java.lang.Cloneable
Imports
java.awt.geom.Rectangle2D
The Paper class describes the physical characteristics of a piece of paper.

When creating a Paper object, it is the application's responsibility to ensure that the paper size and the imageable area are compatible. For example, if the paper size is changed from 11 x 17 to 8.5 x 11, the application might need to reduce the imageable area so that whatever is printed fits on the page.

See Also
setSize(double, double), setImageableArea(double, double, double, double)

Field Summary

Modifier and TypeField and Description
private static final int
INCH

private static final double
LETTER_HEIGHT

private static final double
LETTER_WIDTH

private double
mHeight

The height of the physical page in 1/72nds of an inch.

private Rectangle2D
mImageableArea

The area of the page on which drawing will be visible.

private double
mWidth

The width of the physical page in 1/72nds of an inch.

Constructor Summary

AccessConstructor and Description
public
Paper()

Creates a letter sized piece of paper with one inch margins.

Method Summary

Modifier and TypeMethod and Description
public Object

Returns:

a copy of this Paper.
clone()

Overrides java.lang.Object.clone.

Creates a copy of this Paper with the same contents as this Paper.

public double

Returns:

the height of the page described by this Paper.
getHeight()

Returns the height of the page in 1/72nds of an inch.

public double

Returns:

the height of the imageable area.
getImageableHeight()

Returns the height of this Paper object's imageable area.

public double

Returns:

the width of the imageable area.
getImageableWidth()

Returns the width of this Paper object's imageable area.

public double

Returns:

the x coordinate of the imageable area.
getImageableX()

Returns the x coordinate of the upper-left corner of this Paper object's imageable area.

public double

Returns:

the y coordinate of the imageable area.
getImageableY()

Returns the y coordinate of the upper-left corner of this Paper object's imageable area.

public double

Returns:

the width of the page described by this Paper.
getWidth()

Returns the width of the page in 1/72nds of an inch.

public void
setImageableArea(double
the X coordinate to which to set the upper-left corner of the imageable area of this Paper
x, double
the Y coordinate to which to set the upper-left corner of the imageable area of this Paper
y, double
the value to which to set the width of the imageable area of this Paper
width, double
the value to which to set the height of the imageable area of this Paper
height)

Sets the imageable area of this Paper.

public void
setSize(double
the value to which to set this Paper object's width
width, double
the value to which to set this Paper object's height
height)

Sets the width and height of this Paper object, which represents the properties of the page onto which printing occurs.

Inherited from java.lang.Object:
equalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

INCHback to summary
private static final int INCH
LETTER_HEIGHTback to summary
private static final double LETTER_HEIGHT
LETTER_WIDTHback to summary
private static final double LETTER_WIDTH
mHeightback to summary
private double mHeight

The height of the physical page in 1/72nds of an inch. The number is stored as a floating point value rather than as an integer to facilitate the conversion from metric units to 1/72nds of an inch and then back. (This may or may not be a good enough reason for a float).

mImageableAreaback to summary
private Rectangle2D mImageableArea

The area of the page on which drawing will be visible. The area outside of this rectangle but on the Page generally reflects the printer's hardware margins. The origin of the physical page is at (0, 0) with this rectangle provided in that coordinate system.

mWidthback to summary
private double mWidth

The width of the physical page in 1/72nds of an inch.

Constructor Detail

Paperback to summary
public Paper()

Creates a letter sized piece of paper with one inch margins.

Method Detail

cloneback to summary
public Object clone()

Overrides java.lang.Object.clone.

Creates a copy of this Paper with the same contents as this Paper.

Returns:Object

a copy of this Paper.

getHeightback to summary
public double getHeight()

Returns the height of the page in 1/72nds of an inch.

Returns:double

the height of the page described by this Paper.

getImageableHeightback to summary
public double getImageableHeight()

Returns the height of this Paper object's imageable area.

Returns:double

the height of the imageable area.

getImageableWidthback to summary
public double getImageableWidth()

Returns the width of this Paper object's imageable area.

Returns:double

the width of the imageable area.

getImageableXback to summary
public double getImageableX()

Returns the x coordinate of the upper-left corner of this Paper object's imageable area.

Returns:double

the x coordinate of the imageable area.

getImageableYback to summary
public double getImageableY()

Returns the y coordinate of the upper-left corner of this Paper object's imageable area.

Returns:double

the y coordinate of the imageable area.

getWidthback to summary
public double getWidth()

Returns the width of the page in 1/72nds of an inch.

Returns:double

the width of the page described by this Paper.

setImageableAreaback to summary
public void setImageableArea(double x, double y, double width, double height)

Sets the imageable area of this Paper. The imageable area is the area on the page in which printing occurs.

Parameters
x:double

the X coordinate to which to set the upper-left corner of the imageable area of this Paper

y:double

the Y coordinate to which to set the upper-left corner of the imageable area of this Paper

width:double

the value to which to set the width of the imageable area of this Paper

height:double

the value to which to set the height of the imageable area of this Paper

setSizeback to summary
public void setSize(double width, double height)

Sets the width and height of this Paper object, which represents the properties of the page onto which printing occurs. The dimensions are supplied in 1/72nds of an inch.

Parameters
width:double

the value to which to set this Paper object's width

height:double

the value to which to set this Paper object's height