org.sleuthkit.autopsy.report.ReportProgressPanel Class Reference

Inherits JPanel.

Classes
enum	ReportStatus

Public Member Functions
	ReportProgressPanel (String reportName, String reportPath)
void	addPropertyChangeListener (PropertyChangeListener listener)
void	complete (ReportStatus reportStatus)
void	complete ()
ReportStatus	getStatus ()
void	increment ()
void	removePropertyChangeListener (PropertyChangeListener listener)
void	setIndeterminate (boolean indeterminate)
void	setMaximumProgress (int max)
void	setProgress (int value)
void	start ()
void	updateStatusLabel (String statusMessage)

Private Member Functions
void	initComponents ()
String	shortenPath (String path)

Private Attributes
javax.swing.JLabel	pathLabel
final PropertyChangeSupport	pcs = new PropertyChangeSupport(this)
javax.swing.JLabel	reportLabel
javax.swing.JProgressBar	reportProgressBar
javax.swing.JLabel	separationLabel
ReportStatus	status
javax.swing.JLabel	statusMessageLabel

Static Private Attributes
static final Color	GREEN = new Color(50, 205, 50)
static final Logger	logger = Logger.getLogger(ReportProgressPanel.class.getName())
static final Color	RED = new Color(178, 34, 34)
static final long	serialVersionUID = 1L

Detailed Description

A panel used by a report generation module to show progress.

Definition at line 35 of file ReportProgressPanel.java.

Constructor & Destructor Documentation

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

Constructs a panel used by report generation module to show progress.

Parameters

reportName	The name of the report being generated.
reportPath	The path to the report file.

Definition at line 63 of file ReportProgressPanel.java.

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

Member Function Documentation

void org.sleuthkit.autopsy.report.ReportProgressPanel.addPropertyChangeListener

(

PropertyChangeListener

listener

)

Adds a property change listener to this panel.

Parameters

listener

The listener to be added.

Definition at line 124 of file ReportProgressPanel.java.

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

(

ReportStatus

reportStatus

)

Makes the components of this panel indicate the final status of generation of the report.

Parameters

reportStatus

The final status, must be COMPLETE or ERROR.

Definition at line 231 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.reportProgressBar, org.sleuthkit.autopsy.report.ReportProgressPanel.status, and org.sleuthkit.autopsy.report.ReportProgressPanel.statusMessageLabel.

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

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

(

)

Makes the components of this panel indicate the generation of the report is completed.

Deprecated:

Use complete(ReportStatus)

Definition at line 392 of file ReportProgressPanel.java.

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

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

(

)

Gets the current status of the generation of the report.

Returns

The report generation status as a ReportStatus enum.

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

(

)

Increments the current value of the progress bar component of this panel by one unit.

Definition at line 174 of file ReportProgressPanel.java.

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

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 318 of file ReportProgressPanel.java.

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

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

void org.sleuthkit.autopsy.report.ReportProgressPanel.removePropertyChangeListener

(

PropertyChangeListener

listener

)

Removes a property change listener from this panel.

Parameters

listener

The listener to be removed.

Definition at line 134 of file ReportProgressPanel.java.

void org.sleuthkit.autopsy.report.ReportProgressPanel.setIndeterminate

(

boolean

indeterminate

)

Changes the the progress bar component of this panel to be determinate or indeterminate.

Parameters

indeterminate

True if the progress bar should be set to indeterminate.

Definition at line 202 of file ReportProgressPanel.java.

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

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

void org.sleuthkit.autopsy.report.ReportProgressPanel.setMaximumProgress

(

int

max

)

Sets the maximum value of the progress bar component of this panel.

Parameters

max	The maximum value.

Definition at line 162 of file ReportProgressPanel.java.

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

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

void org.sleuthkit.autopsy.report.ReportProgressPanel.setProgress

(

int

value

)

Sets the current value of the progress bar component of this panel.

Parameters

