01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: *
17: * $Header:$
18: */
19: package org.apache.beehive.controls.api.events;
20:
21: import java.lang.annotation.ElementType;
22: import java.lang.annotation.Retention;
23: import java.lang.annotation.RetentionPolicy;
24: import java.lang.annotation.Target;
25:
26: /**
27: * The EventHandler annotation type is used to mark a method that provides the event handler
28: * implementation for a Control event.
29: */
30: @Retention(RetentionPolicy.RUNTIME)
31: @Target({ElementType.METHOD})
32: public @interface EventHandler {
33: /**
34: * The field name of the Java control event source. This must be an @Control field declared
35: * on the class defining the event handler method (or on a superclass if the field is not
36: * declared to be private).
37: */
38: String field();
39:
40: /**
41: * The EventSet interface that declares the event. This must be a valid EventSet interface
42: * associated with the control type of the <code>field</code> member.
43: */
44: Class eventSet();
45:
46: /**
47: * The name of the handled event. This must be the name of a method declared on the EventSet
48: * interface referenced by the <code>eventSet</code> member. The annotated method must have
49: * an event signature that <b>exactly</b> matches one of the event methods with this name.
50: */
51: String eventName();
52: }
|