KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sourceforge > groboutils > uicapture > v1 > event > IAllowCapturePassThroughListener


1 /*
2  * @(#)IAllowCapturePassThroughListener.java
3  *
4  * Copyright (C) 2002-2003 Matt Albrecht
5  * groboclown@users.sourceforge.net
6  * http://groboutils.sourceforge.net
7  *
8  * Permission is hereby granted, free of charge, to any person obtaining a
9  * copy of this software and associated documentation files (the "Software"),
10  * to deal in the Software without restriction, including without limitation
11  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12  * and/or sell copies of the Software, and to permit persons to whom the
13  * Software is furnished to do so, subject to the following conditions:
14  *
15  * The above copyright notice and this permission notice shall be included in
16  * all copies or substantial portions of the Software.
17  *
18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
24  * DEALINGS IN THE SOFTWARE.
25  */
26
27 package net.sourceforge.groboutils.uicapture.v1.event;
28
29
30
31 /**
32  * A listener which becomes aware of all low-level user interaction, and
33  * when they occured.
34  *
35  * @author Matt Albrecht <a HREF="mailto:groboclown@users.sourceforge.net">groboclown@users.sourceforge.net</a>
36  * @version Jan 4, 2002
37  */
38 public interface IAllowCapturePassThroughListener
39 {
40     /**
41      * @see java.awt.event.MouseWheelListener
42      *
43      * @return <tt>true</tt> to allow the event to passed to the underlying
44      * UI, or <tt>false</tt> to 'swallow' the event.
45      */
46     public boolean allowMouseWheelMoved( MouseWheelCaptureEvent ce );
47     
48     
49     /**
50      * @see java.awt.event.MouseListener
51      *
52      * @return <tt>true</tt> to allow the event to passed to the underlying
53      * UI, or <tt>false</tt> to 'swallow' the event.
54      */
55     public boolean allowMousePressed( MousePressedCaptureEvent ce );
56     
57     
58     /**
59      * @see java.awt.event.MouseListener
60      *
61      * @return <tt>true</tt> to allow the event to passed to the underlying
62      * UI, or <tt>false</tt> to 'swallow' the event.
63      */
64     public boolean allowMouseReleased( MouseReleasedCaptureEvent ce );
65     
66     
67     /**
68      * @see java.awt.event.KeyListener
69      *
70      * @return <tt>true</tt> to allow the event to passed to the underlying
71      * UI, or <tt>false</tt> to 'swallow' the event.
72      */
73     public boolean allowKeyPressed( KeyPressedCaptureEvent ce );
74     
75     
76     /**
77      * @see java.awt.event.KeyListener
78      *
79      * @return <tt>true</tt> to allow the event to passed to the underlying
80      * UI, or <tt>false</tt> to 'swallow' the event.
81      */
82     public boolean allowKeyReleased( KeyReleasedCaptureEvent ce );
83 }
84
85
Popular Tags