- java.lang.Object
-
- java.util.EventObject
-
- java.beans.PropertyChangeEvent
-
- All Implemented Interfaces:
- Serializable
- Direct Known Subclasses:
- IndexedPropertyChangeEvent
public class PropertyChangeEvent extends EventObject
A "PropertyChange" event gets delivered whenever a bean changes a "bound" or "constrained" property. A PropertyChangeEvent object is sent as an argument to the PropertyChangeListener and VetoableChangeListener methods.Normally PropertyChangeEvents are accompanied by the name and the old and new value of the changed property. If the new value is a primitive type (such as int or boolean) it must be wrapped as the corresponding java.lang.* Object type (such as Integer or Boolean).
Null values may be provided for the old and the new values if their true values are not known.
An event source may send a null object as the name to indicate that an arbitrary set of if its properties have changed. In this case the old and new values should also be null.
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class java.util.EventObject
source
-
-
Constructor Summary
Constructors Constructor and Description PropertyChangeEvent(Object source, String propertyName, Object oldValue, Object newValue)
Constructs a newPropertyChangeEvent
.
-
Method Summary
Methods Modifier and Type Method and Description Object
getNewValue()
Gets the new value for the property, expressed as an Object.Object
getOldValue()
Gets the old value for the property, expressed as an Object.Object
getPropagationId()
The "propagationId" field is reserved for future use.String
getPropertyName()
Gets the programmatic name of the property that was changed.void
setPropagationId(Object propagationId)
Sets the propagationId object for the event.String
toString()
Returns a string representation of the object.-
Methods inherited from class java.util.EventObject
getSource
-
-
-
-
Constructor Detail
-
PropertyChangeEvent
public PropertyChangeEvent(Object source, String propertyName, Object oldValue, Object newValue)
Constructs a newPropertyChangeEvent
.- Parameters:
source
- The bean that fired the event.propertyName
- The programmatic name of the property that was changed.oldValue
- The old value of the property.newValue
- The new value of the property.
-
-
Method Detail
-
getPropertyName
public String getPropertyName()
Gets the programmatic name of the property that was changed.- Returns:
- The programmatic name of the property that was changed. May be null if multiple properties have changed.
-
getNewValue
public Object getNewValue()
Gets the new value for the property, expressed as an Object.- Returns:
- The new value for the property, expressed as an Object. May be null if multiple properties have changed.
-
getOldValue
public Object getOldValue()
Gets the old value for the property, expressed as an Object.- Returns:
- The old value for the property, expressed as an Object. May be null if multiple properties have changed.
-
setPropagationId
public void setPropagationId(Object propagationId)
Sets the propagationId object for the event.- Parameters:
propagationId
- The propagationId object for the event.
-
getPropagationId
public Object getPropagationId()
The "propagationId" field is reserved for future use. In Beans 1.0 the sole requirement is that if a listener catches a PropertyChangeEvent and then fires a PropertyChangeEvent of its own, then it should make sure that it propagates the propagationId field from its incoming event to its outgoing event.- Returns:
- the propagationId object associated with a bound/constrained property update.
-
toString
public String toString()
Returns a string representation of the object.- Overrides:
toString
in classEventObject
- Returns:
- a string representation of the object
- Since:
- 1.7
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/beans/propertychangeevent.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.