1 /* Insets.java -- information about a container border 2 Copyright (C) 1999, 2000, 2002, 2005, 2006 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., 51 Franklin Street, Fifth Floor, Boston, MA 19 02110-1301 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 import java.io.Serializable; 42 43 /** 44 * This class represents the "margin" or space around a container. 45 * 46 * @author Aaron M. Renn (arenn@urbanophile.com) 47 * @author Eric Blake (ebb9@email.byu.edu) 48 * @status 49 */ 50 public class Insets implements Cloneable, Serializable 51 { 52 /** 53 * Compatible with JDK 1.0+. 54 */ 55 private static final long serialVersionUID = -2272572637695466749L; 56 57 /** 58 * The gap from the top. 59 * 60 * @serial the top inset 61 */ 62 public int top; 63 64 /** 65 * The gap from the left. 66 * 67 * @serial the left inset 68 */ 69 public int left; 70 71 /** 72 * The gap from the bottom. 73 * 74 * @serial the bottom inset 75 */ 76 public int bottom; 77 78 /** 79 * The gap from the right. 80 * 81 * @serial the right inset 82 */ 83 public int right; 84 85 /** 86 * Initializes a new instance of <code>Inset</code> with the specified 87 * inset values. 88 * 89 * @param top the top inset 90 * @param left the left inset 91 * @param bottom the bottom inset 92 * @param right the right inset 93 */ Insets(int top, int left, int bottom, int right)94 public Insets(int top, int left, int bottom, int right) 95 { 96 this.top = top; 97 this.left = left; 98 this.bottom = bottom; 99 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 */ set(int top, int left, int bottom, int right)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 */ equals(Object obj)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 */ hashCode()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 */ toString()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 */ clone()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 178