Inherits JPanel.

Classes
enum	ReportStatus

Public Member Functions
	ReportProgressPanel (String reportName, String reportPath)

ReportStatus	getStatus ()

void	start ()

void	setMaximumProgress (final int max)

void	increment ()

void	setProgress (final int value)

void	setIndeterminate (final boolean indeterminate)

void	updateStatusLabel (final String status)

void	complete ()

void	complete (ReportStatus reportStatus)

Private Member Functions
void	customInit (String reportName, String reportPath)

String	shortenPath (String path)

void	initComponents ()

Private Attributes
ReportStatus	STATUS

javax.swing.JLabel	pathLabel

javax.swing.JLabel	processingLabel

javax.swing.JLabel	reportLabel

javax.swing.JProgressBar	reportProgressBar

javax.swing.JLabel	separationLabel

Static Private Attributes
static final Logger	logger = Logger.getLogger(ReportProgressPanel.class.getName())

Detailed Description

Definition at line 31 of file ReportProgressPanel.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.report.ReportProgressPanel.ReportProgressPanel	(	String	reportName,
		String	reportPath
	)

Creates new form ReportProgressPanel

Definition at line 48 of file ReportProgressPanel.java.

References org.sleuthkit.autopsy.report.ReportProgressPanel.customInit(), and org.sleuthkit.autopsy.report.ReportProgressPanel.initComponents().

Member Function Documentation

void org.sleuthkit.autopsy.report.ReportProgressPanel.complete ( )

Declare the report completed. This will fill the JProgressBar, update the cancelButton to completed, and disallow any cancellation of this report.

Deprecated:: Use complete(ReportStatus)

Definition at line 235 of file ReportProgressPanel.java.

References org.sleuthkit.autopsy.report.ReportProgressPanel.ReportStatus.COMPLETE.

Referenced by org.sleuthkit.autopsy.modules.stix.STIXReportModule.generateReport().

void org.sleuthkit.autopsy.report.ReportProgressPanel.complete ( ReportStatus reportStatus )

Declare the report completed ands sets if completed successfully or with errors. This will fill the JProgressBar, update the cancelButton to completed, and disallow any cancellation of this report.

Parameters

reportStatus set to appropriate ResultStatus enum.

Definition at line 244 of file ReportProgressPanel.java.

References org.sleuthkit.autopsy.report.ReportProgressPanel.ReportStatus.CANCELED, org.sleuthkit.autopsy.report.ReportProgressPanel.ReportStatus.COMPLETE, org.sleuthkit.autopsy.report.ReportProgressPanel.ReportStatus.ERROR, org.sleuthkit.autopsy.report.ReportProgressPanel.processingLabel, and org.sleuthkit.autopsy.report.ReportProgressPanel.reportProgressBar.

void org.sleuthkit.autopsy.report.ReportProgressPanel.customInit	(	String	reportName,
		String	reportPath
	)

private

Definition at line 53 of file ReportProgressPanel.java.

References org.sleuthkit.autopsy.report.ReportProgressPanel.pathLabel, org.sleuthkit.autopsy.report.ReportProgressPanel.processingLabel, org.sleuthkit.autopsy.report.ReportProgressPanel.ReportStatus.QUEUING, org.sleuthkit.autopsy.report.ReportProgressPanel.reportLabel, org.sleuthkit.autopsy.report.ReportProgressPanel.reportProgressBar, and org.sleuthkit.autopsy.report.ReportProgressPanel.shortenPath().

Referenced by org.sleuthkit.autopsy.report.ReportProgressPanel.ReportProgressPanel().

ReportStatus org.sleuthkit.autopsy.report.ReportProgressPanel.getStatus ( )

Return the current ReportStatus of this report.

Returns: ReportStatus status of this report

Definition at line 127 of file ReportProgressPanel.java.

References org.sleuthkit.autopsy.report.ReportProgressPanel.STATUS.

Referenced by org.sleuthkit.autopsy.report.ReportGenerator.FileReportsWorker.doInBackground(), and org.sleuthkit.autopsy.report.ReportGenerator.TableReportsWorker.doInBackground().

void org.sleuthkit.autopsy.report.ReportProgressPanel.increment ( )

Increment the JProgressBar for this report by one unit.

Definition at line 166 of file ReportProgressPanel.java.

References org.sleuthkit.autopsy.report.ReportProgressPanel.ReportStatus.CANCELED, and org.sleuthkit.autopsy.report.ReportProgressPanel.reportProgressBar.

