Класс PropertyChangeSupport

Этот утилитарный класс может использоваться компонентами, поддерживающими привязанные свойства. Он управляет списком слушателей и рассылает события PropertyChangeEvent этим слушателям. Вы можете использовать экземпляр этого класса в качестве поля-члена своего компонента и делегировать ему такие задачи. PropertyChangeListener можно зарегистрировать для всех свойств или для конкретного свойства, указанного по имени.

Вот пример PropertyChangeSupport использования, который соответствует правилам и рекомендациям, изложенным в спецификации JavaBeans™:

public class MyBean {
     private final PropertyChangeSupport pcs = new PropertyChangeSupport(this);

     public void addPropertyChangeListener(PropertyChangeListener listener) {
         this.pcs.addPropertyChangeListener(listener);
     }

     public void removePropertyChangeListener(PropertyChangeListener listener) {
         this.pcs.removePropertyChangeListener(listener);
     }

     private String value;

     public String getValue() {
         return this.value;
     }

     public void setValue(String newValue) {
         String oldValue = this.value;
         this.value = newValue;
         this.pcs.firePropertyChange("value", oldValue, newValue);
     }

     [...]
 }

Экземпляр PropertyChangeSupport потокобезопасен.

Этот класс сериализуем. При сериализации он сохранит (и восстановит) всех слушателей, которые сами являются сериализуемыми. Любые несериализуемые слушатели будут пропущены во время сериализации.

Конструкторы

PropertyChangeSupport

public PropertyChangeSupport(Object sourceBean)

Создаёт объект PropertyChangeSupport.

Параметры:

sourceBean - Компонент, который будет источником событий.

Методы

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Добавляет обработчик PropertyChangeListener в список слушателей. Обработчик регистрируется для всех свойств. Один и тот же объект слушателя можно добавить несколько раз, и он будет вызываться столько раз, сколько раз он был добавлен. Если listener равно null, исключение не генерируется и никаких действий не выполняется.

Параметры:

listener - Добавляемый обработчик PropertyChangeListener

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Удаляет обработчик PropertyChangeListener из списка слушателей. Удаляется обработчик PropertyChangeListener, зарегистрированный для всех свойств. Если listener был добавлен более одного раза к тому же источнику событий, он будет оповещён на один вызов меньше после удаления. Если listener равно null или никогда не добавлялся, исключение не генерируется и никаких действий не выполняется.

Параметры:

listener - Удаляемый обработчик PropertyChangeListener

getPropertyChangeListeners

public PropertyChangeListener[] getPropertyChangeListeners()

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 или пустой массив, если слушатели не были добавлены

С:

1.4

См. также:

PropertyChangeListenerProxy

addPropertyChangeListener

public void addPropertyChangeListener(String propertyName,
                                      PropertyChangeListener listener)

Добавляет обработчик PropertyChangeListener для конкретного свойства. Обработчик будет вызываться только при вызове firePropertyChange, где указано это конкретное свойство. Один и тот же объект слушателя можно добавить более одного раза. Для каждого свойства слушатель будет вызываться количество раз, равное количеству его добавлений для этого свойства. Если propertyName или listener равны null, исключение не генерируется и никаких действий не выполняется.

Параметры:

propertyName - Имя свойства, за которым нужно наблюдать.

listener - Добавляемый обработчик PropertyChangeListener

removePropertyChangeListener

public void removePropertyChangeListener(String propertyName,
                                         PropertyChangeListener listener)

Удаляет обработчик PropertyChangeListener для конкретного свойства. Если listener был добавлен более одного раза к тому же источнику событий для указанного свойства, он будет оповещён на один вызов меньше после удаления. Если propertyName равно null, исключение не генерируется и никаких действий не выполняется. Если listener равно null или никогда не был добавлен для указанного свойства, исключение не генерируется и никаких действий не выполняется.

Параметры:

propertyName - Имя свойства, за которым наблюдали.

listener - Удаляемый обработчик PropertyChangeListener

getPropertyChangeListeners

public PropertyChangeListener[] getPropertyChangeListeners(String propertyName)

Возвращает массив всех слушателей, связанных с указанным свойством.

Параметры:

propertyName - Имя свойства, за которым наблюдают

Возвращает:

все PropertyChangeListeners , связанные с указанным свойством. Если такие слушатели не были добавлены, или если propertyName равно null, возвращается пустой массив.

С:

1.4

firePropertyChange

public void firePropertyChange(String propertyName,
                               Object oldValue,
                               Object newValue)

Параметры:

propertyName - Программное имя изменённого свойства

oldValue - Старое значение свойства

newValue - Новое значение свойства

firePropertyChange

public void firePropertyChange(String propertyName,
                               int oldValue,
                               int newValue)

Параметры:

propertyName - Программное имя изменённого свойства

oldValue - Старое значение свойства

newValue - Новое значение свойства

firePropertyChange

public void firePropertyChange(String propertyName,
                               boolean oldValue,
                               boolean newValue)

Параметры:

propertyName - Программное имя изменённого свойства

oldValue - Старое значение свойства

newValue - Новое значение свойства

firePropertyChange

public void firePropertyChange(PropertyChangeEvent event)

Параметры:

event - Событие PropertyChangeEvent, которое нужно отправить

fireIndexedPropertyChange

public void fireIndexedPropertyChange(String propertyName,
                                      int index,
                                      Object oldValue,
                                      Object newValue)

Параметры:

propertyName - Программное имя изменённого свойства

index - Индекс элемента свойства, который был изменён

oldValue - Старое значение свойства

newValue - Новое значение свойства

С:

1.5

fireIndexedPropertyChange

public void fireIndexedPropertyChange(String propertyName,
                                      int index,
                                      int oldValue,
                                      int newValue)

Параметры:

propertyName - Программное имя изменённого свойства

index - Индекс элемента свойства, который был изменён

oldValue - Старое значение свойства

newValue - Новое значение свойства

С:

1.5

fireIndexedPropertyChange

public void fireIndexedPropertyChange(String propertyName,
                                      int index,
                                      boolean oldValue,
                                      boolean newValue)

Параметры:

propertyName - Программное имя изменённого свойства

index - Индекс элемента свойства, который был изменён

oldValue - Старое значение свойства

newValue - Новое значение свойства

С:

1.5

hasListeners

public boolean hasListeners(String propertyName)

Проверяет наличие слушателей для конкретного свойства, включая тех, которые зарегистрированы для всех свойств. Если propertyName равно null, проверяются только слушатели, зарегистрированные для всех свойств.

Параметры:

propertyName - Имя свойства.

Возвращает:

true, если есть один или более слушателей для данного свойства