java.lang.Object
java.awt.print.PageFormat
- All Implemented Interfaces:
Cloneable
The
PageFormat class describes the size and
orientation of a page to be printed.-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe origin is at the bottom left of the paper with x running bottom to top and y running left to right.static final intThe origin is at the top left of the paper with x running to the right and y running down the paper.static final intThe origin is at the top right of the paper with x running top to bottom and y running right to left. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()Makes a copy of thisPageFormatwith the same contents as thisPageFormat.doubleReturns the height, in 1/72nds of an inch, of the page.doubleReturn the height, in 1/72nds of an inch, of the imageable area of the page.doubleReturns the width, in 1/72nds of an inch, of the imageable area of the page.doubleReturns the x coordinate of the upper left point of the imageable area of thePaperobject associated with thisPageFormat.doubleReturns the y coordinate of the upper left point of the imageable area of thePaperobject associated with thisPageFormat.double[]Returns a transformation matrix that translates user space rendering to the requested orientation of the page.intReturns the orientation of thisPageFormat.getPaper()Returns a copy of thePaperobject associated with thisPageFormat.doublegetWidth()Returns the width, in 1/72nds of an inch, of the page.voidsetOrientation(int orientation) Sets the page orientation.voidSets thePaperobject for thisPageFormat.
-
Field Details
-
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.- See Also:
-
PORTRAIT
The origin is at the top left of the paper with x running to the right and y running down the paper.- See Also:
-
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.- See Also:
-
-
Constructor Details
-
PageFormat
public PageFormat()Creates a default, portrait-orientedPageFormat.
-
-
Method Details
-
clone
Makes a copy of thisPageFormatwith the same contents as thisPageFormat. -
getWidth
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.
-
getHeight
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.
-
getImageableX
public double getImageableX()Returns the x coordinate of the upper left point of the imageable area of thePaperobject associated with thisPageFormat. 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
Paperobject associated with thisPageFormat.
-
getImageableY
public double getImageableY()Returns the y coordinate of the upper left point of the imageable area of thePaperobject associated with thisPageFormat. 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
Paperobject associated with thisPageFormat.
-
getImageableWidth
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.
-
getImageableHeight
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.
-
getPaper
Returns a copy of thePaperobject associated with thisPageFormat. Changes made to thePaperobject returned from this method do not affect thePaperobject of thisPageFormat. To update thePaperobject of thisPageFormat, create a newPaperobject and set it into thisPageFormatby using thesetPaper(Paper)method.- Returns:
- a copy of the
Paperobject associated with thisPageFormat. - See Also:
-
setPaper
Sets thePaperobject for thisPageFormat.- Parameters:
paper- thePaperobject to which to set thePaperobject for thisPageFormat.- Throws:
NullPointerException- a null paper instance was passed as a parameter.- See Also:
-
setOrientation
Sets the page orientation.orientationmust 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:
-
getOrientation
public int getOrientation()Returns the orientation of thisPageFormat.- Returns:
- this
PageFormatobject's orientation. - See Also:
-
getMatrix
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 theAffineTransformconstructor.- Returns:
- the matrix used to translate user space rendering to the orientation of the page.
- See Also:
-