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

Inherits org.sleuthkit.autopsy.progress.ProgressIndicator.

Public Member Functions

 AppFrameProgressBar (String displayName)
 
void finish ()
 
void progress (String message)
 
void progress (int workUnitsCompleted)
 
void progress (String message, int workUnitsCompleted)
 
void setCancellationBehavior (Cancellable cancellationBehavior)
 
void setCancelling (String cancellingMessage)
 
void start (String message, int totalWorkUnits)
 
void start (String message)
 
void switchToDeterminate (String message, int workUnitsCompleted, int totalWorkUnits)
 
void switchToIndeterminate (String message)
 

Private Attributes

Cancellable cancellationBehavior
 
volatile boolean cancelling
 
final String displayName
 
ProgressHandle progressHandle
 

Detailed Description

A progress indicator that displays progress using a progress bar in the lower right hand corner of the application main frame, i.e., a NetBeans ProgressHandle.

Definition at line 29 of file AppFrameProgressBar.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.progress.AppFrameProgressBar.AppFrameProgressBar ( String  displayName)

Constructs a progress indicator that displays progress using a progress bar in the lower right hand corner of the application main frame, i.e., a NetBeans ProgressHandle.

Parameters
displayNameThe display name for the progress bar (a fixed name that appears above the current progress message).

Definition at line 44 of file AppFrameProgressBar.java.

References org.sleuthkit.autopsy.progress.AppFrameProgressBar.displayName.

Member Function Documentation

void org.sleuthkit.autopsy.progress.AppFrameProgressBar.finish ( )

Finishes the progress indicator when the task is completed.

Implements org.sleuthkit.autopsy.progress.ProgressIndicator.

Definition at line 120 of file AppFrameProgressBar.java.

void org.sleuthkit.autopsy.progress.AppFrameProgressBar.progress ( String  message)

Updates the progress indicator with a progress message.

Parameters
messageThe progress message.

Implements org.sleuthkit.autopsy.progress.ProgressIndicator.

Definition at line 92 of file AppFrameProgressBar.java.

void org.sleuthkit.autopsy.progress.AppFrameProgressBar.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 99 of file AppFrameProgressBar.java.

void org.sleuthkit.autopsy.progress.AppFrameProgressBar.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 106 of file AppFrameProgressBar.java.

void org.sleuthkit.autopsy.progress.AppFrameProgressBar.setCancellationBehavior ( Cancellable  cancellationBehavior)

Sets the cancellation behavior that should happen when a user clicks on the "x" button of the progress bar.

Parameters
cancellationBehaviorA org.openide.util.Cancellable that implements the desired cancellation behavior.

Definition at line 55 of file AppFrameProgressBar.java.

References org.sleuthkit.autopsy.progress.AppFrameProgressBar.cancellationBehavior.

void org.sleuthkit.autopsy.progress.AppFrameProgressBar.setCancelling ( String  cancellingMessage)

If the progress indicator supports cancelling the underlying task, sets a cancelling message and causes the progress indicator to no longer accept updates unless start is called again.

The default implementation assumes that cancelling the underlying task is not supported.

Parameters
cancellingMessageThe cancelling messages.

Implements org.sleuthkit.autopsy.progress.ProgressIndicator.

Definition at line 113 of file AppFrameProgressBar.java.

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

Definition at line 60 of file AppFrameProgressBar.java.

void org.sleuthkit.autopsy.progress.AppFrameProgressBar.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 68 of file AppFrameProgressBar.java.

void org.sleuthkit.autopsy.progress.AppFrameProgressBar.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 84 of file AppFrameProgressBar.java.

void org.sleuthkit.autopsy.progress.AppFrameProgressBar.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 76 of file AppFrameProgressBar.java.

Member Data Documentation

Cancellable org.sleuthkit.autopsy.progress.AppFrameProgressBar.cancellationBehavior
private
volatile boolean org.sleuthkit.autopsy.progress.AppFrameProgressBar.cancelling
private

Definition at line 34 of file AppFrameProgressBar.java.

final String org.sleuthkit.autopsy.progress.AppFrameProgressBar.displayName
private
ProgressHandle org.sleuthkit.autopsy.progress.AppFrameProgressBar.progressHandle
private

Definition at line 33 of file AppFrameProgressBar.java.


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.