1 /*
2  * Copyright (c) 2011, 2012, 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 
26 package com.apple.eawt.event;
27 
28 import java.awt.*;
29 
30 /**
31  * Abstract event all gestures inherit from.
32  *
33  * Note: GestureEvent is not subclass of {@link AWTEvent} and is not dispatched
34  * directly from the {@link EventQueue}. This is an intentional design decision
35  * to prevent collision with an official java.awt.* gesture event types subclassing
36  * {@link InputEvent}.
37  *
38  * {@link GestureListener}s are only notified from the AWT Event Dispatch thread.
39  *
40  * @see GestureUtilities
41  *
42  * @since Java for Mac OS X 10.5 Update 7, Java for Mac OS X 10.6 Update 2
43  */
44 public abstract class GestureEvent {
45     boolean consumed;
46 
GestureEvent()47     GestureEvent() {
48         // package private
49     }
50 
51     /**
52      * Consuming an event prevents listeners later in the chain or higher in the
53      * component hierarchy from receiving the event.
54      */
consume()55     public void consume() {
56         consumed = true;
57     }
58 
59     /**
60      * @return if the event has been consumed
61      */
isConsumed()62     protected boolean isConsumed() {
63         return consumed;
64     }
65 }
66