| java.lang.Object | ||
| ↳ | java.util.EventObject | |
| ↳ | java.beans.PropertyChangeEvent | |
 Known Direct Subclasses
|
Class Overview
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.
Summary
|
[Expand]
Inherited Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
java.util.EventObject
| |||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Constructs a new
PropertyChangeEvent. | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Gets the new value for the property, expressed as an Object.
| |||||||||||
Gets the old value for the property, expressed as an Object.
| |||||||||||
The "propagationId" field is reserved for future use.
| |||||||||||
Gets the programmatic name of the property that was changed.
| |||||||||||
Sets the propagationId object for the event.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
java.util.EventObject
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
Public Constructors
public PropertyChangeEvent (Object source, String propertyName, Object oldValue, Object newValue)
Constructs a new PropertyChangeEvent.
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. |
Public Methods
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.
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.
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.
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.
public void setPropagationId (Object propagationId)
Sets the propagationId object for the event.
Parameters
| propagationId | The propagationId object for the event. |
|---|