01: /*
02: * @(#)Visibility.java 1.19 06/10/10
03: *
04: * Copyright 1990-2006 Sun Microsystems, Inc. All Rights Reserved.
05: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
06: *
07: * This program is free software; you can redistribute it and/or
08: * modify it under the terms of the GNU General Public License version
09: * 2 only, as published by the Free Software Foundation.
10: *
11: * This program is distributed in the hope that it will be useful, but
12: * WITHOUT ANY WARRANTY; without even the implied warranty of
13: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14: * General Public License version 2 for more details (a copy is
15: * included at /legal/license.txt).
16: *
17: * You should have received a copy of the GNU General Public License
18: * version 2 along with this work; if not, write to the Free Software
19: * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20: * 02110-1301 USA
21: *
22: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
23: * Clara, CA 95054 or visit www.sun.com if you need additional
24: * information or have any questions.
25: *
26: */
27:
28: package java.beans;
29:
30: /**
31: * Under some circumstances a bean may be run on servers where a GUI
32: * is not available. This interface can be used to query a bean to
33: * determine whether it absolutely needs a gui, and to advise the
34: * bean whether a GUI is available.
35: * <p>
36: * This interface is for expert developers, and is not needed
37: * for normal simple beans. To avoid confusing end-users we
38: * avoid using getXXX setXXX design patterns for these methods.
39: */
40:
41: public interface Visibility {
42: /**
43: * Determines whether this bean needs a GUI.
44: *
45: * @return True if the bean absolutely needs a GUI available in
46: * order to get its work done.
47: */
48: boolean needsGui();
49:
50: /**
51: * This method instructs the bean that it should not use the Gui.
52: */
53: void dontUseGui();
54:
55: /**
56: * This method instructs the bean that it is OK to use the Gui.
57: */
58: void okToUseGui();
59:
60: /**
61: * Determines whether this bean is avoiding using a GUI.
62: *
63: * @return true if the bean is currently avoiding use of the Gui.
64: * e.g. due to a call on dontUseGui().
65: */
66: boolean avoidingGui();
67: }
|