value

The value to be set.

Definition at line 187 of file ReportProgressPanel.java.

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

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

private

Gets a shortened version of a file path.

Parameters

path	The path to shorten.

Returns

The shortened path.

Definition at line 302 of file ReportProgressPanel.java.

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

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

(

)

Starts the progress bar component of this panel.

Definition at line 150 of file ReportProgressPanel.java.

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

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

(

String

statusMessage

)

Changes the status message label component of this panel to show a given processing status message. For example, updateStatusLabel("Now processing files...") sets the label text to "Now processing files..."

Parameters

statusMessage

String to use as label text.

Definition at line 217 of file ReportProgressPanel.java.

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

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

Member Data Documentation

final Color org.sleuthkit.autopsy.report.ReportProgressPanel.GREEN = new Color(50, 205, 50)

staticprivate

Definition at line 39 of file ReportProgressPanel.java.

final Logger org.sleuthkit.autopsy.report.ReportProgressPanel.logger = Logger.getLogger(ReportProgressPanel.class.getName())

staticprivate

Definition at line 38 of file ReportProgressPanel.java.

javax.swing.JLabel org.sleuthkit.autopsy.report.ReportProgressPanel.pathLabel

private

Definition at line 378 of file ReportProgressPanel.java.

Referenced by org.sleuthkit.autopsy.report.ReportProgressPanel.initComponents(), and org.sleuthkit.autopsy.report.ReportProgressPanel.ReportProgressPanel().

final PropertyChangeSupport org.sleuthkit.autopsy.report.ReportProgressPanel.pcs = new PropertyChangeSupport(this)

private

Definition at line 41 of file ReportProgressPanel.java.

final Color org.sleuthkit.autopsy.report.ReportProgressPanel.RED = new Color(178, 34, 34)

staticprivate

Definition at line 40 of file ReportProgressPanel.java.

javax.swing.JLabel org.sleuthkit.autopsy.report.ReportProgressPanel.reportLabel

private

Definition at line 379 of file ReportProgressPanel.java.

Referenced by org.sleuthkit.autopsy.report.ReportProgressPanel.initComponents(), and org.sleuthkit.autopsy.report.ReportProgressPanel.ReportProgressPanel().

javax.swing.JProgressBar org.sleuthkit.autopsy.report.ReportProgressPanel.reportProgressBar

private

Definition at line 380 of file ReportProgressPanel.java.

Referenced by org.sleuthkit.autopsy.report.ReportProgressPanel.complete(), org.sleuthkit.autopsy.report.ReportProgressPanel.initComponents(), and org.sleuthkit.autopsy.report.ReportProgressPanel.ReportProgressPanel().

javax.swing.JLabel org.sleuthkit.autopsy.report.ReportProgressPanel.separationLabel

private

Definition at line 381 of file ReportProgressPanel.java.

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

final long org.sleuthkit.autopsy.report.ReportProgressPanel.serialVersionUID = 1L

staticprivate

Definition at line 37 of file ReportProgressPanel.java.

ReportStatus org.sleuthkit.autopsy.report.ReportProgressPanel.status

private

Definition at line 42 of file ReportProgressPanel.java.

Referenced by org.sleuthkit.autopsy.report.ReportProgressPanel.complete(), and org.sleuthkit.autopsy.report.ReportProgressPanel.getStatus().

javax.swing.JLabel org.sleuthkit.autopsy.report.ReportProgressPanel.statusMessageLabel

private

Definition at line 382 of file ReportProgressPanel.java.

Referenced by org.sleuthkit.autopsy.report.ReportProgressPanel.complete(), org.sleuthkit.autopsy.report.ReportProgressPanel.initComponents(), org.sleuthkit.autopsy.report.ReportProgressPanel.ReportProgressPanel(), and org.sleuthkit.autopsy.report.ReportProgressPanel.start().

---

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

• /home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/report/ReportProgressPanel.java