PDAP Public Review Draft

java.awt
Class Insets

java.lang.Object
  |
  +--java.awt.Insets

public class Insets
extends java.lang.Object

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
See Also:
LayoutManager, Container

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(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
 boolean equals(java.lang.Object obj)
          Checks whether two insets objects are equal.
 int hashCode()
          Returns the hash code for this Insets.
 java.lang.String toString()
          Returns a string representation of this Insets object.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

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.

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.

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.

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.
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

equals

public boolean equals(java.lang.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 in class java.lang.Object
Returns:
true if the two insets are equal; otherwise false.
Since:
JDK1.1

hashCode

public int hashCode()
Returns the hash code for this Insets.
Overrides:
hashCode in class java.lang.Object
Returns:
a hash code for this Insets.

toString

public java.lang.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 in class java.lang.Object
Returns:
a string representation of this Insets object.

PDAP 1.0 Spec, Rev. 0.16