Class Margins


  • public final class Margins
    extends java.lang.Object
    A class to describe a set of margins. It consists of left, top, right, and, bottom rectangle insets.

    Instances of this class are immutable.

    • Constructor Summary

      Constructors 
      Constructor Description
      Margins()
      Instantiates Margins with zero insets.
      Margins​(Margins source)
      Instantiates Margins from the given Margins.
      Margins​(UnitSpan marginLeft, UnitSpan marginTop, UnitSpan marginRight, UnitSpan marginBottom)
      Instantiates Margins specified by the given UnitSpan insets.
    • Constructor Detail

      • Margins

        public Margins()
        Instantiates Margins with zero insets.
      • Margins

        public Margins​(UnitSpan marginLeft,
                       UnitSpan marginTop,
                       UnitSpan marginRight,
                       UnitSpan marginBottom)
        Instantiates Margins specified by the given UnitSpan insets.
        Parameters:
        marginLeft - the left margin.
        marginTop - the top margin.
        marginRight - the right margin.
        marginBottom - the bottom margin.
      • Margins

        public Margins​(Margins source)
        Instantiates Margins from the given Margins.
        Parameters:
        source - the Margins to copy to this object.
    • Method Detail

      • equals

        public boolean equals​(java.lang.Object object)
        Determines if this object is equal to the given margins.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        object - the margins to compare.
        Returns:
        true if equal, false otherwise.
      • hashCode

        public int hashCode()
        Returns a hash code value for the object. This method is unsupported.
        Overrides:
        hashCode in class java.lang.Object
      • marginBottom

        public UnitSpan marginBottom()
        Gets this object's bottom margin.
        Returns:
        the bottom margin.
      • marginLeft

        public UnitSpan marginLeft()
        Gets this object's left margin.
        Returns:
        the left margin.
      • marginTop

        public UnitSpan marginTop()
        Gets this object's top margin.
        Returns:
        the top margin.
      • marginRight

        public UnitSpan marginRight()
        Gets this object's right margin.
        Returns:
        the right margin.