- java.lang.Object
-
- java.awt.print.PageFormat
-
-
Field Summary
Fields Modifier and Type Field Description static intLANDSCAPEThe origin is at the bottom left of the paper with x running bottom to top and y running left to right.static intPORTRAITThe origin is at the top left of the paper with x running to the right and y running down the paper.static intREVERSE_LANDSCAPEThe 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 Description PageFormat()Creates a default, portrait-orientedPageFormat.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Objectclone()Makes a copy of thisPageFormatwith the same contents as thisPageFormat.doublegetHeight()Returns the height, in 1/72nds of an inch, of the page.doublegetImageableHeight()Return the height, in 1/72nds of an inch, of the imageable area of the page.doublegetImageableWidth()Returns the width, in 1/72nds of an inch, of the imageable area of the page.doublegetImageableX()Returns the x coordinate of the upper left point of the imageable area of thePaperobject associated with thisPageFormat.doublegetImageableY()Returns the y coordinate of the upper left point of the imageable area of thePaperobject associated with thisPageFormat.double[]getMatrix()Returns a transformation matrix that translates user space rendering to the requested orientation of the page.intgetOrientation()Returns the orientation of thisPageFormat.PapergetPaper()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.voidsetPaper(Paper paper)Sets thePaperobject for thisPageFormat.
-
-
-
Field Detail
-
LANDSCAPE
@Native 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
@Native 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
@Native 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 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
public Paper 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(java.awt.print.Paper)
-
setPaper
public void setPaper(Paper paper)
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:
getPaper()
-
setOrientation
public void setOrientation(int orientation) throws IllegalArgumentExceptionSets 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()
-
getOrientation
public int getOrientation()
Returns the orientation of thisPageFormat.- Returns:
- this
PageFormatobject'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 theAffineTransformconstructor.- Returns:
- the matrix used to translate user space rendering to the orientation of the page.
- See Also:
AffineTransform
-
-