PropertyChangeEvent
open class PropertyChangeEvent : EventObject
| kotlin.Any | ||
| ↳ | java.util.EventObject | |
| ↳ | java.beans.PropertyChangeEvent | |
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
| Public constructors | |
|---|---|
PropertyChangeEvent(source: Any!, propertyName: String!, oldValue: Any!, newValue: Any!)Constructs a new |
|
| Public methods | |
|---|---|
| open Any! |
Gets the new value for the property, expressed as an Object. |
| open Any! |
Gets the old value for the property, expressed as an Object. |
| open Any! |
The "propagationId" field is reserved for future use. |
| open String! |
Gets the programmatic name of the property that was changed. |
| open Unit |
setPropagationId(propagationId: Any!)Sets the propagationId object for the event. |
| open String |
toString()Returns a string representation of the object. |
| Inherited functions | |
|---|---|
| Inherited properties | |
|---|---|
Public constructors
PropertyChangeEvent
PropertyChangeEvent(
source: Any!,
propertyName: String!,
oldValue: Any!,
newValue: Any!)
Constructs a new PropertyChangeEvent.
| Parameters | |
|---|---|
source |
Any!: the bean that fired the event |
propertyName |
String!: the programmatic name of the property that was changed |
oldValue |
Any!: the old value of the property |
newValue |
Any!: the new value of the property |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
if source is null |
Public methods
getNewValue
open fun getNewValue(): Any!
Gets the new value for the property, expressed as an Object.
| Return | |
|---|---|
Any! |
The new value for the property, expressed as an Object. May be null if multiple properties have changed. |
getOldValue
open fun getOldValue(): Any!
Gets the old value for the property, expressed as an Object.
| Return | |
|---|---|
Any! |
The old value for the property, expressed as an Object. May be null if multiple properties have changed. |
getPropagationId
open fun getPropagationId(): Any!
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.
| Return | |
|---|---|
Any! |
the propagationId object associated with a bound/constrained property update. |
getPropertyName
open fun getPropertyName(): String!
Gets the programmatic name of the property that was changed.
| Return | |
|---|---|
String! |
The programmatic name of the property that was changed. May be null if multiple properties have changed. |
setPropagationId
open fun setPropagationId(propagationId: Any!): Unit
Sets the propagationId object for the event.
| Parameters | |
|---|---|
propagationId |
Any!: The propagationId object for the event. |
toString
open fun toString(): String
Returns a string representation of the object.
| Return | |
|---|---|
String |
a string representation of the object |