org.sleuthkit.autopsy.framework.ModalDialogProgressIndicator Class Reference

Inherits org.sleuthkit.autopsy.framework.ProgressIndicator.

Public Member Functions
	ModalDialogProgressIndicator (Frame parent, String title, Object[] buttonLabels, Object focusedButtonLabel, ActionListener buttonListener)
	ModalDialogProgressIndicator (Frame parent, String title)
void	finish (String message)
ActionListener	getButtonListener ()
void	progress (String message)
void	progress (int workUnitsCompleted)
void	progress (String message, int workUnitsCompleted)
void	setVisible (boolean isVisible)
void	start (String message, int totalWorkUnits)
void	start (String message)
void	switchToDeterminate (String message, int workUnitsCompleted, int totalWorkUnits)
void	switchToIndeterminate (String message)

Private Attributes
final ActionListener	buttonListener
final Dialog	dialog
final Frame	parent
final ProgressPanel	progressPanel

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.

Definition at line 35 of file ModalDialogProgressIndicator.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.framework.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 54 of file ModalDialogProgressIndicator.java.

References org.sleuthkit.autopsy.framework.ModalDialogProgressIndicator.buttonListener, and org.sleuthkit.autopsy.framework.ModalDialogProgressIndicator.parent.

org.sleuthkit.autopsy.framework.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 77 of file ModalDialogProgressIndicator.java.

References org.sleuthkit.autopsy.framework.ModalDialogProgressIndicator.parent.

Member Function Documentation

void org.sleuthkit.autopsy.framework.ModalDialogProgressIndicator.finish

(

String

message

)

Finishes the progress indicator when the task is completed.

Parameters

message

The finished message.

Implements org.sleuthkit.autopsy.framework.ProgressIndicator.

Definition at line 238 of file ModalDialogProgressIndicator.java.

ActionListener org.sleuthkit.autopsy.framework.ModalDialogProgressIndicator.getButtonListener

(

)

Gets the button listener for the dialog, if there is one.

Returns

The button listener or null.

Definition at line 103 of file ModalDialogProgressIndicator.java.

References org.sleuthkit.autopsy.framework.ModalDialogProgressIndicator.buttonListener.

void org.sleuthkit.autopsy.framework.ModalDialogProgressIndicator.progress

(

String

message

)

Updates the progress indicator with a progress message.

Parameters

message

The progress message.

Implements org.sleuthkit.autopsy.framework.ProgressIndicator.

Definition at line 187 of file ModalDialogProgressIndicator.java.

void org.sleuthkit.autopsy.framework.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.framework.ProgressIndicator.

Definition at line 204 of file ModalDialogProgressIndicator.java.

void org.sleuthkit.autopsy.framework.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.framework.ProgressIndicator.

Definition at line 222 of file ModalDialogProgressIndicator.java.

void org.sleuthkit.autopsy.framework.ModalDialogProgressIndicator.setVisible

(

boolean

isVisible

)

Calls setVisible on the underlying modal dialog.

Parameters

isVisible

True or false.

Definition at line 91 of file ModalDialogProgressIndicator.java.

void org.sleuthkit.autopsy.framework.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.framework.ProgressIndicator.

Definition at line 115 of file ModalDialogProgressIndicator.java.

void org.sleuthkit.autopsy.framework.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.framework.ProgressIndicator.

Definition at line 133 of file ModalDialogProgressIndicator.java.

void org.sleuthkit.autopsy.framework.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.framework.ProgressIndicator.

Definition at line 169 of file ModalDialogProgressIndicator.java.

void org.sleuthkit.autopsy.framework.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.framework.ProgressIndicator.

Definition at line 150 of file ModalDialogProgressIndicator.java.

Member Data Documentation

final ActionListener org.sleuthkit.autopsy.framework.ModalDialogProgressIndicator.buttonListener

private

Definition at line 40 of file ModalDialogProgressIndicator.java.

Referenced by org.sleuthkit.autopsy.framework.ModalDialogProgressIndicator.getButtonListener(), and org.sleuthkit.autopsy.framework.ModalDialogProgressIndicator.ModalDialogProgressIndicator().

final Dialog org.sleuthkit.autopsy.framework.ModalDialogProgressIndicator.dialog

private

Definition at line 39 of file ModalDialogProgressIndicator.java.

final Frame org.sleuthkit.autopsy.framework.ModalDialogProgressIndicator.parent

private

Definition at line 37 of file ModalDialogProgressIndicator.java.

Referenced by org.sleuthkit.autopsy.framework.ModalDialogProgressIndicator.ModalDialogProgressIndicator().

final ProgressPanel org.sleuthkit.autopsy.framework.ModalDialogProgressIndicator.progressPanel

private

Definition at line 38 of file ModalDialogProgressIndicator.java.

---

The documentation for this class was generated from the following file:

• /home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/framework/ModalDialogProgressIndicator.java