org.netbeans.swing.tabcontrol.plaf

Class BusyTabsSupport

java.lang.Object

org.netbeans.swing.tabcontrol.plaf.BusyTabsSupport

Direct Known Subclasses:

BusyTabsSupport.DefaultBusyTabsSupport

public abstract class BusyTabsSupport
extends Object

Support class to implement animation in tab headers to indicate some sort of 'busy' state.
install(Tabbed, TabDataModel)) and if any tab is marked as 'busy' (TopComponent.makeBusy(boolean)) it forces repeated repaints of that tab to allow animation effects. The UI of the tab container then can use an icon this class provides (getBusyIcon(boolean))to indicate the busy state. The default implementation of this class ensures that the icon is properly animated in each repaint.

See Also:

TopComponent.makeBusy(boolean)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BusyTabsSupport.DefaultBusyTabsSupport The default implementation of busy tabs.

Constructor Summary

Constructors

Constructor and Description
BusyTabsSupport()

Method Summary

Modifier and Type	Method and Description
abstract Icon	getBusyIcon(boolean isTabSelected) An icon that can be shown in busy tab's header to indicate some lengthy process is being run in it.
static BusyTabsSupport	getDefault()
protected abstract int	getRepaintTimerIntervalMillis()
void	install(Tabbed tabContainer, TabDataModel tabModel) Track changes in given tab container to have busy tab headers repainted.
void	makeTabBusy(Tabbed tabContainer, int tabIndex, boolean busy) Notification that busy state has changed for a given tab.
protected abstract void	tick() Invoked between each repaint events.
void	uninstall(Tabbed tabContainer, TabDataModel tabModel) Unregister the given tab container.

Methods inherited from class java.lang.Object

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

Constructor Detail

BusyTabsSupport

public BusyTabsSupport()

Method Detail

getDefault

public static BusyTabsSupport getDefault()

Returns:

The default implementation registered in global Lookup.

See Also:

BusyTabsSupport.DefaultBusyTabsSupport

install

public final void install(Tabbed tabContainer,
                          TabDataModel tabModel)

Track changes in given tab container to have busy tab headers repainted.

Parameters:

tabContainer - Tab container. This method should be typically called from container's addNotify().

tabModel - Container data model.

uninstall

public final void uninstall(Tabbed tabContainer,
                            TabDataModel tabModel)

Unregister the given tab container. This method should be typically called from container's removeNotify().

Parameters:

tabContainer -

tabModel -

getBusyIcon

public abstract Icon getBusyIcon(boolean isTabSelected)

An icon that can be shown in busy tab's header to indicate some lengthy process is being run in it. The default implementation ensures the icon is properly animated.

Parameters:

isTabSelected - True to get icon for a selected tab, false to get icon for regular tab state.

Returns:

Busy-like icon.

makeTabBusy

public final void makeTabBusy(Tabbed tabContainer,
                              int tabIndex,
                              boolean busy)

Notification that busy state has changed for a given tab.

Parameters:

tabContainer - Tab container.

tabIndex - Index of the tab.

busy -

getRepaintTimerIntervalMillis

protected abstract int getRepaintTimerIntervalMillis()

Returns:

The time in milliseconds between repaints of busy tabs. Value of zero means there are no repeated repaints.

tick

protected abstract void tick()

Invoked between each repaint events. The default implementation animates the busy icon in this method.