Класс EventHandler

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

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

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

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

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

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

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

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

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.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.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);
   }

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

EventHandler

@ConstructorProperties(value={"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()

Методы

getTarget

public Object getTarget()

Возвращает объект, которому этот обработчик событий отправит сообщение.

Возвращает:

целевой объект этого обработчика событий

См. также:

EventHandler(Object, String, String, String)

getAction

public String getAction()

Возвращает имя записываемого свойства целевого объекта, которое этот обработчик событий установит, или имя метода, который этот обработчик вызовет у целевого объекта.

Возвращает:

действие этого обработчика событий

См. также:

EventHandler(Object, String, String, String)

getEventPropertyName

public String getEventPropertyName()

Возвращает свойство события, которое должно использоваться в действии, применённом к целевому объекту.

Возвращает:

свойство события

См. также:

EventHandler(Object, String, String, String)

getListenerMethodName

public String getListenerMethodName()

Возвращает имя метода, который инициирует действие. Значение null означает, что все методы в интерфейсе слушателя инициируют действие.

Возвращает:

имя метода, который инициирует действие

См. также:

EventHandler(Object, String, String, String)

invoke

public Object invoke(Object proxy,
                     Method method,
                     Object[] arguments)

Извлекает соответствующее значение свойства из события и передаёт его в действие, связанное с этим EventHandler.

Определено в:

invoke в интерфейсе InvocationHandler

Параметры:

proxy - объект-прокси

method - метод в интерфейсе слушателя

arguments - массив объектов, содержащих значения аргументов, переданных в вызов метода на объекте-прокси, или null, если метод интерфейса не принимает аргументов. Аргументы примитивных типов обернуты в экземпляры соответствующего класса-обёртки для примитивных типов, например, java.lang.Integer или java.lang.Boolean.

Возвращает:

результат применения действия к целевому объекту

См. также:

EventHandler

create

public static <T> T create(Class<T> listenerInterface,
                           Object target,
                           String action)

EventHandler.create(ActionListener.class, dialog, "show")

Тип параметров:

T - тип для создания

Параметры:

listenerInterface - интерфейс слушателя для создания прокси-объекта

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

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

Возвращает:

объект, реализующий listenerInterface

Исключения:

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

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

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

См. также:

create(Class, Object, String, String)

create

public static <T> T create(Class<T> listenerInterface,
                           Object target,
                           String action,
                           String eventPropertyName)

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

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

Тип параметров:

T - тип для создания

Параметры:

listenerInterface - интерфейс слушателя для создания прокси-объекта

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

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

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

Возвращает:

объект, реализующий listenerInterface

Исключения:

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

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

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

См. также:

create(Class, Object, String, String, String)

create

public static <T> T create(Class<T> listenerInterface,
                           Object target,
                           String action,
                           String eventPropertyName,
                           String listenerMethodName)

EventHandler.create(MouseListener.class, target, "origin", "point", "mousePressed");

//Equivalent code using an inner class instead of EventHandler.
new MouseAdapter() {
    public void mousePressed(MouseEvent e) {
        target.setOrigin(e.getPoint());
    }
};

Тип параметров:

T - тип для создания

Параметры:

listenerInterface - интерфейс слушателя для создания прокси-объекта

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

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

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

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

Возвращает:

объект, реализующий listenerInterface

Исключения:

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

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

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

См. также:

EventHandler