oracle.javatools.ui.tree.lazy

Class LazyProgressController

java.lang.Object

oracle.javatools.ui.tree.lazy.LazyProgressController

public final class LazyProgressController
extends java.lang.Object

A mechanism to track and control the lazy loading of tree nodes.

A controller is not required to use lazy loading nodes - they can be added to the tree and will work as advertised - but the controller does offer additional abilities such as being able to cancel nodes currently in the progress of fetching children.

If used, a controller is intended to track all lazy nodes in a tree, and provide feedback via property changes whether there is at least one node in the tree currently fetching children.

A cancel mechanism is also provided which will cancel any active fetching.

These two things combined are primarily designed to allow a 'stop' ui, such as a button above the lazy tree that can be enabled/disabled as the lazy nodes load, and when pressed can cancel any fetching.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROPERTY_PROGRESS_ACTIVE Property informing that there is at least one tracked progress node currently fetching its children.

Constructor Summary

Constructors

Constructor and Description
LazyProgressController(javax.swing.JTree tree)

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener)
void	cancelProgress() Stop any nodes that currently fetching children, and return the nodes to the pre-fetched state
boolean	isProgressActive()
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_PROGRESS_ACTIVE

public static final java.lang.String PROPERTY_PROGRESS_ACTIVE

Property informing that there is at least one tracked progress node currently fetching its children.

See Also:

Constant Field Values

Constructor Detail

LazyProgressController

public LazyProgressController(javax.swing.JTree tree)

Method Detail

cancelProgress

public void cancelProgress()

Stop any nodes that currently fetching children, and return the nodes to the pre-fetched state

isProgressActive

public boolean isProgressActive()

Returns:

true if there is at least one tracked node currently fetching

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)