PropertyChangeEvent

PropertyChangeEvent | API reference | Android Developers

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.

Summary

Inherited fields

From class java.util.EventObject


    protected
    
    
    Object

source

The object on which the Event initially occurred.

Public constructors
`PropertyChangeEvent(Object source, String propertyName, Object oldValue, Object newValue)` Constructs a new `PropertyChangeEvent`.

Public methods
`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.

Inherited methods

From class java.util.EventObject

`Object`	`getSource()` The object on which the Event initially occurred.
`String`	`toString()` Returns a String representation of this EventObject.

From class java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

public PropertyChangeEvent (Object source, 
                String propertyName, 
                Object oldValue, 
                Object newValue)

Constructs a new PropertyChangeEvent.

Parameters
`source`	`Object`: the bean that fired the event
`propertyName`	`String`: the programmatic name of the property that was changed
`oldValue`	`Object`: the old value of the property
`newValue`	`Object`: the new value of the property

Throws
`IllegalArgumentException`	if `source` is `null`

Public methods

getNewValue

public Object getNewValue ()

Gets the new value for the property, expressed as an Object.

Returns
`Object`	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
`Object`	The old value for the property, expressed as an Object. May be null if multiple properties have changed.

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
`Object`	the propagationId object associated with a bound/constrained property update.

getPropertyName

public String getPropertyName ()

Gets the programmatic name of the property that was changed.

Returns
`String`	The programmatic name of the property that was changed. May be null if multiple properties have changed.

setPropagationId

public void setPropagationId (Object propagationId)

Sets the propagationId object for the event.

Parameters
`propagationId`	`Object`: The propagationId object for the event.

toString

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object