public class RectangleInsets extends Object implements Serializable
Modifier and Type | Field and Description |
---|---|
static RectangleInsets |
ZERO_INSETS
A useful constant representing zero insets.
|
Constructor and Description |
---|
RectangleInsets()
Creates a new instance with all insets initialised to
1.0 . |
RectangleInsets(double top,
double left,
double bottom,
double right)
Creates a new instance with the specified insets (as 'absolute' units).
|
RectangleInsets(UnitType unitType,
double top,
double left,
double bottom,
double right)
Creates a new instance.
|
Modifier and Type | Method and Description |
---|---|
double |
calculateBottomInset(double height)
Returns the bottom margin.
|
double |
calculateBottomOutset(double height)
Returns the bottom margin.
|
double |
calculateLeftInset(double width)
Returns the left margin.
|
double |
calculateLeftOutset(double width)
Returns the left margin.
|
double |
calculateRightInset(double width)
Returns the right margin.
|
double |
calculateRightOutset(double width)
Returns the right margin.
|
double |
calculateTopInset(double height)
Returns the top margin.
|
double |
calculateTopOutset(double height)
Returns the top margin.
|
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.
|
Rectangle2D |
createInsetRectangle(Rectangle2D base)
Creates an 'inset' rectangle.
|
Rectangle2D |
createInsetRectangle(Rectangle2D base,
boolean horizontal,
boolean vertical)
Creates an 'inset' rectangle.
|
Rectangle2D |
createOutsetRectangle(Rectangle2D base)
Creates an outset rectangle.
|
Rectangle2D |
createOutsetRectangle(Rectangle2D base,
boolean horizontal,
boolean vertical)
Creates an outset rectangle.
|
boolean |
equals(Object obj)
Tests this instance for equality with an arbitrary object.
|
double |
extendHeight(double height)
Extends the given height to allow for the insets.
|
double |
extendWidth(double width)
Extends the given width to allow for the insets.
|
double |
getBottom()
Returns the bottom insets.
|
double |
getLeft()
Returns the left insets.
|
double |
getRight()
Returns the right insets.
|
double |
getTop()
Returns the top insets.
|
UnitType |
getUnitType()
Returns the unit type (absolute or relative).
|
int |
hashCode()
Returns a hash code for the object.
|
String |
toString()
Returns a textual representation of this instance, useful for debugging
purposes.
|
void |
trim(Rectangle2D area)
Shrinks the given rectangle by the amount of these insets.
|
double |
trimHeight(double height)
Trims the given height to allow for the insets.
|
double |
trimWidth(double width)
Trims the given width to allow for the insets.
|
public static final RectangleInsets ZERO_INSETS
public RectangleInsets()
1.0
.public RectangleInsets(double top, double left, double bottom, double right)
top
- the top insets.left
- the left insets.bottom
- the bottom insets.right
- the right insets.public RectangleInsets(UnitType unitType, double top, double left, double bottom, double right)
unitType
- absolute or relative units (null
not
permitted).top
- the top insets.left
- the left insets.bottom
- the bottom insets.right
- the right insets.public UnitType getUnitType()
null
).public double getTop()
public double getBottom()
public double getLeft()
public double getRight()
public boolean equals(Object obj)
public int hashCode()
public String toString()
public Rectangle2D createAdjustedRectangle(Rectangle2D base, LengthAdjustmentType horizontal, LengthAdjustmentType vertical)
base
- the base rectangle (null
not permitted).horizontal
- the horizontal adjustment type (null
not
permitted).vertical
- the vertical adjustment type (null
not
permitted).public Rectangle2D createInsetRectangle(Rectangle2D base)
base
- the base rectangle (null
not permitted).public Rectangle2D createInsetRectangle(Rectangle2D base, boolean horizontal, boolean vertical)
base
- the base rectangle (null
not permitted).horizontal
- apply horizontal insets?vertical
- apply vertical insets?public Rectangle2D createOutsetRectangle(Rectangle2D base)
base
- the base rectangle (null
not permitted).public Rectangle2D createOutsetRectangle(Rectangle2D base, boolean horizontal, boolean vertical)
base
- the base rectangle (null
not permitted).horizontal
- apply horizontal insets?vertical
- apply vertical insets?public double calculateTopInset(double height)
height
- the height of the base rectangle.public double calculateTopOutset(double height)
height
- the height of the base rectangle.public double calculateBottomInset(double height)
height
- the height of the base rectangle.public double calculateBottomOutset(double height)
height
- the height of the base rectangle.public double calculateLeftInset(double width)
width
- the width of the base rectangle.public double calculateLeftOutset(double width)
width
- the width of the base rectangle.public double calculateRightInset(double width)
width
- the width of the base rectangle.public double calculateRightOutset(double width)
width
- the width of the base rectangle.public double trimWidth(double width)
width
- the width.public double extendWidth(double width)
width
- the width.public double trimHeight(double height)
height
- the height.public double extendHeight(double height)
height
- the height.public void trim(Rectangle2D area)
area
- the area (null
not permitted).Copyright © 2001–2017 JFree.org. All rights reserved.