| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public class EventSetDescriptor extends FeatureDescriptor
An EventSetDescriptor describes a group of events that a given Java bean fires.
The given group of events are all delivered as method calls on a single event listener interface, and an event listener object can be registered via a call on a registration method supplied by the event source.
Constructor Summary | |
---|---|
EventSetDescriptor(Class sourceClass, String eventSetName, Class listenerType, String listenerMethodName) Creates an EventSetDescriptor assuming that you are following the most simple standard design pattern where a named event "fred" is (1) delivered as a call on the single method of interface FredListener, (2) has a single argument of type FredEvent, and (3) where the FredListener may be registered with a call on an addFredListener method of the source component and removed with a call on a removeFredListener method. |
|
Creates an EventSetDescriptor from scratch using string names. |
|
This constructor creates an EventSetDescriptor from scratch using string names. |
|
EventSetDescriptor(String eventSetName, Class listenerType, MethodDescriptor[] listenerMethodDescriptors, Method addListenerMethod, Method removeListenerMethod) Creates an EventSetDescriptor from scratch using java.lang.reflect.MethodDescriptor and java.lang.Class objects. |
|
Creates an EventSetDescriptor from scratch using java.lang.reflect.Method and java.lang.Class objects. |
|
This constructor creates an EventSetDescriptor from scratch using java.lang.reflect.Method and java.lang.Class objects. |
Method Summary | |
---|---|
Method |
Gets the method used to add event listeners. |
Method |
Gets the method used to access the registered event listeners. |
MethodDescriptor[] |
Gets the MethodDescriptor s of the target listener interface.
|
Method[] |
Gets the methods of the target listener interface. |
Class |
Gets the Class object for the target interface. |
Method |
Gets the method used to remove event listeners. |
boolean |
Reports if an event set is in the "default" set. |
boolean |
Normally event sources are multicast. |
void |
setInDefaultEventSet(boolean inDefaultEventSet) Marks an event set as being in the "default" set (or not). |
void |
setUnicast(boolean unicast) Mark an event set as unicast (or not). |
Methods inherited from class java.beans.FeatureDescriptor |
---|
attributeNames, getDisplayName, getName, getShortDescription, getValue, isExpert, isHidden, isPreferred, setDisplayName, setExpert, setHidden, setName, setPreferred, setShortDescription, setValue |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public EventSetDescriptor(Class sourceClass, String eventSetName, Class listenerType, String listenerMethodName) throws IntrospectionException
sourceClass
- The class firing the event.eventSetName
- The programmatic name of the event. E.g. "fred".
Note that this should normally start with a lower-case character.listenerType
- The target interface that events
will get delivered to.listenerMethodName
- The method that will get called when the event gets
delivered to its target listener interface.IntrospectionException
- if an exception occurs during
introspection.public EventSetDescriptor(Class sourceClass, String eventSetName, Class listenerType, String[] listenerMethodNames, String addListenerMethodName, String removeListenerMethodName) throws IntrospectionException
sourceClass
- The class firing the event.eventSetName
- The programmatic name of the event set.
Note that this should normally start with a lower-case character.listenerType
- The Class of the target interface that events
will get delivered to.listenerMethodNames
- The names of the methods that will get called
when the event gets delivered to its target listener interface.addListenerMethodName
- The name of the method on the event source
that can be used to register an event listener object.removeListenerMethodName
- The name of the method on the event source
that can be used to de-register an event listener object.IntrospectionException
- if an exception occurs during
introspection.public EventSetDescriptor(Class sourceClass, String eventSetName, Class listenerType, String[] listenerMethodNames, String addListenerMethodName, String removeListenerMethodName, String getListenerMethodName) throws IntrospectionException
sourceClass
- The class firing the event.eventSetName
- The programmatic name of the event set.
Note that this should normally start with a lower-case character.listenerType
- The Class of the target interface that events
will get delivered to.listenerMethodNames
- The names of the methods that will get called
when the event gets delivered to its target listener interface.addListenerMethodName
- The name of the method on the event source
that can be used to register an event listener object.removeListenerMethodName
- The name of the method on the event source
that can be used to de-register an event listener object.getListenerMethodName
- The method on the event source that
can be used to access the array of event listener objects.IntrospectionException
- if an exception occurs during
introspection.public EventSetDescriptor(String eventSetName, Class listenerType, MethodDescriptor[] listenerMethodDescriptors, Method addListenerMethod, Method removeListenerMethod) throws IntrospectionException
eventSetName
- The programmatic name of the event set.listenerType
- The Class for the listener interface.listenerMethodDescriptors
- An array of MethodDescriptor objects
describing each of the event handling methods in the
target listener.addListenerMethod
- The method on the event source
that can be used to register an event listener object.removeListenerMethod
- The method on the event source
that can be used to de-register an event listener object.IntrospectionException
- if an exception occurs during
introspection.public EventSetDescriptor(String eventSetName, Class listenerType, Method[] listenerMethods, Method addListenerMethod, Method removeListenerMethod) throws IntrospectionException
eventSetName
- The programmatic name of the event set.listenerType
- The Class for the listener interface.listenerMethods
- An array of Method objects describing each
of the event handling methods in the target listener.addListenerMethod
- The method on the event source
that can be used to register an event listener object.removeListenerMethod
- The method on the event source
that can be used to de-register an event listener object.IntrospectionException
- if an exception occurs during
introspection.public EventSetDescriptor(String eventSetName, Class listenerType, Method[] listenerMethods, Method addListenerMethod, Method removeListenerMethod, Method getListenerMethod) throws IntrospectionException
eventSetName
- The programmatic name of the event set.listenerType
- The Class for the listener interface.listenerMethods
- An array of Method objects describing each
of the event handling methods in the target listener.addListenerMethod
- The method on the event source
that can be used to register an event listener object.removeListenerMethod
- The method on the event source
that can be used to de-register an event listener object.getListenerMethod
- The method on the event source
that can be used to access the array of event listener objects.IntrospectionException
- if an exception occurs during
introspection.Method Detail |
---|
public synchronized Method getAddListenerMethod()
public synchronized Method getGetListenerMethod()
public synchronized MethodDescriptor[] getListenerMethodDescriptors()
MethodDescriptor
s of the target listener interface.
MethodDescriptor
objects for the target methods
within the target listener interface that will get called when
events are fired.public synchronized Method[] getListenerMethods()
public Class getListenerType()
public synchronized Method getRemoveListenerMethod()
public boolean isInDefaultEventSet()
public boolean isUnicast()
public void setInDefaultEventSet(boolean inDefaultEventSet)
inDefaultEventSet
- true
if the event set is in
the "default" set,
false
if notpublic void setUnicast(boolean unicast)
unicast
- True if the event set is unicast.
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |