Insets (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

java.awt
class Insets

java.lang.Object
  java.awt.Insets

All Implemented Interfaces:: Serializable, Cloneable

Direct Known Subclasses:: InsetsUIResource

Most common ways to construct:

Insets insets = new Insets(0, 0, 0, 0);

Based on 30 examples

Container parent = …;

Insets insets = parent.getInsets();

Based on 30 examples

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.

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
`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(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
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

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.

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.

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.

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.

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

clone

public Object clone()

Create a copy of this object.

Overrides:: clone in class Object
Returns:: a copy of this Insets object.

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 in class Object
Parameters:: obj
Returns:: true if the two insets are equal; otherwise false.

hashCode

public int hashCode()

Returns the hash code for this Insets.

Overrides:: hashCode in class Object
Returns:: a hash code for this Insets.

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.

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