|
JavaTM 2 Platform Std. Ed. v1.3 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object
|
+--java.beans.FeatureDescriptor
|
+--java.beans.EventSetDescriptor
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)
This constructor 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. |
|
EventSetDescriptor(Class sourceClass,
String eventSetName,
Class listenerType,
String[] listenerMethodNames,
String addListenerMethodName,
String removeListenerMethodName)
This constructor creates an EventSetDescriptor from scratch using string names. |
|
EventSetDescriptor(String eventSetName,
Class listenerType,
Method[] listenerMethods,
Method addListenerMethod,
Method removeListenerMethod)
This constructor creates an EventSetDescriptor from scratch using java.lang.reflect.Method and java.lang.Class objects. |
|
EventSetDescriptor(String eventSetName,
Class listenerType,
MethodDescriptor[] listenerMethodDescriptors,
Method addListenerMethod,
Method removeListenerMethod)
This constructor creates an EventSetDescriptor from scratch using java.lang.reflect.MethodDescriptor and java.lang.Class objects. |
|
| Method Summary | |
Method |
getAddListenerMethod()
Gets the method used to add event listeners. |
MethodDescriptor[] |
getListenerMethodDescriptors()
Gets the MethodDescriptors of the target listener interface. |
Method[] |
getListenerMethods()
Gets the methods of the target listener interface. |
Class |
getListenerType()
Gets the Class object for the target interface. |
Method |
getRemoveListenerMethod()
Gets the method used to remove event listeners. |
boolean |
isInDefaultEventSet()
Report if an event set is in the "default set". |
boolean |
isUnicast()
Normally event sources are multicast. |
void |
setInDefaultEventSet(boolean inDefaultEventSet)
Mark 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(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,
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.| Method Detail |
public Class getListenerType()
public Method[] getListenerMethods()
public MethodDescriptor[] getListenerMethodDescriptors()
MethodDescriptors of the target listener interface.public Method getAddListenerMethod()
public Method getRemoveListenerMethod()
public void setUnicast(boolean unicast)
unicast - True if the event set is unicast.public boolean isUnicast()
public void setInDefaultEventSet(boolean inDefaultEventSet)
unicast - True if the event set is unicast.public boolean isInDefaultEventSet()
|
JavaTM 2 Platform Std. Ed. v1.3 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Java, Java 2D, and JDBC are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-2000 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.