Insets (Java 2 Platform SE 5.0) (original) (raw)

java.awt

Class Insets

java.lang.Object extended by java.awt.Insets

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

InsetsUIResource

public class Insets

extends Object

implements Cloneable, Serializable

An Insets object is a representation of the borders of a container. It specifies the space that a container must leave at each of its edges. The space can be a border, a blank space, or a title.

Since:

JDK1.0

Field Summary
int	bottom The inset from the bottom.
int	left The inset from the left.
int	right The inset from the right.
int	top The inset from the top.

Constructor Summary
[Insets](../../java/awt/Insets.html#Insets%28int, int, int, int%29)(int top, int left, int bottom, int right) Creates and initializes a new Insets object with the specified top, left, bottom, and right insets.

Method Summary
Object	clone() Create a copy of this object.
boolean	equals(Object obj) Checks whether two insets objects are equal.
int	hashCode() Returns the hash code for this Insets.
void	[set](../../java/awt/Insets.html#set%28int, int, int, int%29)(int top, int left, int bottom, int right) Set top, left, bottom, and right to the specified values
String	toString() Returns a string representation of this Insets object.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, [wait](../../java/lang/Object.html#wait%28long, int%29)

Field Detail

top

public int top

The inset from the top. This value is added to the Top of the rectangle to yield a new location for the Top.

See Also:

clone()

left

public int left

The inset from the left. This value is added to the Left of the rectangle to yield a new location for the Left edge.

See Also:

clone()

bottom

public int bottom

The inset from the bottom. This value is subtracted from the Bottom of the rectangle to yield a new location for the Bottom.

See Also:

clone()

right

public int right

The inset from the right. This value is subtracted from the Right of the rectangle to yield a new location for the Right edge.

See Also:

clone()

Constructor Detail

Insets

public Insets(int top, int left, int bottom, int right)

Creates and initializes a new Insets object with the specified top, left, bottom, and right insets.

Parameters:

top - the inset from the top.

left - the inset from the left.

bottom - the inset from the bottom.

right - the inset from the right.

Method Detail

set

public void set(int top, int left, int bottom, int right)

Set top, left, bottom, and right to the specified values

Parameters:

top - the inset from the top.

left - the inset from the left.

bottom - the inset from the bottom.

right - the inset from the right.

Since:

1.5

equals

public boolean equals(Object obj)

Checks whether two insets objects are equal. Two instances of Insets are equal if the four integer values of the fields top, left, bottom, and right are all equal.

Overrides:

[equals](../../java/lang/Object.html#equals%28java.lang.Object%29) in class [Object](../../java/lang/Object.html "class in java.lang")

Parameters:

obj - the reference object with which to compare.

Returns:

true if the two insets are equal; otherwise false.

Since:

JDK1.1

See Also:

Object.hashCode(), Hashtable

hashCode

public int hashCode()

Returns the hash code for this Insets.

Overrides:

[hashCode](../../java/lang/Object.html#hashCode%28%29) in class [Object](../../java/lang/Object.html "class in java.lang")

Returns:

a hash code for this Insets.

toString

public String toString()

Returns a string representation of this Insets object. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null.

Overrides:

[toString](../../java/lang/Object.html#toString%28%29) in class [Object](../../java/lang/Object.html "class in java.lang")

Returns:

a string representation of this Insets object.

clone

public Object clone()

Create a copy of this object.

Overrides:

[clone](../../java/lang/Object.html#clone%28%29) in class [Object](../../java/lang/Object.html "class in java.lang")

Returns:

a copy of this Insets object.

See Also:

Cloneable

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.