Класс EventHandler

public class EventHandler
extends Object
implements InvocationHandler

Класс EventHandler предоставляет поддержку для динамического создания обработчиков событий, методы которых выполняют простое операторное выражение, вовлекая в него объект события и целевой объект.

Класс EventHandler предназначен для использования интерактивными инструментами, такими как конструкторы приложений, которые позволяют разработчикам создавать связи между компонентами. Как правило, связи устанавливаются от компонента пользовательского интерфейса (источника события) к компоненту логики приложения (цели). Наиболее эффективные связи такого рода изолируют логику приложения от пользовательского интерфейса. Например, обработчик для связи из JCheckBox с методом, принимающим булево значение, может извлекать состояние флажка и передавать его непосредственно методу, тем самым изолируя метод от слоя пользовательского интерфейса.

Вложенные классы — это другой, более общий способ обработки событий из пользовательских интерфейсов. Класс EventHandler обрабатывает только подмножество того, что возможно с помощью вложенных классов. Однако EventHandler работает лучше с долгосрочной схемой хранения, чем вложенные классы. Кроме того, использование EventHandler в больших приложениях, в которых один и тот же интерфейс реализуется многократно, может уменьшить размер файлов и объем памяти приложения.

Причина, по которой обработчики, созданные с помощью EventHandler, имеют такой небольшой размер, заключается в том, что класс Proxy, на котором полагается класс EventHandler, разделяет реализации идентичных интерфейсов. Например, если вы используете методы EventHandler create для создания всех ActionListener в приложении, все обработчики событий будут экземплярами одного класса (одного созданного классом Proxy). В общем случае, обработчики, основанные на классе Proxy, требуют создания одного класса обработчика на каждый тип обработчика (интерфейс), в то время как подход с вложенными классами требует создания одного класса на каждый обработчик (объект, реализующий интерфейс).

Обычно вы не работаете напрямую с экземплярами EventHandler. Вместо этого вы используете один из методов EventHandler create для создания объекта, реализующего заданный интерфейс обработчика. Этот объект обработчика использует объект EventHandler за кулисами для инкапсуляции информации о событии, объекте, которому будет отправлено сообщение при возникновении события, сообщении (методе), которое должно быть отправлено, и любом аргументе метода. В следующем разделе приведены примеры создания объектов обработчиков с помощью методов create.

Примеры использования EventHandler

Самое простое использование EventHandler — установка обработчика, который вызывает метод целевого объекта без аргументов. В следующем примере мы создаем обработчик ActionListener, который вызывает метод toFront у экземпляра javax.swing.JFrame.

myButton.addActionListener(
    (ActionListener)EventHandler.create(ActionListener.class, frame, "toFront"));

При нажатии на myButton будет выполнено операторное выражение frame.toFront(). Аналогичного эффекта, с дополнительной статической типизацией, можно добиться, определив новую реализацию интерфейса ActionListener и добавив экземпляр в кнопку:

//Equivalent code using an inner class instead of EventHandler.
myButton.addActionListener(new ActionListener() {
    public void actionPerformed(ActionEvent e) {
        frame.toFront();
    }
});

Следующее по сложности использование EventHandler заключается в извлечении значения свойства из первого аргумента метода в интерфейсе обработчика (обычно объект события) и использовании его для установки значения свойства в целевом объекте. В следующем примере мы создаём обработчик ActionListener, который устанавливает свойство nextFocusableComponent целевого объекта (объекта myButton) в значение свойства "source" события.

EventHandler.create(ActionListener.class, myButton, "nextFocusableComponent", "source")

Это соответствует следующей реализации вложенного класса:

//Equivalent code using an inner class instead of EventHandler.
new ActionListener() {
    public void actionPerformed(ActionEvent e) {
        myButton.setNextFocusableComponent((Component)e.getSource());
    }
}

Также возможно создание обработчика EventHandler, который просто передаёт объект входящего события целевому действию. Если четвёртый EventHandler.create аргумент пустая строка, то событие просто передаётся дальше:

EventHandler.create(ActionListener.class, target, "doActionEvent", "")

Это соответствует следующей реализации вложенного класса:

//Equivalent code using an inner class instead of EventHandler.
new ActionListener() {
    public void actionPerformed(ActionEvent e) {
        target.doActionEvent(e);
    }
}

Вероятно, наиболее распространенное использование EventHandler заключается в извлечении значения свойства из источника объекта события и установке этого значения в качестве значения свойства целевого объекта. В следующем примере мы создаём обработчик ActionListener, который устанавливает свойство "label" целевого объекта в значение свойства "text" источника (свойства "source") события.

EventHandler.create(ActionListener.class, myButton, "label", "source.text")

Это соответствует следующей реализации вложенного класса:

//Equivalent code using an inner class instead of EventHandler.
new ActionListener {
    public void actionPerformed(ActionEvent e) {
        myButton.setLabel(((JTextField)e.getSource()).getText());
    }
}

Свойство события может быть "квалифицировано" произвольным числом префиксов свойств, разделённых символом ".". Квалифицирующие имена, появляющиеся перед символами ".", рассматриваются как имена свойств, которые должны применяться к объекту события, слева направо.

Например, следующий обработчик событий

EventHandler.create(ActionListener.class, target, "a", "b.c.d")

можно переписать в виде следующего вложенного класса (предполагая, что у всех свойств есть канонические методы-геттеры и они возвращают соответствующие типы):

//Equivalent code using an inner class instead of EventHandler.
new ActionListener {
    public void actionPerformed(ActionEvent e) {
        target.setA(e.getB().getC().isD());
    }
}

Целевое свойство также может быть "квалифицировано" произвольным числом префиксов свойств, разделённых символом ".". Например, следующий обработчик событий:

EventHandler.create(ActionListener.class, target, "a.b", "c.d")

можно переписать в виде следующего вложенного класса (предполагая, что у всех свойств есть канонические методы-геттеры и они возвращают соответствующие типы):

//Equivalent code using an inner class instead of EventHandler.
   new ActionListener {
     public void actionPerformed(ActionEvent e) {
         target.getA().setB(e.getC().isD());
    }
}

Так как EventHandler в конечном итоге полагается на рефлексию для вызова метода, мы не рекомендуем применять целевой перегруженный метод. Например, если цель является экземпляром класса MyTarget, который определён как:

public class MyTarget {
     public void doIt(String);
     public void doIt(Object);
   }

Тогда метод doIt перегружен. EventHandler вызовет метод, который соответствует источнику. Если источник равен null, то любой из методов подходит, и тот, который вызывается, не определён. По этой причине мы не рекомендуем применять целевые перегруженные методы.

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

EventHandler

@ConstructorProperties({"target","action","eventPropertyName","listenerMethodName"})
public EventHandler(Object target,
                    String action,
                    String eventPropertyName,
                    String listenerMethodName)

Создаёт новый объект EventHandler; обычно вы используете один из методов create вместо прямого вызова этого конструктора. Обратитесь к the general version of create для полного описания параметров eventPropertyName и listenerMethodName.

Параметры:

target - объект, который выполнит действие

action - имя (возможно, квалифицированное) свойства или метода цели

eventPropertyName - (возможно, квалифицированное) имя читаемого свойства входящего события

listenerMethodName - имя метода в интерфейсе обработчика, которое должно инициировать действие

Исключения:

NullPointerException - если target равно null

NullPointerException - если action равно null

См. также:

EventHandler, create(Class, Object, String, String, String), getTarget(), getAction(), getEventPropertyName(), getListenerMethodName()