org.jowidgets.api.command

Class EnabledState

java.lang.Object

org.jowidgets.api.command.EnabledState

All Implemented Interfaces:

IEnabledState

public final class EnabledState
extends java.lang.Object
implements IEnabledState

Field Summary

Fields

Modifier and Type	Field and Description
static EnabledState	DISABLED A enabled state constant for enabled = false.
static EnabledState	ENABLED A enabled state constant for enabled = true

Method Summary

Methods

Modifier and Type	Method and Description
static EnabledState	disabled(java.lang.String reason) Creates a new enabled state that is disabled
boolean	equals(java.lang.Object obj)
java.lang.String	getReason() If the action is not enabled, this get's the reason why.
int	hashCode()
boolean	isEnabled()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ENABLED

public static final EnabledState ENABLED

A enabled state constant for enabled = true

DISABLED

public static final EnabledState DISABLED

A enabled state constant for enabled = false. This enabled state has no reason! For better usability of the application provide information why its is disabled to the user with help of the method disabled(String)

Method Detail

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface IEnabledState

Returns:

true, if the action is enabled, false otherwise

getReason

public java.lang.String getReason()

Description copied from interface: IEnabledState

If the action is not enabled, this get's the reason why. This reason should be offered to the user, e.g. in the tooltip of a disabled button or menu item

Specified by:

getReason in interface IEnabledState

Returns:

the reason

disabled

public static EnabledState disabled(java.lang.String reason)

Creates a new enabled state that is disabled

Parameters:

reason - The reason why it is disabled

Returns:

The created enabled state

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object