oracle.javatools.ui

Class BlockingComponent

java.lang.Object

oracle.javatools.ui.BlockingComponent

public final class BlockingComponent
extends java.lang.Object

A class for a blocking component which, when enabled, will block all mouse and keyboard input to is sub-components.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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 Summary

Constructors

Constructor and Description
BlockingComponent(javax.swing.JComponent componentToBlock)

Method Summary

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.

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_STATE

public static final java.lang.String PROPERTY_STATE

Name of property fired when the state changes.

See Also:

Constant Field Values

PROPERTY_MESSAGE

public static final java.lang.String PROPERTY_MESSAGE

Name of property fired when the message changes.

See Also:

Constant Field Values

Constructor Detail

BlockingComponent

public BlockingComponent(javax.swing.JComponent componentToBlock)

Method Detail

getBlockingComponent

public javax.swing.JComponent getBlockingComponent()

Retrieve the component that will block input. Put this component into the component hierarchy at the level to block.

Note: do not add components directly to this component, instead add them to the blocked component given in the constructor.

Returns:

the root component of the blocking hierarchy.

setState

public void setState(BlockingComponent.State state)

Switch the state of the blocked component to restrict or unrestrict input.

Parameters:

state -

setMessage

public void setMessage(BlockingComponent.Message message)

Set the feedback message that appears over the blocked components.

Parameters:

message -

getMessage

public BlockingComponent.Message getMessage()

getState

public BlockingComponent.State getState()

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener pcl)

Listen for property changes of this component. For properties see the static fields PROPERTY_.

Parameters:

pcl -

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener pcl)

main

public static void main(java.lang.String[] args)

Test method that demonstrates this component.

Parameters:

args -