1 /*
2  * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * This code is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License version 2 only, as
7  * published by the Free Software Foundation.  Oracle designates this
8  * particular file as subject to the "Classpath" exception as provided
9  * by Oracle in the LICENSE file that accompanied this code.
10  *
11  * This code is distributed in the hope that it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14  * version 2 for more details (a copy is included in the LICENSE file that
15  * accompanied this code).
16  *
17  * You should have received a copy of the GNU General Public License version
18  * 2 along with this work; if not, write to the Free Software Foundation,
19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20  *
21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22  * or visit www.oracle.com if you need additional information or have any
23  * questions.
24  */
25 package java.awt;
26 
27 interface EventFilter {
28 
29     /**
30      * Enumeration for possible values for {@code acceptEvent(AWTEvent ev)} method.
31      * @see EventDispatchThread#pumpEventsForFilter
32      */
33     static enum FilterAction {
34         /**
35          * ACCEPT means that this filter do not filter the event and allows other
36          * active filters to proceed it. If all the active filters accept the event, it
37          * is dispatched by the {@code EventDispatchThread}
38          * @see EventDispatchThread#pumpEventsForFilter
39          */
40         ACCEPT,
41         /**
42          * REJECT means that this filter filter the event. No other filters are queried,
43          * and the event is not dispatched by the {@code EventDispatchedThread}
44          * @see EventDispatchThread#pumpEventsForFilter
45          */
46         REJECT,
47         /**
48          * ACCEPT_IMMEDIATELY means that this filter do not filter the event, no other
49          * filters are queried and to proceed it, and it is dispatched by the
50          * {@code EventDispatchThread}
51          * It is not recommended to use ACCEPT_IMMEDIATELY as there may be some active
52          * filters not queried yet that do not accept this event. It is primarily used
53          * by modal filters.
54          * @see EventDispatchThread#pumpEventsForFilter
55          * @see ModalEventFilter
56          */
57         ACCEPT_IMMEDIATELY
58     };
59 
acceptEvent(AWTEvent ev)60     FilterAction acceptEvent(AWTEvent ev);
61 }
62