KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sourceforge > groboutils > uicapture > v1 > IFocusedWindowFinder


1 /*
2  * @(#)IFocusedWindowFinder.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;
28
29 import java.awt.Rectangle JavaDoc;
30
31
32 /**
33  * This interface defines a class which can discover the screen
34  * position for the native UI's currently focused window. This will, in
35  * general, need to be a native function. If the class cannot determine
36  * the focused window, or there isn't a focused window, then the class should
37  * return <tt>null</tt>, in which case the framework should default to the
38  * screen size.
39  *
40  * @author Matt Albrecht <a HREF="mailto:groboclown@users.sourceforge.net">groboclown@users.sourceforge.net</a>
41  * @version Jan 7, 2002
42  */
43 public interface IFocusedWindowFinder
44 {
45
46     //-------------------------------------------------------------------------
47 // Public methods
48
49     /**
50      * Find the current native UI focused window's bounds.
51      * If the class cannot determine
52      * the focused window, or there isn't a focused window, then the class
53      * should return <tt>null</tt>, in which case the framework should default
54      * to the screen size.
55      *
56      * @return the focused window's bounds, or <tt>null</tt> if it cannot be
57      * found.
58      */
59     public Rectangle JavaDoc getFocusedWindowBounds();
60 }
61
62
Popular Tags