Module platform
Package org.jfree.chart.ui

Class RectangleInsets

java.lang.Object
org.jfree.chart.ui.RectangleInsets
All Implemented Interfaces:
Serializable
public class RectangleInsets extends Object implements Serializable
Represents the insets for a rectangle, specified in absolute or relative terms. This class is immutable.
See Also:

  • Field Details

    • ZERO_INSETS

      public static final RectangleInsets ZERO_INSETS
      A useful constant representing zero insets.

  • Constructor Details

    • RectangleInsets

      public RectangleInsets()
      Creates a new instance with all insets initialised to 1.0.

    • RectangleInsets

      public RectangleInsets(double top, double left, double bottom, double right)
      Creates a new instance with the specified insets (as 'absolute' units).
      Parameters:
      top - the top insets.
      left - the left insets.
      bottom - the bottom insets.
      right - the right insets.

    • RectangleInsets

      public RectangleInsets(UnitType unitType, double top, double left, double bottom, double right)
      Creates a new instance.
      Parameters:
      unitType - absolute or relative units (null not permitted).
      top - the top insets.
      left - the left insets.
      bottom - the bottom insets.
      right - the right insets.

  • Method Details

    • getUnitType

      public UnitType getUnitType()
      Returns the unit type (absolute or relative). This specifies whether the insets are measured as Java2D units or percentages.
      Returns:
      The unit type (never null).

    • getTop

      public double getTop()
      Returns the top insets.
      Returns:
      The top insets.

    • getBottom

      public double getBottom()
      Returns the bottom insets.
      Returns:
      The bottom insets.

    • getLeft

      public double getLeft()
      Returns the left insets.
      Returns:
      The left insets.

    • getRight

      public double getRight()
      Returns the right insets.
      Returns:
      The right insets.

    • equals

      public boolean equals(Object obj)
      Tests this instance for equality with an arbitrary object.
      Overrides:
      equals in class Object
      Parameters:
      obj - the object (null permitted).
      Returns:
      A boolean.

    • hashCode

      public int hashCode()
      Returns a hash code for the object.
      Overrides:
      hashCode in class Object
      Returns:
      A hash code.

    • toString

      public String toString()
      Returns a textual representation of this instance, useful for debugging purposes.
      Overrides:
      toString in class Object
      Returns:
      A string representing this instance.

    • createAdjustedRectangle

      public Rectangle2D createAdjustedRectangle(Rectangle2D base, LengthAdjustmentType horizontal, LengthAdjustmentType vertical)
      Creates an adjusted rectangle using the supplied rectangle, the insets specified by this instance, and the horizontal and vertical adjustment types.
      Parameters:
      base - the base rectangle (null not permitted).
      horizontal - the horizontal adjustment type (null not permitted).
      vertical - the vertical adjustment type (null not permitted).
      Returns:
      The inset rectangle.

    • createInsetRectangle

      public Rectangle2D createInsetRectangle(Rectangle2D base)
      Creates an 'inset' rectangle.
      Parameters:
      base - the base rectangle (null not permitted).
      Returns:
      The inset rectangle.

    • createInsetRectangle

      public Rectangle2D createInsetRectangle(Rectangle2D base, boolean horizontal, boolean vertical)
      Creates an 'inset' rectangle.
      Parameters:
      base - the base rectangle (null not permitted).
      horizontal - apply horizontal insets?
      vertical - apply vertical insets?
      Returns:
      The inset rectangle.

    • createOutsetRectangle

      public Rectangle2D createOutsetRectangle(Rectangle2D base)
      Creates an outset rectangle.
      Parameters:
      base - the base rectangle (null not permitted).
      Returns:
      An outset rectangle.

    • createOutsetRectangle

      public Rectangle2D createOutsetRectangle(Rectangle2D base, boolean horizontal, boolean vertical)
      Creates an outset rectangle.
      Parameters:
      base - the base rectangle (null not permitted).
      horizontal - apply horizontal insets?
      vertical - apply vertical insets?
      Returns:
      An outset rectangle.

    • calculateTopInset

      public double calculateTopInset(double height)
      Returns the top margin.
      Parameters:
      height - the height of the base rectangle.
      Returns:
      The top margin (in Java2D units).

    • calculateTopOutset

      public double calculateTopOutset(double height)
      Returns the top margin.
      Parameters:
      height - the height of the base rectangle.
      Returns:
      The top margin (in Java2D units).

    • calculateBottomInset

      public double calculateBottomInset(double height)
      Returns the bottom margin.
      Parameters:
      height - the height of the base rectangle.
      Returns:
      The bottom margin (in Java2D units).

    • calculateBottomOutset

      public double calculateBottomOutset(double height)
      Returns the bottom margin.
      Parameters:
      height - the height of the base rectangle.
      Returns:
      The bottom margin (in Java2D units).

    • calculateLeftInset

      public double calculateLeftInset(double width)
      Returns the left margin.
      Parameters:
      width - the width of the base rectangle.
      Returns:
      The left margin (in Java2D units).

    • calculateLeftOutset

      public double calculateLeftOutset(double width)
      Returns the left margin.
      Parameters:
      width - the width of the base rectangle.
      Returns:
      The left margin (in Java2D units).

    • calculateRightInset

      public double calculateRightInset(double width)
      Returns the right margin.
      Parameters:
      width - the width of the base rectangle.
      Returns:
      The right margin (in Java2D units).

    • calculateRightOutset

      public double calculateRightOutset(double width)
      Returns the right margin.
      Parameters:
      width - the width of the base rectangle.
      Returns:
      The right margin (in Java2D units).

    • trimWidth

      public double trimWidth(double width)
      Trims the given width to allow for the insets.
      Parameters:
      width - the width.
      Returns:
      The trimmed width.

    • extendWidth

      public double extendWidth(double width)
      Extends the given width to allow for the insets.
      Parameters:
      width - the width.
      Returns:
      The extended width.

    • trimHeight

      public double trimHeight(double height)
      Trims the given height to allow for the insets.
      Parameters:
      height - the height.
      Returns:
      The trimmed height.

    • extendHeight

      public double extendHeight(double height)
      Extends the given height to allow for the insets.
      Parameters:
      height - the height.
      Returns:
      The extended height.

    • trim

      public void trim(Rectangle2D area)
      Shrinks the given rectangle by the amount of these insets.
      Parameters:
      area - the area (null not permitted).