Referenced by org.sleuthkit.autopsy.report.ReportGenerator.FileReportsWorker.doInBackground().

void org.sleuthkit.autopsy.report.ReportProgressPanel.initComponents ( )

private

This method is called from within the constructor to initialize the form. WARNING: Do NOT modify this code. The content of this method is always regenerated by the Form Editor.

Definition at line 292 of file ReportProgressPanel.java.

References org.sleuthkit.autopsy.report.ReportProgressPanel.pathLabel, org.sleuthkit.autopsy.report.ReportProgressPanel.processingLabel, org.sleuthkit.autopsy.report.ReportProgressPanel.reportLabel, org.sleuthkit.autopsy.report.ReportProgressPanel.reportProgressBar, and org.sleuthkit.autopsy.report.ReportProgressPanel.separationLabel.

Referenced by org.sleuthkit.autopsy.report.ReportProgressPanel.ReportProgressPanel().

void org.sleuthkit.autopsy.report.ReportProgressPanel.setIndeterminate ( final boolean indeterminate )

Changes the status of the JProgressBar to be determinate or indeterminate.

Parameters

indeterminate sets the JProgressBar to be indeterminate if true, determinate otherwise

Definition at line 198 of file ReportProgressPanel.java.

References org.sleuthkit.autopsy.report.ReportProgressPanel.ReportStatus.CANCELED, and org.sleuthkit.autopsy.report.ReportProgressPanel.reportProgressBar.

Referenced by org.sleuthkit.autopsy.report.ReportGenerator.TableReportsWorker.doInBackground(), and org.sleuthkit.autopsy.modules.stix.STIXReportModule.generateReport().

void org.sleuthkit.autopsy.report.ReportProgressPanel.setMaximumProgress ( final int max )

Set the maximum progress for this report's JProgressBar.

Parameters

max	maximum progress for JProgressBar

Definition at line 152 of file ReportProgressPanel.java.

References org.sleuthkit.autopsy.report.ReportProgressPanel.ReportStatus.CANCELED, and org.sleuthkit.autopsy.report.ReportProgressPanel.reportProgressBar.

Referenced by org.sleuthkit.autopsy.report.ReportGenerator.TableReportsWorker.doInBackground(), and org.sleuthkit.autopsy.modules.stix.STIXReportModule.generateReport().

void org.sleuthkit.autopsy.report.ReportProgressPanel.setProgress ( final int value )

Set the value of the JProgressBar for this report.

Parameters

value value to be set at

Definition at line 182 of file ReportProgressPanel.java.

References org.sleuthkit.autopsy.report.ReportProgressPanel.ReportStatus.CANCELED, and org.sleuthkit.autopsy.report.ReportProgressPanel.reportProgressBar.

String org.sleuthkit.autopsy.report.ReportProgressPanel.shortenPath ( String path )

private

Return a shortened version of the given path.

Definition at line 114 of file ReportProgressPanel.java.

Referenced by org.sleuthkit.autopsy.report.ReportProgressPanel.customInit().

void org.sleuthkit.autopsy.report.ReportProgressPanel.start ( )

Start the JProgressBar for this report.

Enables the cancelButton, updates the processingLabel, and changes this report's ReportStatus.

Definition at line 137 of file ReportProgressPanel.java.

References org.sleuthkit.autopsy.report.ReportProgressPanel.processingLabel, and org.sleuthkit.autopsy.report.ReportProgressPanel.ReportStatus.RUNNING.

Referenced by org.sleuthkit.autopsy.report.ReportGenerator.FileReportsWorker.doInBackground(), org.sleuthkit.autopsy.report.ReportGenerator.TableReportsWorker.doInBackground(), and org.sleuthkit.autopsy.modules.stix.STIXReportModule.generateReport().

void org.sleuthkit.autopsy.report.ReportProgressPanel.updateStatusLabel ( final String status )

Change the text of this report's status label. The text given will be the full text used. e.g. updateStatusLabel("Now processing files...") sets the label to "Now processing files..."

Parameters

status String to use as status

Definition at line 217 of file ReportProgressPanel.java.

References org.sleuthkit.autopsy.report.ReportProgressPanel.ReportStatus.CANCELED, and org.sleuthkit.autopsy.report.ReportProgressPanel.processingLabel.

Referenced by org.sleuthkit.autopsy.report.ReportGenerator.FileReportsWorker.doInBackground(), and org.sleuthkit.autopsy.modules.stix.STIXReportModule.generateReport().