Autopsy  4.18.0
Graphical digital forensics platform for The Sleuth Kit and other tools.
Public Member Functions | Private Member Functions | Private Attributes | List of all members
org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator Class Reference

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 40 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
parentThe parent frame.
titleThe title for the dialog.
buttonLabelsThe labels for the desired buttons.
focusedButtonLabelThe label of the button that should have initial focus.
buttonListenerAn ActionListener for the buttons.

Definition at line 64 of file ModalDialogProgressIndicator.java.

References 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
parentThe parent frame.
titleThe title for the dialog.

Definition at line 81 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 239 of file ModalDialogProgressIndicator.java.

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

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

Updates the progress indicator with a progress message.

Parameters
messageThe progress message.

Implements org.sleuthkit.autopsy.progress.ProgressIndicator.

Definition at line 183 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
workUnitsCompletedNumber of work units completed so far.

Implements org.sleuthkit.autopsy.progress.ProgressIndicator.

Definition at line 199 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
messageThe progress message.
workUnitsCompletedNumber of work units completed so far.

Implements org.sleuthkit.autopsy.progress.ProgressIndicator.

Definition at line 216 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

Implements org.sleuthkit.autopsy.progress.ProgressIndicator.

Definition at line 133 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 
)
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
messageThe initial progress message.

Implements org.sleuthkit.autopsy.progress.ProgressIndicator.

Definition at line 116 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
messageThe initial progress message.
workUnitsCompletedThe number of work units completed so far.
totalWorkUnitsThe total number of work units to be completed.

Implements org.sleuthkit.autopsy.progress.ProgressIndicator.

Definition at line 166 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
messageThe initial progress message.

Implements org.sleuthkit.autopsy.progress.ProgressIndicator.

Definition at line 148 of file ModalDialogProgressIndicator.java.

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

Member Data Documentation

final Object [] org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator.buttonLabels
private

Definition at line 45 of file ModalDialogProgressIndicator.java.

final ActionListener org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator.buttonListener
private
boolean org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator.cancelling
private
Dialog org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator.dialog
private

Definition at line 48 of file ModalDialogProgressIndicator.java.

final Object org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator.focusedButtonLabel
private
final Frame org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator.parent
private
final ProgressPanel org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator.progressPanel
private

Definition at line 44 of file ModalDialogProgressIndicator.java.

final String org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator.title
private

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

Copyright © 2012-2021 Basis Technology. Generated on: Thu Jul 8 2021
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.