Класс EventSetDescriptor

public class EventSetDescriptor
extends FeatureDescriptor

Описание набора событий, которые генерирует заданный Java-компонент.

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

Since:
1.1

Краткое описание конструкторов

Конструктор Описание
EventSetDescriptor​(Class<?> sourceClass, String eventSetName, Class<?> listenerType, String listenerMethodName)

Создаёт EventSetDescriptor, предполагая, что вы следуете наиболее простому стандартному шаблону проектирования, где именованное событие "fred" (1) передаётся как вызов одного метода интерфейса FredListener, (2) имеет один аргумент типа FredEvent, и (3) где FredListener может быть зарегистрирован вызовом метода addFredListener компонента-источника и удалён вызовом метода removeFredListener.
EventSetDescriptor​(Class<?> sourceClass, String eventSetName, Class<?> listenerType, String[] listenerMethodNames, String addListenerMethodName, String removeListenerMethodName)

Создаёт EventSetDescriptor с нуля, используя строковые имена.
EventSetDescriptor​(Class<?> sourceClass, String eventSetName, Class<?> listenerType, String[] listenerMethodNames, String addListenerMethodName, String removeListenerMethodName, String getListenerMethodName)

Этот конструктор создаёт EventSetDescriptor с нуля, используя строковые имена.
EventSetDescriptor​(String eventSetName, Class<?> listenerType, MethodDescriptor[] listenerMethodDescriptors, Method addListenerMethod, Method removeListenerMethod)

Создаёт EventSetDescriptor с нуля, используя объекты java.lang.reflect.MethodDescriptor и java.lang.Class.

EventSetDescriptor​(String eventSetName, Class<?> listenerType, Method[] listenerMethods, Method addListenerMethod, Method removeListenerMethod)

Создаёт EventSetDescriptor с нуля, используя объекты java.lang.reflect.Method и java.lang.Class.

EventSetDescriptor​(String eventSetName, Class<?> listenerType, Method[] listenerMethods, Method addListenerMethod, Method removeListenerMethod, Method getListenerMethod)

Этот конструктор создаёт EventSetDescriptor с нуля, используя объекты java.lang.reflect.Method и java.lang.Class.

Краткое описание методов

Модификатор и тип Метод Описание
Method getAddListenerMethod()

Получает метод, используемый для добавления обработчиков событий.
Method getGetListenerMethod()

Получает метод, используемый для доступа к зарегистрированным обработчикам событий.
MethodDescriptor[] getListenerMethodDescriptors()

Получает MethodDescriptor целевого интерфейса обработчика.
Method[] getListenerMethods()

Получает методы целевого интерфейса обработчика.
Class<?> getListenerType()

Получает объект Class для целевого интерфейса.
Method getRemoveListenerMethod()

Получает метод, используемый для удаления обработчиков событий.
boolean isInDefaultEventSet()

Сообщает, находится ли набор событий в наборе по умолчанию.
boolean isUnicast()

Обычно источники событий являются многоадресными.
void setInDefaultEventSet​(boolean inDefaultEventSet)

Помечает набор событий как находящийся в наборе по умолчанию (или нет).
void setUnicast​(boolean unicast)

Помечает набор событий как одноадресные (или нет).

Методы, унаследованные от класса java.beans.FeatureDescriptor

attributeNames, getDisplayName, getName, getShortDescription, getValue, isExpert, isHidden, isPreferred, setDisplayName, setExpert, setHidden, setName, setPreferred, setShortDescription, setValue, toString

Методы, унаследованные от класса java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

EventSetDescriptor

public EventSetDescriptor(Class<?> sourceClass,
                          String eventSetName,
                          Class<?> listenerType,
                          String listenerMethodName)
                   throws IntrospectionException

Создаёт EventSetDescriptor , предполагая, что вы следуете наиболее простому стандартному шаблону проектирования, где событие с именем "fred" (1) передаётся как вызов единственному методу интерфейса FredListener, (2) имеет один аргумент типа FredEvent, и (3) где FredListener может быть зарегистрирован вызовом метода addFredListener компонента-источника и удалён вызовом метода removeFredListener.

Параметры:
sourceClass - Класс, генерирующий событие.
eventSetName - Программное имя события. Например, "fred". Обратите внимание, что оно обычно должно начинаться с строчной буквы.
listenerType - Целевой интерфейс, которому будут передаваться события.
listenerMethodName - Метод, который будет вызван при передаче события целевому интерфейсу слушателей.
Исключения:
IntrospectionException - если при интроспекции произошла ошибка.

EventSetDescriptor

public EventSetDescriptor(Class<?> sourceClass,
                          String eventSetName,
                          Class<?> listenerType,
                          String[] listenerMethodNames,
                          String addListenerMethodName,
                          String removeListenerMethodName)
                   throws IntrospectionException

Создаёт EventSetDescriptor с нуля, используя строковые имена.

Параметры:
sourceClass - Класс, генерирующий событие.
eventSetName - Программное имя набора событий. Обратите внимание, что оно обычно должно начинаться с строчной буквы.
listenerType - Класс целевого интерфейса, которому будут передаваться события.
listenerMethodNames - Имена методов, которые будут вызваны при передаче события целевому интерфейсу слушателей.
addListenerMethodName - Имя метода источника события, который может использоваться для регистрации объекта слушателя события.
removeListenerMethodName - Имя метода источника события, который может использоваться для отмены регистрации объекта слушателя события.
Исключения:
IntrospectionException - если при интроспекции произошла ошибка.

EventSetDescriptor

public EventSetDescriptor(Class<?> sourceClass,
                          String eventSetName,
                          Class<?> listenerType,
                          String[] listenerMethodNames,
                          String addListenerMethodName,
                          String removeListenerMethodName,
                          String getListenerMethodName)
                   throws IntrospectionException

