J. Duke | 319a3b9 | 2007-12-01 00:00:00 +0000 | [diff] [blame^] | 1 | /* |
| 2 | * Copyright 2003 Sun Microsystems, Inc. All Rights Reserved. |
| 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| 4 | * |
| 5 | * This code is free software; you can redistribute it and/or modify it |
| 6 | * under the terms of the GNU General Public License version 2 only, as |
| 7 | * published by the Free Software Foundation. Sun designates this |
| 8 | * particular file as subject to the "Classpath" exception as provided |
| 9 | * by Sun in the LICENSE file that accompanied this code. |
| 10 | * |
| 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| 15 | * accompanied this code). |
| 16 | * |
| 17 | * You should have received a copy of the GNU General Public License version |
| 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| 20 | * |
| 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
| 23 | * have any questions. |
| 24 | */ |
| 25 | package java.beans; |
| 26 | |
| 27 | /** |
| 28 | * An "IndexedPropertyChange" event gets delivered whenever a component that |
| 29 | * conforms to the JavaBeans<TM> specification (a "bean") changes a bound |
| 30 | * indexed property. This class is an extension of <code>PropertyChangeEvent</code> |
| 31 | * but contains the index of the property that has changed. |
| 32 | * <P> |
| 33 | * Null values may be provided for the old and the new values if their |
| 34 | * true values are not known. |
| 35 | * <P> |
| 36 | * An event source may send a null object as the name to indicate that an |
| 37 | * arbitrary set of if its properties have changed. In this case the |
| 38 | * old and new values should also be null. |
| 39 | * |
| 40 | * @since 1.5 |
| 41 | * @author Mark Davidson |
| 42 | */ |
| 43 | public class IndexedPropertyChangeEvent extends PropertyChangeEvent { |
| 44 | |
| 45 | private int index; |
| 46 | |
| 47 | /** |
| 48 | * Constructs a new <code>IndexedPropertyChangeEvent</code> object. |
| 49 | * |
| 50 | * @param source The bean that fired the event. |
| 51 | * @param propertyName The programmatic name of the property that |
| 52 | * was changed. |
| 53 | * @param oldValue The old value of the property. |
| 54 | * @param newValue The new value of the property. |
| 55 | * @param index index of the property element that was changed. |
| 56 | */ |
| 57 | public IndexedPropertyChangeEvent(Object source, String propertyName, |
| 58 | Object oldValue, Object newValue, |
| 59 | int index) { |
| 60 | super (source, propertyName, oldValue, newValue); |
| 61 | this.index = index; |
| 62 | } |
| 63 | |
| 64 | |
| 65 | /** |
| 66 | * Gets the index of the property that was changed. |
| 67 | * |
| 68 | * @return The index specifying the property element that was |
| 69 | * changed. |
| 70 | */ |
| 71 | public int getIndex() { |
| 72 | return index; |
| 73 | } |
| 74 | } |