Module javafx.graphics
Package javafx.print

Class Paper


  • public final class Paper
extends Object
    A class which encapsulates the size of paper media as used by printers.

    The paper sizes which are enumerated for a printer is the authoritative source of Paper sizes that may be selected for printing on that printer.

    However for convenience, this class pre-defines some of the most common paper sizes so that an application may easily set up default parameters from code, eg by referring to Paper.A4

    Since:
    JavaFX 8.0

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static Paper A0
      Specifies the ISO A0 size, 841 mm by 1189 mm.
      static Paper A1
      Specifies the ISO A1 size, 594 mm by 841 mm.
      static Paper A2
      Specifies the ISO A2 size, 420 mm by 594 mm.
      static Paper A3
      Specifies the ISO A3 size, 297 mm by 420 mm.
      static Paper A4
      Specifies the ISO A4 size, 210 mm by 297 mm.
      static Paper A5
      Specifies the ISO A5 size, 148 mm by 210 mm.
      static Paper A6
      Specifies the ISO A6 size, 105 mm by 148 mm.
      static Paper C
      Specifies the engineering C size, 17 inch by 22 inch.
      static Paper DESIGNATED_LONG
      Specifies the ISO Designated Long size, 110 mm by 220 mm.
      static Paper EXECUTIVE
      Specifies the executive size, 7.25 inches by 10.5 inches.
      static Paper JAPANESE_POSTCARD
      Specifies the Japanese postcard size, 100 mm by 148 mm.
      static Paper JIS_B4
      Specifies the JIS B4 size, 257 mm by 364 mm.
      static Paper JIS_B5
      Specifies the JIS B5 size, 182 mm by 257 mm.
      static Paper JIS_B6
      Specifies the JIS B6 size, 128 mm by 182 mm.
      static Paper LEGAL
      Specifies the North American legal size, 8.5 inches by 14 inches.
      static Paper MONARCH_ENVELOPE
      Specifies the Monarch envelope size, 3.87 inch by 7.5 inch.
      static Paper NA_8X10
      Specifies the North American 8 inch by 10 inch paper.
      static Paper NA_LETTER
      Specifies the North American letter size, 8.5 inches by 11 inches
      static Paper NA_NUMBER_10_ENVELOPE
      Specifies the North American Number 10 business envelope size, 4.125 inches by 9.5 inches.
      static Paper TABLOID
      Specifies the tabloid size, 11 inches by 17 inches.

    • Field Detail

      • A0

        public static final Paper A0
        Specifies the ISO A0 size, 841 mm by 1189 mm.

      • A1

        public static final Paper A1
        Specifies the ISO A1 size, 594 mm by 841 mm.

      • A2

        public static final Paper A2
        Specifies the ISO A2 size, 420 mm by 594 mm.

      • A3

        public static final Paper A3
        Specifies the ISO A3 size, 297 mm by 420 mm.

      • A4

        public static final Paper A4
        Specifies the ISO A4 size, 210 mm by 297 mm.

      • A5

        public static final Paper A5
        Specifies the ISO A5 size, 148 mm by 210 mm.

      • A6

        public static final Paper A6
        Specifies the ISO A6 size, 105 mm by 148 mm.

      • DESIGNATED_LONG

        public static final Paper DESIGNATED_LONG
        Specifies the ISO Designated Long size, 110 mm by 220 mm.

      • NA_LETTER

        public static final Paper NA_LETTER
        Specifies the North American letter size, 8.5 inches by 11 inches

      • LEGAL

        public static final Paper LEGAL
        Specifies the North American legal size, 8.5 inches by 14 inches.

      • TABLOID

        public static final Paper TABLOID
        Specifies the tabloid size, 11 inches by 17 inches.

      • EXECUTIVE

        public static final Paper EXECUTIVE
        Specifies the executive size, 7.25 inches by 10.5 inches.

      • NA_8X10

        public static final Paper NA_8X10
        Specifies the North American 8 inch by 10 inch paper.

      • MONARCH_ENVELOPE

        public static final Paper MONARCH_ENVELOPE
        Specifies the Monarch envelope size, 3.87 inch by 7.5 inch.

      • NA_NUMBER_10_ENVELOPE

        public static final Paper NA_NUMBER_10_ENVELOPE
        Specifies the North American Number 10 business envelope size, 4.125 inches by 9.5 inches.

      • C

        public static final Paper C
        Specifies the engineering C size, 17 inch by 22 inch.

      • JIS_B4

        public static final Paper JIS_B4
        Specifies the JIS B4 size, 257 mm by 364 mm.

      • JIS_B5

        public static final Paper JIS_B5
        Specifies the JIS B5 size, 182 mm by 257 mm.

      • JIS_B6

        public static final Paper JIS_B6
        Specifies the JIS B6 size, 128 mm by 182 mm.

      • JAPANESE_POSTCARD

        public static final Paper JAPANESE_POSTCARD
        Specifies the Japanese postcard size, 100 mm by 148 mm.

    • Method Detail

      • getName

        public final String getName​()
        Get the paper name. This may not be directly useful for user display as it is not localized.
        Returns:
        the paper name

      • getWidth

        public final double getWidth​()
        Get the width of the paper in points (1/72 inch)
        Returns:
        the width of the paper in points (1/72 inch)

      • getHeight

        public final double getHeight​()
        Get the height of the paper in points (1/72 inch)
        Returns:
        the height of the paper in points (1/72 inch)

      • hashCode

        public final int hashCode​()
        Description copied from class: Object
        Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

        The general contract of hashCode is:

        • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
        • If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
        • It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

        As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (The hashCode may or may not be implemented as some function of an object's memory address at some point in time.)

        Overrides:
        hashCode in class Object
        Returns:
        a hash code value for this object.
        See Also:
        Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

      • equals

        public final boolean equals​(Object o)
        Description copied from class: Object
        Indicates whether some other object is "equal to" this one.

        The equals method implements an equivalence relation on non-null object references:

        • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
        • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
        • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
        • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
        • For any non-null reference value x, x.equals(null) should return false.

        The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

        Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

        Overrides:
        equals in class Object
        Parameters:
        o - the reference object with which to compare.
        Returns:
        true if this object is the same as the obj argument; false otherwise.
        See Also:
        Object.hashCode(), HashMap

      • toString

        public final String toString​()
        Description copied from class: Object
        Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

        The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of: 

         getClass().getName() + '@' + Integer.toHexString(hashCode())
        Overrides:
        toString in class Object
        Returns:
        a string representation of the object.