com.yworks.yfiles.geometry

Class InsetsD

java.lang.Object

com.yworks.yfiles.geometry.InsetsD

All Implemented Interfaces:

com.yworks.yfiles.utils.IStruct, Cloneable

public final class InsetsD
extends Object
implements com.yworks.yfiles.utils.IStruct

An immutable struct that models the thickness of insets as double precision floating point values.

Field Summary

Fields

Modifier and Type	Field and Description
double	bottom Gets the bottom inset.
static InsetsD	EMPTY The "empty" insets that has all properties set to 0.0d.
double	left Gets the left inset.
double	right Gets the right inset.
double	top Gets the top inset.

Constructor Summary

Constructors

Constructor and Description
InsetsD()
InsetsD(double inset) Initializes a new instance using the provided inset for all four sides.
InsetsD(double top, double right, double bottom, double left) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
InsetsD	createUnion(InsetsD insets) Calculates the union of this instance and the given inset which is done by performing Math.max(double, double) on all four inset values.
static boolean	equals(InsetsD one, InsetsD two) Implements the equality operation on InsetsD comparing left and top and bottom and right for equality.
boolean	equals(Object other) Indicates whether this instance and a specified object are equal.
static InsetsD	fromLTRB(double left, double top, double right, double bottom) Initializes a new instance.
double	getBottom() Gets the bottom inset.
InsetsD	getEnlarged(InsetsD insets) Creates an enlarged instance by adding the insets of the specified insets to this instance and returning the result.
double	getHorizontalInsets() Gets the horizontal insets, which is the sum of left and right.
double	getLeft() Gets the left inset.
double	getRight() Gets the right inset.
double	getTop() Gets the top inset.
double	getVerticalInsets() Gets the vertical insets, which is the sum of top and bottom.
int	hashCode() Returns the hash code for this instance.
boolean	isEmpty() Gets a value indicating whether this instance is empty, that is all insets are 0.0d.
String	toString() Returns a String that represents this instance.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

bottom

public final double bottom

Gets the bottom inset.

EMPTY

public static final InsetsD EMPTY

The "empty" insets that has all properties set to 0.0d.

left

public final double left

Gets the left inset.

right

public final double right

Gets the right inset.

top

public final double top

Gets the top inset.

Constructor Detail

InsetsD

public InsetsD()

InsetsD

public InsetsD(double inset)

Initializes a new instance using the provided inset for all four sides.

Parameters:

inset - The inset to use for all sides.

InsetsD

public InsetsD(double top,
               double right,
               double bottom,
               double left)

Initializes a new instance.

Parameters:

top - The top inset.

right - The right inset.

bottom - The bottom inset.

left - The left inset.

Method Detail

createUnion

public final InsetsD createUnion(InsetsD insets)

Calculates the union of this instance and the given inset which is done by performing Math.max(double, double) on all four inset values.

Parameters:

insets - The insets to max with these insets.

equals

public static final boolean equals(InsetsD one,
                                   InsetsD two)

Implements the equality operation on InsetsD comparing left and top and bottom and right for equality.

Parameters:

one - The first operand.

two - The second operand.

Returns:

Whether the left, top, bottom, and right properties of the instances are equal.

equals

public boolean equals(Object other)

Indicates whether this instance and a specified object are equal.

Overrides:

equals in class Object

Parameters:

other - Another object to compare to.

Returns:

true if other and this instance are the same type and represent the same value; otherwise, false.

fromLTRB

public static final InsetsD fromLTRB(double left,
                                     double top,
                                     double right,
                                     double bottom)

Initializes a new instance.

Parameters:

left - The left inset.

top - The top inset.

right - The right inset.

bottom - The bottom inset.

getBottom

public final double getBottom()

Gets the bottom inset.

Returns:

The bottom inset.

getEnlarged

public final InsetsD getEnlarged(InsetsD insets)

Creates an enlarged instance by adding the insets of the specified insets to this instance and returning the result.

Parameters:

insets - The insets to add to this instance.

getHorizontalInsets

public final double getHorizontalInsets()

Gets the horizontal insets, which is the sum of left and right.

Returns:

The horizontal insets (left + right.

getLeft

public final double getLeft()

Gets the left inset.

Returns:

The left inset.

getRight

public final double getRight()

Gets the right inset.

Returns:

The right inset.

getTop

public final double getTop()

Gets the top inset.

Returns:

The top inset.

getVerticalInsets

public final double getVerticalInsets()

Gets the vertical insets, which is the sum of top and bottom.

Returns:

The vertical insets (top + bottom.

hashCode

public int hashCode()

Returns the hash code for this instance.

Overrides:

hashCode in class Object

Returns:

A 32-bit signed integer that is the hash code for this instance. The hash code is computed using the left, right, top, and bottom property.

isEmpty

public final boolean isEmpty()

Gets a value indicating whether this instance is empty, that is all insets are 0.0d.

Returns:

true if this instance has all properties set to 0.0d; false otherwise.

toString

public String toString()

Returns a String that represents this instance.

Overrides:

toString in class Object

Returns:

A String that represents this instance.