Autopsy  4.1
Graphical digital forensics platform for The Sleuth Kit and other tools.
Public Member Functions | Private Attributes | List of all members
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
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 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
parentThe parent frame.
titleThe 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
messageThe 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
messageThe 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
workUnitsCompletedNumber 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
messageThe progress message.
workUnitsCompletedNumber 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
isVisibleTrue 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
messageThe initial progress message.
totalWorkUnitsThe 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
messageThe 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
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.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
messageThe 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
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
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:

Copyright © 2012-2016 Basis Technology. Generated on: Mon Apr 24 2017
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.