org.sleuthkit.autopsy.datasourcesummary.uiutils.LoadableLabel Class Reference

Inherits org.sleuthkit.autopsy.datasourcesummary.uiutils.AbstractLoadableComponent< String >.

Public Member Functions
	LoadableLabel (String key)
void	showDataFetchResult (DataFetchResult< T > result, String errorMessage, String noResultsMessage)
void	showDataFetchResult (DataFetchResult< T > result)
void	showDefaultLoadingMessage ()
synchronized void	showMessage (String message)
synchronized void	showResults (T data)

Static Public Member Functions
static String	getDefaultErrorMessage ()
static String	getDefaultNoResultsMessage ()

Static Public Attributes
static final String	DEFAULT_ERROR_MESSAGE
static final String	DEFAULT_LOADING_MESSAGE
static final String	DEFAULT_NO_RESULTS_MESSAGE

Protected Member Functions
void	setMessage (boolean visible, String message)
void	setResults (String data)
abstract void	setResults (T data)

Private Member Functions
void	setValue (String value)

Private Attributes
final String	key
final JLabel	label = new JLabel()

Static Private Attributes
static final long	serialVersionUID = 1L

Detailed Description

A label that allows for displaying loading messages and can be used with a DataFetchResult. Text displays as "<key>:<value | message>".

Definition at line 29 of file LoadableLabel.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.datasourcesummary.uiutils.LoadableLabel.LoadableLabel

(

String

key

)

Main constructor for the label.

Parameters

key	The key to be displayed.

Definition at line 41 of file LoadableLabel.java.

References org.sleuthkit.autopsy.datasourcesummary.uiutils.LoadableLabel.key, and org.sleuthkit.autopsy.datasourcesummary.uiutils.AbstractLoadableComponent< String >.showResults().

Member Function Documentation

static String org.sleuthkit.autopsy.datasourcesummary.uiutils.AbstractLoadableComponent< T >.getDefaultErrorMessage ( )

staticinherited

Returns

The default error message.

Definition at line 58 of file AbstractLoadableComponent.java.

static String org.sleuthkit.autopsy.datasourcesummary.uiutils.AbstractLoadableComponent< T >.getDefaultNoResultsMessage ( )

staticinherited

Returns

The default message for no results.

Definition at line 65 of file AbstractLoadableComponent.java.

void org.sleuthkit.autopsy.datasourcesummary.uiutils.LoadableLabel.setMessage ( boolean  visible, String  message  )

protected

Definition at line 55 of file LoadableLabel.java.

References org.sleuthkit.autopsy.datasourcesummary.uiutils.LoadableLabel.setValue().

void org.sleuthkit.autopsy.datasourcesummary.uiutils.LoadableLabel.setResults ( String  data )

protected

Definition at line 60 of file LoadableLabel.java.

References org.sleuthkit.autopsy.datasourcesummary.uiutils.LoadableLabel.setValue().

abstract void org.sleuthkit.autopsy.datasourcesummary.uiutils.AbstractLoadableComponent< T >.setResults ( T  data )

abstractprotectedinherited

Sets the data to be shown in the JTable. Repaint does not need to be handled in this method.

Parameters

data	The list of data objects to be shown.

void org.sleuthkit.autopsy.datasourcesummary.uiutils.LoadableLabel.setValue ( String  value )

private

Definition at line 48 of file LoadableLabel.java.

References org.sleuthkit.autopsy.datasourcesummary.uiutils.LoadableLabel.key.

Referenced by org.sleuthkit.autopsy.datasourcesummary.uiutils.LoadableLabel.setMessage(), and org.sleuthkit.autopsy.datasourcesummary.uiutils.LoadableLabel.setResults().

void org.sleuthkit.autopsy.datasourcesummary.uiutils.AbstractLoadableComponent< T >.showDataFetchResult ( DataFetchResult< T >  result, String  errorMessage, String  noResultsMessage  )

inherited

Shows the data in a DataFetchResult. If there was an error during the operation, the errorMessage will be displayed. If the operation completed successfully and no data is present, noResultsMessage will be shown. Otherwise, the data will be shown as rows in the table.

Parameters

result	The DataFetchResult.
errorMessage	The error message to be shown in the event of an error.
noResultsMessage	The message to be shown if there are no results but the operation completed successfully.

Definition at line 114 of file AbstractLoadableComponent.java.

void org.sleuthkit.autopsy.datasourcesummary.uiutils.AbstractLoadableComponent< T >.showDataFetchResult ( DataFetchResult< T >  result )

inherited

Shows the data in a DataFetchResult. If there was an error during the operation, the DEFAULT_ERROR_MESSAGE will be displayed. If the operation completed successfully and no data is present, DEFAULT_NO_RESULTS_MESSAGE will be shown. Otherwise, the data will be shown as rows in the table.

Parameters

result

The DataFetchResult.

Definition at line 150 of file AbstractLoadableComponent.java.

void org.sleuthkit.autopsy.datasourcesummary.uiutils.AbstractLoadableComponent< T >.showDefaultLoadingMessage ( )

inherited

Shows a default loading message on the table. This will clear any results in the table.

Definition at line 85 of file AbstractLoadableComponent.java.

synchronized void org.sleuthkit.autopsy.datasourcesummary.uiutils.AbstractLoadableComponent< T >.showMessage ( String  message )

inherited

Clears the results from the underlying JTable and shows the provided message.

Parameters

message

The message to be shown.

Definition at line 75 of file AbstractLoadableComponent.java.

synchronized void org.sleuthkit.autopsy.datasourcesummary.uiutils.AbstractLoadableComponent< T >.showResults ( T  data )

inherited

Shows the list as rows of data in the table. If overlay message will be cleared if present.

Parameters

data	The data to be shown where each item represents a row of data.

Definition at line 96 of file AbstractLoadableComponent.java.

Referenced by org.sleuthkit.autopsy.datasourcesummary.uiutils.LoadableLabel::LoadableLabel().

Member Data Documentation

final String org.sleuthkit.autopsy.datasourcesummary.uiutils.AbstractLoadableComponent< T >.DEFAULT_ERROR_MESSAGE

staticinherited

The default error message.

Definition at line 46 of file AbstractLoadableComponent.java.

final String org.sleuthkit.autopsy.datasourcesummary.uiutils.AbstractLoadableComponent< T >.DEFAULT_LOADING_MESSAGE

staticinherited

The default loading message.

Definition at line 41 of file AbstractLoadableComponent.java.

final String org.sleuthkit.autopsy.datasourcesummary.uiutils.AbstractLoadableComponent< T >.DEFAULT_NO_RESULTS_MESSAGE

staticinherited

The default 'no results' message.

Definition at line 51 of file AbstractLoadableComponent.java.

final String org.sleuthkit.autopsy.datasourcesummary.uiutils.LoadableLabel.key

private

Definition at line 34 of file LoadableLabel.java.

Referenced by org.sleuthkit.autopsy.datasourcesummary.uiutils.LoadableLabel.LoadableLabel(), and org.sleuthkit.autopsy.datasourcesummary.uiutils.LoadableLabel.setValue().

final JLabel org.sleuthkit.autopsy.datasourcesummary.uiutils.LoadableLabel.label = new JLabel()

private

Definition at line 33 of file LoadableLabel.java.

final long org.sleuthkit.autopsy.datasourcesummary.uiutils.LoadableLabel.serialVersionUID = 1L

staticprivate

Definition at line 31 of file LoadableLabel.java.

---

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

• /home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/datasourcesummary/uiutils/LoadableLabel.java