org.scijava.ui.swing.task

Class SwingTaskMonitorComponent

java.lang.Object

org.scijava.ui.swing.task.SwingTaskMonitorComponent

public class SwingTaskMonitorComponent
extends Object

A Swing component with a circular progress bar displaying the overall progress of all registered Task created via the TaskService.

When the user clicks on the circular progress bar, a frame containing a table summarizing each task progression is displayed.

Each task is rendered in the table with a custom renderer (see TaskRenderer). First column:

• a label with the name of the task and its status
• a linear progress bar
• if enabled in the constructor, a label with an estimation of the remaining time until task completion, the estimation assumes a constant completion speed since the start of the task registration

Second column:

• a stop icon, clickable and which calls Cancelable.cancel(String) for the displayed task

Before cancellation, a user confirmation dialog can be enabled with enableCancelConfirmation() or disabled with disableCancelConfirmation().

Author:

Nicolas Chiaruttini, EPFL, 2022

Constructor Summary

Constructors

Constructor and Description
SwingTaskMonitorComponent(Context context, boolean estimateTimeLeft, boolean confirmBeforeCancel, int size, boolean undecorated) Constructs a Swing Task Monitor component - clickable circular progress bar the component can be accessed with getComponent().

Method Summary

Modifier and Type	Method and Description
void	disableCancelConfirmation() NO user confirmation required when canceling a task by clicking the task table.
void	enableCancelConfirmation() User confirmation required when canceling a task by clicking the task table.
JComponent	getComponent() Retrieves the global clickable progress bar that can be placed in the interface

Methods inherited from class java.lang.Object

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

Constructor Detail

SwingTaskMonitorComponent

public SwingTaskMonitorComponent(Context context,
                                 boolean estimateTimeLeft,
                                 boolean confirmBeforeCancel,
                                 int size,
                                 boolean undecorated)

Constructs a Swing Task Monitor component - clickable circular progress bar the component can be accessed with getComponent().

Parameters:

context - SciJava context

estimateTimeLeft - whether registered tasks should display an estimated remaining time

confirmBeforeCancel - flags whether a confirmation window should pop up when canceling a task, can be overridden with disableCancelConfirmation() and enableCancelConfirmation()

size - of the circular progress bar (preferred size)

undecorated - defines whether taskFrame is undecorated or not

Method Detail

getComponent

public JComponent getComponent()

Retrieves the global clickable progress bar that can be placed in the interface

Returns:

the component that needs to be placed in the interface to gives users a view to the current running tasks

enableCancelConfirmation

public void enableCancelConfirmation()

User confirmation required when canceling a task by clicking the task table.

disableCancelConfirmation

public void disableCancelConfirmation()

NO user confirmation required when canceling a task by clicking the task table.