001/* Insets.java -- information about a container border
002   Copyright (C) 1999, 2000, 2002, 2005, 2006  Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package java.awt;
040
041import java.io.Serializable;
042
043/**
044 * This class represents the "margin" or space around a container.
045 *
046 * @author Aaron M. Renn (arenn@urbanophile.com)
047 * @author Eric Blake (ebb9@email.byu.edu)
048 * @status
049 */
050public class Insets implements Cloneable, Serializable
051{
052  /**
053   * Compatible with JDK 1.0+.
054   */
055  private static final long serialVersionUID = -2272572637695466749L;
056
057  /**
058   * The gap from the top.
059   *
060   * @serial the top inset
061   */
062  public int top;
063
064  /**
065   * The gap from the left.
066   *
067   * @serial the left inset
068   */
069  public int left;
070
071  /**
072   * The gap from the bottom.
073   *
074   * @serial the bottom inset
075   */
076  public int bottom;
077
078  /**
079   * The gap from the right.
080   *
081   * @serial the right inset
082   */
083  public int right;
084
085  /**
086   * Initializes a new instance of <code>Inset</code> with the specified
087   * inset values.
088   *
089   * @param top the top inset
090   * @param left the left inset
091   * @param bottom the bottom inset
092   * @param right the right inset
093   */
094  public Insets(int top, int left, int bottom, int right)
095  {
096    this.top = top;
097    this.left = left;
098    this.bottom = bottom;
099    this.right = right;
100  }
101
102  /**
103   * Set the contents of this Insets object to the specified values.
104   *
105   * @param top the top inset
106   * @param left the left inset
107   * @param bottom the bottom inset
108   * @param right the right inset
109   *
110   * @since 1.5
111   */
112  public void set(int top, int left, int bottom, int right)
113  {
114    this.top = top;
115    this.left = left;
116    this.bottom = bottom;
117    this.right = right;
118  }
119
120  /**
121   * Tests whether this object is equal to the specified object. The other
122   * object must be an instance of Insets with identical field values.
123   *
124   * @param obj the object to test against
125   * @return true if the specified object is equal to this one
126   *
127   * @since 1.1
128   */
129  public boolean equals(Object obj)
130  {
131    if (! (obj instanceof Insets))
132      return false;
133    Insets i = (Insets) obj;
134    return top == i.top && bottom == i.bottom
135      && left == i.left && right == i.right;
136  }
137
138  /**
139   * Returns a hashcode for this instance. The formula is unspecified, but
140   * appears to be <code>XXX what is it? </code>.
141   *
142   * @return the hashcode
143   */
144  public int hashCode()
145  {
146    // This can't be right...
147    return top + bottom + left + right;
148  }
149
150  /**
151   * Returns a string representation of this object, which will be non-null.
152   *
153   * @return a string representation of this object
154   */
155  public String toString()
156  {
157    return getClass().getName() + "[top=" + top + ",left=" + left
158      + ",bottom=" + bottom + ",right=" + right + ']';
159  }
160
161  /**
162   * Returns a copy of this object.
163   *
164   * @return a copy of this object
165   */
166  public Object clone()
167  {
168    try
169      {
170        return super.clone();
171      }
172    catch (CloneNotSupportedException e)
173      {
174        throw (Error) new InternalError().initCause(e); // Impossible
175      }
176  }
177} // class Insets