01: /*
02: * The Unified Mapping Platform (JUMP) is an extensible, interactive GUI
03: * for visualizing and manipulating spatial features with geometry and attributes.
04: *
05: * Copyright (C) 2003 Vivid Solutions
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
09: * as published by the Free Software Foundation; either version 2
10: * of the License, or (at your option) any later version.
11: *
12: * This program is distributed in the hope that it will be useful,
13: * but WITHOUT ANY WARRANTY; without even the implied warranty of
14: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15: * GNU General Public License for more details.
16: *
17: * You should have received a copy of the GNU General Public License
18: * along with this program; if not, write to the Free Software
19: * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20: *
21: * For more information, contact:
22: *
23: * Vivid Solutions
24: * Suite #1A
25: * 2328 Government Street
26: * Victoria BC V8T 5G5
27: * Canada
28: *
29: * (250)385-6040
30: * www.vividsolutions.com
31: */
32:
33: package com.vividsolutions.jump.workbench.plugin;
34:
35: import javax.swing.JComponent;
36:
37: /**
38: * A test for whether to enable or disable a menu, toolbar button, or other
39: * component. Provides a handy message about why a component is disabled.
40: * @see EnableCheckFactory
41: */
42: public interface EnableCheck {
43: /**
44: * Returns a non-null value if the check failed. Sometimes the return value
45: * is used (for example, it is displayed as a tooltip for menu-items);
46: * sometimes it is not (for example, toolbar buttons don't do anything with
47: * the return value). An advanced use of an EnableCheck is simply to change
48: * some property of a menu item (such as the text), as it is called when
49: * menu items are displayed.
50: *
51: * @return an error message if the check failed, or null if the check
52: * passed
53: */
54: public String check(JComponent component);
55: }
|