/*
* @(#)Insets.java 1.22 06/10/10
*
* Copyright 1990-2008 Sun Microsystems, Inc. All Rights Reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License version
* 2 only, as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License version 2 for more details (a copy is
* included at /legal/license.txt).
*
* You should have received a copy of the GNU General Public License
* version 2 along with this work; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA
*
* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
* Clara, CA 95054 or visit www.sun.com if you need additional
* information or have any questions.
*
*/
package java.awt;
/**
* An <code>Insets</code> 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.
*
* @version 1.18, 08/19/02
* @author Arthur van Hoff
* @author Sami Shaio
* @see java.awt.LayoutManager
* @see java.awt.Container
* @since JDK1.0
*/
public class Insets implements Cloneable, java.io.Serializable {
/**
* The inset from the top.
* @since JDK1.0
*/
public int top;
/**
* The inset from the left.
* @since JDK1.0
*/
public int left;
/**
* The inset from the bottom.
* @since JDK1.0
*/
public int bottom;
/**
* The inset from the right.
* @since JDK1.0
*/
public int right;
/*
* JDK 1.1 serialVersionUID
*/
private static final long serialVersionUID = -2272572637695466749L;
/**
* Creates and initializes a new <code>Insets</code> object with the
* specified top, left, bottom, and right insets.
* @param top the inset from the top.
* @param left the inset from the left.
* @param bottom the inset from the bottom.
* @param right the inset from the right.
* @since JDK1.0
*/
public Insets(int top, int left, int bottom, int right) {
this.top = top;
this.left = left;
this.bottom = bottom;
this.right = right;
}
/**
* Checks whether two insets objects are equal. Two instances
* of <code>Insets</code> are equal if the four integer values
* of the fields <code>top</code>, <code>left</code>,
* <code>bottom</code>, and <code>right</code> are all equal.
* @return <code>true</code> if the two insets are equal;
* otherwise <code>false</code>.
* @since JDK1.1
*/
public boolean equals(Object obj) {
if (obj instanceof Insets) {
Insets insets = (Insets) obj;
return ((top == insets.top) && (left == insets.left) &&
(bottom == insets.bottom) && (right == insets.right));
}
return false;
}
/**
* Returns a <code>String</code> object representing this
* <code>Insets</code> object's values.
* @return a string representation of this <code>Insets</code> object,
* including the values of its member fields.
* @since JDK1.0
*/
public String toString() {
return getClass().getName() + "[top=" + top + ",left=" + left + ",bottom=" + bottom + ",right=" + right + "]";
}
/**
* Create a copy of this object.
* @return a copy of this <code>Insets</code> object.
* @since JDK1.0
*/
public Object clone() {
try {
return super.clone();
} catch (CloneNotSupportedException e) {
// this shouldn't happen, since we are Cloneable
throw new InternalError();
}
}
}