java::util::PropertyChangeEvent Class Reference

Inheritance diagram for java::util::PropertyChangeEvent:

Inheritance graph
java::util::EventObjectjava::lang::Object
[legend]
Collaboration diagram for java::util::PropertyChangeEvent:

Collaboration graph
java::util::EventObjectjava::lang::Objectjava::lang::ObjectRefjava::lang::Interfacejava::lang::Comparable
[legend]

List of all members.


Detailed Description

A "PropertyChange" event gets delivered whenever an object 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.

Public Member Functions

 PropertyChangeEvent (const ObjectRef &source=0, const String &propertyName=nilString, const ObjectRef &oldValue=0, const ObjectRef &newValue=0)
 Constructs a new PropertyChangeEvent.
virtual String getPropertyName () const
 Gets the programmatic name of the property that was changed.
virtual ObjectRef getNewValue () const
 Sets the new value for the property, expressed as an Object.
virtual ObjectRef getOldValue () const
 Gets the old value for the property, expressed as an Object.
virtual void setPropagationId (const ObjectRef &propagationId)
 Sets the propagationId object for the event.
virtual ObjectRef getPropagationId () const
 The "propagationId" field is reserved for future use.


Constructor & Destructor Documentation

java::util::PropertyChangeEvent::PropertyChangeEvent ( const ObjectRef source = 0,
const String propertyName = nilString,
const ObjectRef oldValue = 0,
const ObjectRef newValue = 0 
)

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.


Member Function Documentation

virtual String java::util::PropertyChangeEvent::getPropertyName (  )  const [virtual]

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.

virtual ObjectRef java::util::PropertyChangeEvent::getNewValue (  )  const [virtual]

Sets 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.

virtual ObjectRef java::util::PropertyChangeEvent::getOldValue (  )  const [virtual]

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.

virtual void java::util::PropertyChangeEvent::setPropagationId ( const ObjectRef propagationId  )  [virtual]

Sets the propagationId object for the event.

Parameters:
propagationId The propagationId object for the event.

virtual ObjectRef java::util::PropertyChangeEvent::getPropagationId (  )  const [virtual]

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.


The documentation for this class was generated from the following file:
Generated on Fri May 16 11:56:50 2008 for CrossPlatformJavaLikeC++API by  doxygen 1.5.3