Class MultiEnableCheck

java.lang.Object

com.vividsolutions.jump.workbench.plugin.MultiEnableCheck

All Implemented Interfaces:

EnableCheck

public class MultiEnableCheck
extends Object
implements EnableCheck

A sequence of EnableChecks treated as one.

Constructor Summary

Constructors

Constructor	Description
MultiEnableCheck()	Create a new MultiEnableCheck

Method Summary

Modifier and Type	Method	Description
MultiEnableCheck	add(EnableCheck enableCheck)
String	check(JComponent component)	Returns a non-null value if the check failed.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MultiEnableCheck

public MultiEnableCheck()

Create a new MultiEnableCheck

Method Details

check

public String check(JComponent component)

Description copied from interface: EnableCheck

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.

Specified by:

check in interface EnableCheck

Returns:

an error message if the check failed, or null if the check passed

add

public MultiEnableCheck add(EnableCheck enableCheck)

Returns:

this, to allow "method chaining"