public final class BlockingComponent
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static class |
BlockingComponent.Message
Collection of pre-canned messages that the blocked component can display as feedback to the
user when the component is blocked.
|
static class |
BlockingComponent.State |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
PROPERTY_MESSAGE
Name of property fired when the message changes.
|
static java.lang.String |
PROPERTY_STATE
Name of property fired when the state changes.
|
Constructor and Description |
---|
BlockingComponent(javax.swing.JComponent componentToBlock) |
Modifier and Type | Method and Description |
---|---|
void |
addPropertyChangeListener(java.beans.PropertyChangeListener pcl)
Listen for property changes of this component.
|
javax.swing.JComponent |
getBlockingComponent()
Retrieve the component that will block input.
|
BlockingComponent.Message |
getMessage() |
BlockingComponent.State |
getState() |
static void |
main(java.lang.String[] args)
Test method that demonstrates this component.
|
void |
removePropertyChangeListener(java.beans.PropertyChangeListener pcl) |
void |
setMessage(BlockingComponent.Message message)
Set the feedback message that appears over the blocked components.
|
void |
setState(BlockingComponent.State state)
Switch the state of the blocked component to restrict or unrestrict input.
|
public static final java.lang.String PROPERTY_STATE
public static final java.lang.String PROPERTY_MESSAGE
public BlockingComponent(javax.swing.JComponent componentToBlock)
public javax.swing.JComponent getBlockingComponent()
Note: do not add components directly to this component, instead add them to the blocked component given in the constructor.
public void setState(BlockingComponent.State state)
state
- public void setMessage(BlockingComponent.Message message)
message
- public BlockingComponent.Message getMessage()
public BlockingComponent.State getState()
public void addPropertyChangeListener(java.beans.PropertyChangeListener pcl)
pcl
- public void removePropertyChangeListener(java.beans.PropertyChangeListener pcl)
public static void main(java.lang.String[] args)
args
-