org.vizzini.util.event
Interface IPropertyChangeSupport

All Known Implementing Classes:
PropertyChangeManager

public interface IPropertyChangeSupport

Defines methods needed by classes which use a PropertyChangeSupport instance.

Since:
v0.1
Version:
v0.1
Author:
Jeffrey M. Thompson

Method Summary
 void addPropertyChangeListener(PropertyChangeListener listener)
          Add a PropertyChangeListener to the listener list.
 void addPropertyChangeListener(String propertyName, PropertyChangeListener listener)
          Add a PropertyChangeListener for a specific property.
 void firePropertyChange(PropertyChangeEvent event)
          Fire an existing PropertyChangeEvent to any registered listeners.
 void firePropertyChange(String propertyName, boolean oldValue, boolean newValue)
          Report a boolean bound property update to any registered listeners.
 void firePropertyChange(String propertyName, int oldValue, int newValue)
          Report an int bound property update to any registered listeners.
 void firePropertyChange(String propertyName, Object oldValue, Object newValue)
          Report a bound property update to any registered listeners.
 PropertyChangeListener[] getPropertyChangeListeners()
          Returns an array of all the listeners that were added to the PropertyChangeSupport object with addPropertyChangeListener().
 boolean hasListeners(String propertyName)
          Check if there are any listeners for a specific property.
 void removePropertyChangeListener(PropertyChangeListener listener)
          Remove a PropertyChangeListener from the listener list.
 void removePropertyChangeListener(String propertyName, PropertyChangeListener listener)
          Remove a PropertyChangeListener for a specific property.
 

Method Detail

getPropertyChangeListeners

PropertyChangeListener[] getPropertyChangeListeners()
Returns an array of all the listeners that were added to the PropertyChangeSupport object with addPropertyChangeListener().

Since:
v0.1

addPropertyChangeListener

void addPropertyChangeListener(PropertyChangeListener listener)
Add a PropertyChangeListener to the listener list. The listener is registered for all properties.

Parameters:
listener - The PropertyChangeListener to be added.
Since:
v0.1

addPropertyChangeListener

void addPropertyChangeListener(String propertyName,
                               PropertyChangeListener listener)
Add a PropertyChangeListener for a specific property. The listener will be invoked only when a call on firePropertyChange names that specific property.

Parameters:
propertyName - The name of the property to listen on.
listener - The PropertyChangeListener to be added.
Since:
v0.1

firePropertyChange

void firePropertyChange(PropertyChangeEvent event)
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.

Parameters:
event - The PropertyChangeEvent object.
Since:
v0.1

firePropertyChange

void firePropertyChange(String propertyName,
                        boolean oldValue,
                        boolean newValue)
Report a boolean 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 Object values.

Parameters:
propertyName - The programmatic name of the property that was changed.
oldValue - The old value of the property.
newValue - The new value of the property.
Since:
v0.1

firePropertyChange

void firePropertyChange(String propertyName,
                        int oldValue,
                        int newValue)
Report an int 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 Object values.

Parameters:
propertyName - The programmatic name of the property that was changed.
oldValue - The old value of the property.
newValue - The new value of the property.
Since:
v0.1

firePropertyChange

void firePropertyChange(String propertyName,
                        Object oldValue,
                        Object newValue)
Report a bound property update to any registered listeners. No event is fired if old and new are equal and non-null.

Parameters:
propertyName - The programmatic name of the property that was changed.
oldValue - The old value of the property.
newValue - The new value of the property.
Since:
v0.1

hasListeners

boolean hasListeners(String propertyName)
Check if there are any listeners for a specific property.

Parameters:
propertyName - The property name.
Returns:
true if there are ore or more listeners for the given property.
Since:
v0.1

removePropertyChangeListener

void removePropertyChangeListener(PropertyChangeListener listener)
Remove a PropertyChangeListener from the listener list. This removes a PropertyChangeListener that was registered for all properties.

Parameters:
listener - The PropertyChangeListener to be removed.
Since:
v0.1

removePropertyChangeListener

void removePropertyChangeListener(String propertyName,
                                  PropertyChangeListener listener)
Remove a PropertyChangeListener for a specific property.

Parameters:
propertyName - The name of the property that was listened on.
listener - The PropertyChangeListener to be removed.
Since:
v0.1


Copyright 2007 Vizzini.org. All Rights Reserved. 2007.12.25.03.00.02