- java.lang.Object
-
- java.awt.print.PageFormat
-
-
Field Summary
Fields Modifier and Type Field and Description static int
LANDSCAPE
The origin is at the bottom left of the paper with x running bottom to top and y running left to right.static int
PORTRAIT
The origin is at the top left of the paper with x running to the right and y running down the paper.static 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.
-
Constructor Summary
Constructors Constructor and Description PageFormat()
Creates a default, portrait-orientedPageFormat
.
-
Method Summary
Methods Modifier and Type Method and Description Object
clone()
Makes a copy of thisPageFormat
with the same contents as thisPageFormat
.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 thePaper
object associated with thisPageFormat
.double
getImageableY()
Returns the y coordinate of the upper left point of the imageable area of thePaper
object associated with thisPageFormat
.double[]
getMatrix()
Returns a transformation matrix that translates user space rendering to the requested orientation of the page.int
getOrientation()
Returns the orientation of thisPageFormat
.Paper
getPaper()
Returns a copy of thePaper
object associated with thisPageFormat
.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 thePaper
object for thisPageFormat
.
-
-
-
Field Detail
-
LANDSCAPE
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.- See Also:
- Constant Field Values
-
PORTRAIT
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.- See Also:
- Constant Field Values
-
REVERSE_LANDSCAPE
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.- See Also:
- Constant Field Values
-
-
Method Detail
-
clone
public Object clone()
Makes a copy of thisPageFormat
with 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 thePaper
object 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
Paper
object associated with thisPageFormat
.
-
getImageableY
public double getImageableY()
Returns the y coordinate of the upper left point of the imageable area of thePaper
object 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
Paper
object 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
public Paper getPaper()
Returns a copy of thePaper
object associated with thisPageFormat
. Changes made to thePaper
object returned from this method do not affect thePaper
object of thisPageFormat
. To update thePaper
object of thisPageFormat
, create a newPaper
object and set it into thisPageFormat
by using thesetPaper(Paper)
method.- Returns:
- a copy of the
Paper
object associated with thisPageFormat
. - See Also:
setPaper(java.awt.print.Paper)
-
setPaper
public void setPaper(Paper paper)
Sets thePaper
object for thisPageFormat
.- Parameters:
paper
- thePaper
object to which to set thePaper
object for thisPageFormat
.- Throws:
- a null paper instance was passed as a parameter.NullPointerException
- See Also:
getPaper()
-
setOrientation
public void setOrientation(int orientation) throws IllegalArgumentException
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:
getOrientation()
-
getOrientation
public int getOrientation()
Returns the orientation of thisPageFormat
.- Returns:
- this
PageFormat
object's orientation. - See Also:
setOrientation(int)
-
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 theAffineTransform
constructor.- Returns:
- the matrix used to translate user space rendering to the orientation of the page.
- See Also:
AffineTransform
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/awt/print/PageFormat.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.