libjava/java/awt/Insets.java

   1 /* Insets.java -- Information about a container border.
   2    Copyright (C) 1999, 2000, 2002 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package java.awt;
  40
  41 /**
  42   * This class represents the "margin" or space around a container.
  43   *
  44   * @author Aaron M. Renn (arenn@urbanophile.com)
  45   */
  46 public class Insets implements Cloneable, java.io.Serializable
  47 {
  48
  49 /*
  50  * Instance Variable
  51  */
  52
  53 /**
  54   * @serial The top inset
  55   */
  56 public int top;
  57
  58 /**
  59   * @serial This bottom inset
  60   */
  61 public int bottom;
  62
  63 /**
  64   * @serial The left inset
  65   */
  66 public int left;
  67
  68 /**
  69   * @serial The right inset
  70   */
  71 public int right;
  72
  73 /*************************************************************************/
  74
  75 /**
  76   * Initializes a new instance of <code>Inset</code> with the specified
  77   * inset values.
  78   *
  79   * @param top The top inset
  80   * @param left The left inset
  81   * @param bottom The bottom inset
  82   * @param right The right inset
  83   */
  84 public
  85 Insets(int top, int left, int bottom, int right)
  86 {
  87   this.top = top;
  88   this.left = left;
  89   this.bottom = bottom;
  90   this.right = right;
  91 }
  92
  93 /*************************************************************************/
  94
  95 /*
  96  * Instance Methods
  97  */
  98
  99 /**
 100   * Tests whether this object is equal to the specified object.  This will
 101   * be true if and only if the specified object:
 102   * <p>
 103   * <ul>
 104   * <li>Is not <code>null</code>.
 105   * <li>Is an instance of <code>Insets</code>.
 106   * <li>Has the same top, bottom, left, and right inset values as this object.
 107   * </ul>
 108   *
 109   * @param obj The object to test against.
 110   *
 111   * @return <code>true</code> if the specified object is equal to this
 112   * one, <code>false</code> otherwise.
 113   */
 114 public boolean
 115 equals(Object obj)
 116 {
 117   if (!(obj instanceof Insets))
 118     return(false);
 119
 120   Insets i = (Insets)obj;
 121
 122   if (i.top != top)
 123     return(false);
 124   if (i.bottom != bottom)
 125     return(false);
 126   if (i.left != left)
 127     return(false);
 128   if (i.right != right)
 129     return(false);
 130
 131   return(true);
 132 }
 133
 134 public int
 135 hashCode()
 136 {
 137   return top + bottom + left + right;
 138 }
 139
 140 /*************************************************************************/
 141
 142 /**
 143   * Returns a string representation of this object.
 144   *
 145   * @return A string representation of this object.
 146   */
 147 public String
 148 toString()
 149 {
 150   return(getClass().getName() + "(top=" + top + ",bottom=" + bottom +
 151          ",left=" + left + ",right=" + right + ")");
 152 }
 153
 154 /*************************************************************************/
 155
 156 /**
 157   * Returns a copy of this object.
 158   *
 159   * @return A copy of this object.
 160   */
 161 public Object
 162 clone()
 163 {
 164   try
 165     {
 166       return(super.clone());
 167     }
 168   catch(Exception e)
 169     {
 170       return(null);
 171     }
 172 }
 173
 174 } // class Insets