Этот конструктор создаёт EventSetDescriptor с нуля, используя строковые имена.

Параметры:
sourceClass - Класс, генерирующий событие.
eventSetName - Программное имя набора событий. Обратите внимание, что оно обычно должно начинаться с строчной буквы.
listenerType - Класс целевого интерфейса, которому будут передаваться события.
listenerMethodNames - Имена методов, которые будут вызваны при передаче события целевому интерфейсу слушателей.
addListenerMethodName - Имя метода источника события, который может использоваться для регистрации объекта слушателя события.
removeListenerMethodName - Имя метода источника события, который может использоваться для отмены регистрации объекта слушателя события.
getListenerMethodName - Метод источника события, который можно использовать для доступа к массиву объектов слушателей события.
Исключения:
IntrospectionException - если при интроспекции произошла ошибка.
С:
1.4

EventSetDescriptor

public EventSetDescriptor(String eventSetName,
                          Class<?> listenerType,
                          Method[] listenerMethods,
                          Method addListenerMethod,
                          Method removeListenerMethod)
                   throws IntrospectionException

Создаёт EventSetDescriptor с нуля, используя объекты java.lang.reflect.Method и java.lang.Class.

Параметры:
eventSetName - Программное имя набора событий.
listenerType - Класс для интерфейса слушателей.
listenerMethods - Массив объектов Method, описывающих каждый из методов обработки событий в целевом слушателе.
addListenerMethod - Метод источника события, который может использоваться для регистрации объекта слушателя события.
removeListenerMethod - Метод источника события, который может использоваться для отмены регистрации объекта слушателя события.
Исключения:
IntrospectionException - если при интроспекции произошла ошибка.

EventSetDescriptor

public EventSetDescriptor(String eventSetName,
                          Class<?> listenerType,
                          Method[] listenerMethods,
                          Method addListenerMethod,
                          Method removeListenerMethod,
                          Method getListenerMethod)
                   throws IntrospectionException

Этот конструктор создаёт EventSetDescriptor с нуля, используя объекты java.lang.reflect.Method и java.lang.Class.

Параметры:
eventSetName - Программное имя набора событий.
listenerType - Класс для интерфейса слушателей.
listenerMethods - Массив объектов Method, описывающих каждый из методов обработки событий в целевом слушателе.
addListenerMethod - Метод источника события, который может использоваться для регистрации объекта слушателя события.
removeListenerMethod - Метод источника события, который может использоваться для отмены регистрации объекта слушателя события.
getListenerMethod - Метод источника события, который можно использовать для доступа к массиву объектов слушателей события.
Исключения:
IntrospectionException - если при интроспекции произошла ошибка.
С:
1.4

EventSetDescriptor

public EventSetDescriptor(String eventSetName,
                          Class<?> listenerType,
                          MethodDescriptor[] listenerMethodDescriptors,
                          Method addListenerMethod,
                          Method removeListenerMethod)
                   throws IntrospectionException

Создаёт EventSetDescriptor с нуля, используя объекты java.lang.reflect.MethodDescriptor и java.lang.Class.

Параметры:
eventSetName - Программное имя набора событий.
listenerType - Класс для интерфейса слушателей.
listenerMethodDescriptors - Массив объектов MethodDescriptor, описывающих каждый из методов обработки событий в целевом слушателе.
addListenerMethod - Метод источника события, который может использоваться для регистрации объекта слушателя события.
removeListenerMethod - Метод источника события, который может использоваться для отмены регистрации объекта слушателя события.
Исключения:
IntrospectionException - если при интроспекции произошла ошибка.

Методы

getListenerType

public Class<?> getListenerType()

Возвращает объект Class для целевого интерфейса.

Возвращает:
Объект Class для целевого интерфейса, который будет вызван при срабатывании события.

getListenerMethods

public Method[] getListenerMethods()

Возвращает методы целевого интерфейса слушателей.

Возвращает:
Массив объектов Method для целевых методов внутри целевого интерфейса слушателей, которые будут вызваны при срабатывании событий.

getListenerMethodDescriptors

public MethodDescriptor[] getListenerMethodDescriptors()

Возвращает MethodDescriptor целевого интерфейса слушателей.

Возвращает:
Массив объектов MethodDescriptor для целевых методов внутри целевого интерфейса слушателей, которые будут вызваны при срабатывании событий.

getAddListenerMethod

public Method getAddListenerMethod()

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

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

getRemoveListenerMethod

public Method getRemoveListenerMethod()

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

Возвращает:
Метод, используемый для удаления слушателя в источнике события.

getGetListenerMethod

public Method getGetListenerMethod()

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

Возвращает:
Метод, используемый для доступа к массиву слушателей в источнике события, или null, если он не существует.
С:
1.4

setUnicast

public void setUnicast(boolean unicast)

Помечает набор событий как одноадресные (или нет).

Параметры:
unicast - True, если набор событий одноадресные.

isUnicast

public boolean isUnicast()

Обычно источники событий являются многоадресными. Однако есть исключения, которые строго одноадресные.

Возвращает:
true , если набор событий одноадресные. По умолчанию false.

setInDefaultEventSet

public void setInDefaultEventSet(boolean inDefaultEventSet)

Помечает набор событий как находящийся в "по умолчанию" наборе (или нет). По умолчанию это true.

Параметры:
inDefaultEventSet - true если набор событий в наборе "по умолчанию", false если нет

isInDefaultEventSet

public boolean isInDefaultEventSet()

Сообщает, находится ли набор событий в наборе "по умолчанию".

Возвращает:
true , если набор событий в наборе "по умолчанию". По умолчанию true.

© 1993, 2020, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/beans/EventSetDescriptor.html

Spec-Zone .ru
спецификации, руководства, описания, API