Java Platform 1.2
Beta 4

Class java.beans.VetoableChangeSupport

java.lang.Object
  |
  +--java.beans.VetoableChangeSupport

public class VetoableChangeSupport
extends Object
implements Serializable
This is a utility class that can be used by beans that support constrained properties. You can use an instance of this class as a member field of your bean and delegate various work to it.

See Also:
Serialized Form

Constructor Summary
VetoableChangeSupport(Object sourceBean)
           
 
Method Summary
 void addVetoableChangeListener(String propertyName, VetoableChangeListener listener)
          Add a VetoableChangeListener for a specific property.
 void addVetoableChangeListener(VetoableChangeListener listener)
          Add a VetoableListener to the listener list.
 void fireVetoableChange(PropertyChangeEvent evt)
          Fire a vetoable property update to any registered listeners.
 void fireVetoableChange(String propertyName, boolean oldValue, boolean newValue)
          Report a boolean vetoable property update to any registered listeners.
 void fireVetoableChange(String propertyName, int oldValue, int newValue)
          Report a int vetoable property update to any registered listeners.
 void fireVetoableChange(String propertyName, Object oldValue, Object newValue)
          Report a vetoable property update to any registered listeners.
 boolean hasListeners(String propertyName)
          Check if there are any listeners for a specific property.
 void removeVetoableChangeListener(String propertyName, VetoableChangeListener listener)
          Remove a VetoableChangeListener for a specific property.
 void removeVetoableChangeListener(VetoableChangeListener listener)
          Remove a VetoableChangeListener from the listener list.
 
Methods inherited from class java.lang.Object
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
 

Constructor Detail

VetoableChangeSupport

public VetoableChangeSupport(Object sourceBean)
Parameters:
sourceBean - The bean to be given as the source for any events.
Method Detail

addVetoableChangeListener

public void addVetoableChangeListener(VetoableChangeListener listener)
Add a VetoableListener to the listener list. The listener is registered for all properties.
Parameters:
listener - The VetoableChangeListener to be added

removeVetoableChangeListener

public void removeVetoableChangeListener(VetoableChangeListener listener)
Remove a VetoableChangeListener from the listener list. This removes a PropertyChangeListener that was registered for all properties.
Parameters:
listener - The VetoableChangeListener to be removed

addVetoableChangeListener

public void addVetoableChangeListener(String propertyName,
                                      VetoableChangeListener listener)
Add a VetoableChangeListener for a specific property. The listener will be invoked only when a call on fireVetoableChange names that specific property.
Parameters:
propertyName - The name of the property to listen on.
listener - The VetoableChangeListener to be added

removeVetoableChangeListener

public void removeVetoableChangeListener(String propertyName,
                                         VetoableChangeListener listener)
Remove a VetoableChangeListener for a specific property.
Parameters:
propertyName - The name of the property that was listened on.
listener - The VetoableChangeListener to be removed

fireVetoableChange

public void fireVetoableChange(String propertyName,
                               Object oldValue,
                               Object newValue)
                        throws PropertyVetoException
Report a vetoable property update to any registered listeners. If anyone vetos the change, then fire a new event reverting everyone to the old value and then rethrow the PropertyVetoException.

No event is fired if old and new are equal and non-null.

Parameters:
propertyName - The programmatic name of the property that is about to change..
oldValue - The old value of the property.
newValue - The new value of the property.
Throws:
PropertyVetoException - if the recipient wishes the property change to be rolled back.

fireVetoableChange

public void fireVetoableChange(String propertyName,
                               int oldValue,
                               int newValue)
                        throws PropertyVetoException
Report a int vetoable 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 fireVetoableChange method that takes Object values.

Parameters:
propertyName - The programmatic name of the property that is about to change.
oldValue - The old value of the property.
newValue - The new value of the property.

fireVetoableChange

public void fireVetoableChange(String propertyName,
                               boolean oldValue,
                               boolean newValue)
                        throws PropertyVetoException
Report a boolean vetoable 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 fireVetoableChange method that takes Object values.

Parameters:
propertyName - The programmatic name of the property that is about to change.
oldValue - The old value of the property.
newValue - The new value of the property.

fireVetoableChange

public void fireVetoableChange(PropertyChangeEvent evt)
                        throws PropertyVetoException
Fire a vetoable property update to any registered listeners. If anyone vetos the change, then fire a new event reverting everyone to the old value and then rethrow the PropertyVetoException.

No event is fired if old and new are equal and non-null.

Parameters:
evt - The PropertyChangeEvent to be fired.
Throws:
PropertyVetoException - if the recipient wishes the property change to be rolled back.

hasListeners

public boolean hasListeners(String propertyName)
Check if there are any listeners for a specific property.
Parameters:
propertyName - the property name.
Returns:
true if there are one or more listeners for the given property

Java Platform 1.2
Beta 4

Submit a bug or feature
Submit comments/suggestions about new javadoc look
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.
This documentation was generated with a post-Beta4 version of Javadoc.