com.vividsolutions.jump.workbench.plugin
Interface EnableCheck
- All Known Implementing Classes:
- BooleanPropertyEnableCheck, CurrentLayerIsRasterImageLayerCheck, MultiEnableCheck, PropertyEnableCheck
public interface EnableCheck
A test for whether to enable or disable a menu, toolbar button, or other
component. Provides a handy message about why a component is disabled.
- See Also:
EnableCheckFactory
|
Method Summary |
java.lang.String |
check(javax.swing.JComponent component)
Returns a non-null value if the check failed. |
check
java.lang.String check(javax.swing.JComponent component)
- Returns a non-null value if the check failed. Sometimes the return value
is used (for example, it is displayed as a tooltip for menu-items);
sometimes it is not (for example, toolbar buttons don't do anything with
the return value). An advanced use of an EnableCheck is simply to change
some property of a menu item (such as the text), as it is called when
menu items are displayed.
- Returns:
- an error message if the check failed, or null if the check
passed