java.lang.Object | |
↳ | java.beans.PropertyChangeSupport |
Known Direct Subclasses |
This is a utility class that can be used by beans that support bound properties. You can use an instance of this class as a member field of your bean and delegate various work to it. This class is serializable. When it is serialized it will save (and restore) any listeners that are themselves serializable. Any non-serializable listeners will be skipped during serialization.
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Constructs a
PropertyChangeSupport object. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Add a PropertyChangeListener for a specific property.
| |||||||||||
Add a PropertyChangeListener to the listener list.
| |||||||||||
Report an
int bound indexed property update to any registered
listeners. | |||||||||||
Report a
boolean bound indexed property update to any
registered listeners. | |||||||||||
Report a bound indexed property update to any registered
listeners.
| |||||||||||
Report an int bound property update to any registered listeners.
| |||||||||||
Report a boolean bound property update to any registered listeners.
| |||||||||||
Fire an existing PropertyChangeEvent to any registered listeners.
| |||||||||||
Report a bound property update to any registered listeners.
| |||||||||||
Returns an array of all the listeners that were added to the
PropertyChangeSupport object with addPropertyChangeListener().
| |||||||||||
Returns an array of all the listeners which have been associated
with the named property.
| |||||||||||
Check if there are any listeners for a specific property, including
those registered on all properties.
| |||||||||||
Remove a PropertyChangeListener from the listener list.
| |||||||||||
Remove a PropertyChangeListener for a specific property.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
Constructs a PropertyChangeSupport
object.
sourceBean | The bean to be given as the source for any events. |
---|
Add a PropertyChangeListener for a specific property. The listener
will be invoked only when a call on firePropertyChange names that
specific property.
The same listener object may be added more than once. For each
property, the listener will be invoked the number of times it was added
for that property.
If propertyName
or listener
is null, no
exception is thrown and no action is taken.
propertyName | The name of the property to listen on. |
---|---|
listener | The PropertyChangeListener to be added |
Add a PropertyChangeListener to the listener list.
The listener is registered for all properties.
The same listener object may be added more than once, and will be called
as many times as it is added.
If listener
is null, no exception is thrown and no action
is taken.
listener | The PropertyChangeListener to be added |
---|
Report an int
bound indexed property update to any registered
listeners.
No event is fired if old and new values are equal.
This is merely a convenience wrapper around the more general fireIndexedPropertyChange method which takes Object values.
propertyName | The programmatic name of the property that was changed. |
---|---|
index | index of the property element that was changed. |
oldValue | The old value of the property. |
newValue | The new value of the property. |
Report a boolean
bound indexed property update to any
registered listeners.
No event is fired if old and new values are equal.
This is merely a convenience wrapper around the more general fireIndexedPropertyChange method which takes Object values.
propertyName | The programmatic name of the property that was changed. |
---|---|
index | index of the property element that was changed. |
oldValue | The old value of the property. |
newValue | The new value of the property. |
Report a bound indexed property update to any registered listeners.
No event is fired if old and new values are equal and non-null.
This is merely a convenience wrapper around the more general
firePropertyChange method that takes PropertyChangeEvent
value.
propertyName | The programmatic name of the property that was changed. |
---|---|
index | index of the property element that was changed. |
oldValue | The old value of the property. |
newValue | The new value of the property. |
Report an int bound property update to any registered listeners. No event is fired if old and new are equal.
This is merely a convenience wrapper around the more general firePropertyChange method that takes Object values.
propertyName | The programmatic name of the property that was changed. |
---|---|
oldValue | The old value of the property. |
newValue | The new value of the property. |
Report a boolean bound property update to any registered listeners. No event is fired if old and new are equal.
This is merely a convenience wrapper around the more general firePropertyChange method that takes Object values.
propertyName | The programmatic name of the property that was changed. |
---|---|
oldValue | The old value of the property. |
newValue | The new value of the property. |
Fire an existing PropertyChangeEvent to any registered listeners. No event is fired if the given event's old and new values are equal and non-null.
evt | The PropertyChangeEvent object. |
---|
Report a bound property update to any registered listeners. No event is fired if old and new are equal and non-null.
This is merely a convenience wrapper around the more general
firePropertyChange method that takes PropertyChangeEvent
value.
propertyName | The programmatic name of the property that was changed. |
---|---|
oldValue | The old value of the property. |
newValue | The new value of the property. |
Returns an array of all the listeners that were added to the PropertyChangeSupport object with addPropertyChangeListener().
If some listeners have been added with a named property, then
the returned array will be a mixture of PropertyChangeListeners
and PropertyChangeListenerProxy
s. If the calling
method is interested in distinguishing the listeners then it must
test each element to see if it's a
PropertyChangeListenerProxy
, perform the cast, and examine
the parameter.
PropertyChangeListener[] listeners = bean.getPropertyChangeListeners(); for (int i = 0; i < listeners.length; i++) { if (listeners[i] instanceof PropertyChangeListenerProxy) { PropertyChangeListenerProxy proxy = (PropertyChangeListenerProxy)listeners[i]; if (proxy.getPropertyName().equals("foo")) { // proxy is a PropertyChangeListener which was associated // with the property named "foo" } } }
PropertyChangeListeners
added or an
empty array if no listeners have been addedReturns an array of all the listeners which have been associated with the named property.
propertyName | The name of the property being listened to |
---|
PropertyChangeListeners
associated with
the named property. If no such listeners have been added,
or if propertyName
is null, an empty array is
returned.Check if there are any listeners for a specific property, including
those registered on all properties. If propertyName
is null, only check for listeners registered on all properties.
propertyName | the property name. |
---|
Remove a PropertyChangeListener from the listener list.
This removes a PropertyChangeListener that was registered
for all properties.
If listener
was added more than once to the same event
source, it will be notified one less time after being removed.
If listener
is null, or was never added, no exception is
thrown and no action is taken.
listener | The PropertyChangeListener to be removed |
---|
Remove a PropertyChangeListener for a specific property.
If listener
was added more than once to the same event
source for the specified property, it will be notified one less time
after being removed.
If propertyName
is null, no exception is thrown and no
action is taken.
If listener
is null, or was never added for the specified
property, no exception is thrown and no action is taken.
propertyName | The name of the property that was listened on. |
---|---|
listener | The PropertyChangeListener to be removed |