Inherits org.sleuthkit.autopsy.progress.ProgressIndicator.

Public Member Functions
	ModalDialogProgressIndicator (Frame parent, String title, Object[] buttonLabels, Object focusedButtonLabel, ActionListener buttonListener)

	ModalDialogProgressIndicator (Frame parent, String title)

synchronized void	finish ()

synchronized void	progress (String message)

synchronized void	progress (int workUnitsCompleted)

synchronized void	progress (String message, int workUnitsCompleted)

synchronized void	setCancelling (String cancellingMessage)

synchronized void	start (String message, int totalWorkUnits)

synchronized void	start (String message)

synchronized void	switchToDeterminate (String message, int workUnitsCompleted, int totalWorkUnits)

synchronized void	switchToIndeterminate (String message)

Private Member Functions
void	displayDialog ()

Private Attributes
final Object[]	buttonLabels

final ActionListener	buttonListener

boolean	cancelling

Dialog	dialog

final Object	focusedButtonLabel

final Frame	parent

final ProgressPanel	progressPanel

final String	title

Detailed Description

A progress indicator that displays progress using a modal dialog with a message label, a progress bar, and optionally, a configurable set of buttons with a button listener. Setting a cancelling flag which locks in a cancelling message and an indeterminate progress bar is supported.

Definition at line 39 of file ModalDialogProgressIndicator.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator.ModalDialogProgressIndicator	(	Frame	parent,
		String	title,
		Object[]	buttonLabels,
		Object	focusedButtonLabel,
		ActionListener	buttonListener
	)

Creates a progress indicator that displays progress using a modal dialog with a message label, a progress bar with a configurable set of buttons with a button listener.

Parameters

parent	The parent frame.
title	The title for the dialog.
buttonLabels	The labels for the desired buttons.
focusedButtonLabel	The label of the button that should have initial focus.
buttonListener	An ActionListener for the buttons.

Definition at line 63 of file ModalDialogProgressIndicator.java.

References org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator.buttonLabels, org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator.buttonListener, org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator.focusedButtonLabel, org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator.parent, and org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator.title.

org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator.ModalDialogProgressIndicator	(	Frame	parent,
		String	title
	)

Creates a progress indicator that displays progress using a modal dialog with a message label and a progress bar with no buttons.

Parameters

parent	The parent frame.
title	The title for the dialog.

Definition at line 80 of file ModalDialogProgressIndicator.java.

References org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator.parent, and org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator.title.

Member Function Documentation

void org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator.displayDialog ( )

private

Creates and dislpays the dialog for the progress indicator.

Definition at line 237 of file ModalDialogProgressIndicator.java.

Referenced by org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator.start().

synchronized void org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator.finish ( )

Finishes the progress indicator when the task is completed.

Implements org.sleuthkit.autopsy.progress.ProgressIndicator.

Definition at line 227 of file ModalDialogProgressIndicator.java.

Referenced by org.sleuthkit.autopsy.communications.VisualizationPanel.CancelationListener.actionPerformed(), org.sleuthkit.autopsy.communications.VisualizationPanel.applyLayout(), org.sleuthkit.autopsy.modules.embeddedfileextractor.ExtractArchiveWithPasswordAction.ExtractAndIngestWorker.doInBackground(), and org.sleuthkit.autopsy.livetriage.CreateLiveTriageDriveAction.propertyChange().

synchronized void org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator.progress ( String message )

Updates the progress indicator with a progress message.

Parameters

message The progress message.

Implements org.sleuthkit.autopsy.progress.ProgressIndicator.

Definition at line 181 of file ModalDialogProgressIndicator.java.

References org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator.cancelling.

synchronized void org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator.progress ( int workUnitsCompleted )

Updates the progress indicator with the number of work units completed so far when in determinate mode (the total number of work units to be completed is known).

Parameters

workUnitsCompleted Number of work units completed so far.

Implements org.sleuthkit.autopsy.progress.ProgressIndicator.

Definition at line 197 of file ModalDialogProgressIndicator.java.

References org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator.cancelling.

synchronized void org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator.progress	(	String	message,
		int	workUnitsCompleted
	)

Updates the progress indicator with a progress message and the number of work units completed so far when in determinate mode (the total number of work units to be completed is known).

Parameters

message	The progress message.
workUnitsCompleted	Number of work units completed so far.

Implements org.sleuthkit.autopsy.progress.ProgressIndicator.

Definition at line 214 of file ModalDialogProgressIndicator.java.

References org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator.cancelling.

synchronized void org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator.setCancelling ( String cancellingMessage )

Sets a cancelling message and makes the progress bar indeterminate. Once cancel has been called, the progress indicator no longer accepts updates unless start is called again.

Parameters

cancellingMessage

Definition at line 131 of file ModalDialogProgressIndicator.java.

References org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator.cancelling.

Referenced by org.sleuthkit.autopsy.communications.VisualizationPanel.CancelationListener.actionPerformed().

synchronized void org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator.start	(	String	message,
		int	totalWorkUnits
	)

Starts the progress indicator in determinate mode (the total number of work units to be completed is known).

Parameters

message	The initial progress message.
totalWorkUnits	The total number of work units.

Implements org.sleuthkit.autopsy.progress.ProgressIndicator.

Definition at line 98 of file ModalDialogProgressIndicator.java.

References org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator.cancelling, and org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator.displayDialog().

Referenced by org.sleuthkit.autopsy.communications.VisualizationPanel.applyLayout(), org.sleuthkit.autopsy.modules.embeddedfileextractor.ExtractArchiveWithPasswordAction.ExtractAndIngestWorker.doInBackground(), and org.sleuthkit.autopsy.livetriage.CreateLiveTriageDriveAction.propertyChange().

synchronized void org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator.start ( String message )

Starts the progress indicator in indeterminate mode (the total number of work units to be completed is unknown).

Parameters

message The initial progress message.

Implements org.sleuthkit.autopsy.progress.ProgressIndicator.

Definition at line 115 of file ModalDialogProgressIndicator.java.

References org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator.cancelling, and org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator.displayDialog().

synchronized void org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator.switchToDeterminate	(	String	message,
		int	workUnitsCompleted,
		int	totalWorkUnits
	)

Switches the progress indicator to determinate mode (the total number of work units to be completed is known).

Parameters

message	The initial progress message.
workUnitsCompleted	The number of work units completed so far.
totalWorkUnits	The total number of work units to be completed.

Implements org.sleuthkit.autopsy.progress.ProgressIndicator.

Definition at line 164 of file ModalDialogProgressIndicator.java.

References org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator.cancelling.

synchronized void org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator.switchToIndeterminate ( String message )

Switches the progress indicator to indeterminate mode (the total number of work units to be completed is unknown).

Parameters

message The initial progress message.

Implements org.sleuthkit.autopsy.progress.ProgressIndicator.

Definition at line 146 of file ModalDialogProgressIndicator.java.

References org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator.cancelling.