org.openjump.core.ui.enablecheck

Class PropertyEnableCheck

java.lang.Object

org.openjump.core.ui.enablecheck.PropertyEnableCheck

All Implemented Interfaces:

EnableCheck

public class PropertyEnableCheck
extends java.lang.Object
implements EnableCheck

Constructor Summary

Constructors

Constructor and Description
PropertyEnableCheck(java.lang.Object object, java.lang.String checkMethodName, java.lang.Object expectedValue, boolean invert, ErrorHandler errorHandler)
PropertyEnableCheck(java.lang.Object object, java.lang.String checkMethodName, java.lang.Object expectedValue, ErrorHandler errorHandler)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	check(javax.swing.JComponent component) Returns a non-null value if the check failed.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyEnableCheck

public PropertyEnableCheck(java.lang.Object object,
                   java.lang.String checkMethodName,
                   java.lang.Object expectedValue,
                   boolean invert,
                   ErrorHandler errorHandler)

PropertyEnableCheck

public PropertyEnableCheck(java.lang.Object object,
                   java.lang.String checkMethodName,
                   java.lang.Object expectedValue,
                   ErrorHandler errorHandler)

Parameters:

object - The object to invoke the method on.

checkMethodName - The name of the check method which returns a boolean value.

expectedValue - The expected value to be returned for the check to be enabled.

Method Detail

check

public java.lang.String check(javax.swing.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