Skip navigation links
com.aspose.pdf.printing

Class PrinterMargins


  • public class PrinterMargins
extends Object
    Specifies the dimensions of the margins of a printed page.

    • Constructor Summary

      Constructors 
      Constructor and Description
      PrinterMargins()
      Initializes a new instance of the Margins class with 1-inch wide margins.
      PrinterMargins(int left, int right, int top, int bottom)
      Initializes a new instance of the Margins class with the specified left, right, top, and bottom margins.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      PrinterMargins deepClone()
      Retrieves a duplicate of this object, member by member.
      boolean equals(Object obj)
      Compares this Margins to the specified Object to determine whether they have the same dimensions.
      int getBottom()
      Gets or sets the bottom margin, in hundredths of an inch.
      int getLeft()
      Gets or sets the left margin width, in hundredths of an inch.
      int getRight()
      Gets or sets the right margin width, in hundredths of an inch.
      int getTop()
      Gets or sets the top margin width, in hundredths of an inch.
      int hashCode()
      Returns a hash code value for the object.
      static boolean op_Equality(PrinterMargins m1, PrinterMargins m2)
      Compares two Margins to determine if they have the same dimensions.
      static boolean op_Inequality(PrinterMargins m1, PrinterMargins m2)
      Compares two Margins to determine whether they are of unequal width.
      void setBottom(int value)
      Gets or sets the bottom margin, in hundredths of an inch.
      void setLeft(int value)
      Gets or sets the left margin width, in hundredths of an inch.
      void setRight(int value)
      Gets or sets the right margin width, in hundredths of an inch.
      void setTop(int value)
      Gets or sets the top margin width, in hundredths of an inch.

    • Constructor Detail

      • PrinterMargins

        public PrinterMargins()
        Initializes a new instance of the Margins class with 1-inch wide margins.

      • PrinterMargins

        public PrinterMargins(int left,
                      int right,
                      int top,
                      int bottom)
        Initializes a new instance of the Margins class with the specified left, right, top, and bottom margins.
        Parameters:
        left - int value
        right - int value
        top - int value
        bottom - int value

    • Method Detail

      • deepClone

        public PrinterMargins deepClone()
        Retrieves a duplicate of this object, member by member.
        Returns:
        PrinterMargins object

      • equals

        public boolean equals(Object obj)
        Compares this Margins to the specified Object to determine whether they have the same dimensions. (Overrides Object.Equals(Object).)
        Overrides:
        equals in class Object
        Returns:
        boolean value

      • hashCode

        public int hashCode()
        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. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)

        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)

      • getBottom

        public int getBottom()
        Gets or sets the bottom margin, in hundredths of an inch.
        Returns:
        int value

      • setBottom

        public void setBottom(int value)
        Gets or sets the bottom margin, in hundredths of an inch.
        Parameters:
        value - int value

      • getLeft

        public int getLeft()
        Gets or sets the left margin width, in hundredths of an inch.
        Returns:
        int value

      • setLeft

        public void setLeft(int value)
        Gets or sets the left margin width, in hundredths of an inch.
        Parameters:
        value - int value

      • getRight

        public int getRight()
        Gets or sets the right margin width, in hundredths of an inch.
        Returns:
        int value

      • setRight

        public void setRight(int value)
        Gets or sets the right margin width, in hundredths of an inch.
        Parameters:
        value - int value

      • getTop

        public int getTop()
        Gets or sets the top margin width, in hundredths of an inch.
        Returns:
        int value

      • setTop

        public void setTop(int value)
        Gets or sets the top margin width, in hundredths of an inch.
        Parameters:
        value - int value

      • op_Equality

        public static boolean op_Equality(PrinterMargins m1,
                                  PrinterMargins m2)
        Compares two Margins to determine if they have the same dimensions.
        Parameters:
        m1 - PrinterMargins object
        m2 - PrinterMargins object
        Returns:
        boolean value

      • op_Inequality

        public static boolean op_Inequality(PrinterMargins m1,
                                    PrinterMargins m2)
        Compares two Margins to determine whether they are of unequal width.
        Parameters:
        m1 - PrinterMargins object
        m2 - PrinterMargins object
        Returns:
        boolean value