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

Inherits org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.

Public Member Functions

 TextContentViewer ()
 
DataContentViewer createInstance ()
 
Component getComponent ()
 
default String getTitle (Node node)
 
String getTitle ()
 
String getToolTip ()
 
int isPreferred (Node node)
 
boolean isSupported (Node node)
 
void resetComponent ()
 
void setNode (Node selectedNode)
 

Private Member Functions

 TextContentViewer (boolean isMain)
 

Private Attributes

volatile Node currentNode = null
 
final TextContentViewerPanel panel
 

Detailed Description

A DataContentViewer that displays text with the TextViewers available.

Definition at line 32 of file TextContentViewer.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.contentviewers.textcontentviewer.TextContentViewer.TextContentViewer ( )

No arg constructor for creating the main instance of this Content Viewer.

Definition at line 40 of file TextContentViewer.java.

org.sleuthkit.autopsy.contentviewers.textcontentviewer.TextContentViewer.TextContentViewer ( boolean  isMain)
private

Private constructor for creating instances of this content viewer.

Parameters
isMain

Definition at line 49 of file TextContentViewer.java.

Member Function Documentation

DataContentViewer org.sleuthkit.autopsy.contentviewers.textcontentviewer.TextContentViewer.createInstance ( )

Create and return a new instance of your viewer. The reason that this is needed is because the specific viewer modules will be found via NetBeans Lookup and the type will only be DataContentViewer. This method is used to get an instance of your specific type.

Returns
A new instance of the viewer

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.

Definition at line 73 of file TextContentViewer.java.

Component org.sleuthkit.autopsy.contentviewers.textcontentviewer.TextContentViewer.getComponent ( )

Return the Swing Component to display. Implementations of this method that extend JPanel and do a 'return this;'. Otherwise return an internal instance of the JPanel.

Returns
the component which is displayed for this viewer

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.

Definition at line 78 of file TextContentViewer.java.

default String org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.getTitle ( Node  node)
inherited

Returns the title of this viewer to display in the tab.

Parameters
nodeThe node to be viewed in the DataContentViewer.
Returns
the title of DataContentViewer.

Implemented in org.sleuthkit.autopsy.contentviewers.Metadata.

Definition at line 61 of file DataContentViewer.java.

References org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.getTitle().

String org.sleuthkit.autopsy.contentviewers.textcontentviewer.TextContentViewer.getTitle ( )

Returns the title of this viewer to display in the tab.

Returns
the title of DataContentViewer

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.

Definition at line 62 of file TextContentViewer.java.

String org.sleuthkit.autopsy.contentviewers.textcontentviewer.TextContentViewer.getToolTip ( )

Returns a short description of this viewer to use as a tool tip for its tab.

Returns
the tooltip for this TextViewer

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.

Definition at line 68 of file TextContentViewer.java.

int org.sleuthkit.autopsy.contentviewers.textcontentviewer.TextContentViewer.isPreferred ( Node  node)

Checks whether the given viewer is preferred for the Node. This is a bit subjective, but the idea is that Autopsy wants to display the most relevant tab. The more generic the viewer, the lower the return value should be. This will only be called on viewers that support the given node (i.e., isSupported() has already returned true).

The following are some examples of the current levels in use. If the selected node is an artifact, the level may be determined by both the artifact and its associated file.

Level 7 - Based on the artifact, if any, in the selected node and specific to an artifact type or types. Current content viewers that can return level 7 are the Messages tab (only supported for email and SMS) and the Text tab when the selected node is a Keyword Search hit.

Level 6 - Based on the artifact, if any, in the selected node but not restricted to particular types. The current content viewer that can return level 6 is the Results tab. It returns this level for most artifact types, unless the associated file is assumed to be of greater interest (for example, a Hash Set Hit will not be level 6 because the file itself is of greater interest).

Level 5 - Based on the file in the selected node and very specific to the file type. The current content viewer that will return level 5 is the Application tab, which supports media files (such as images) and certain types of databases.

Level 4 - Based on the file in the selected node but fairly general. Currently this is the level returned by the Text tab if Keyword Search has been run (unless the node is a Keyword Search hit or a Credit Card account). This is the default tab for most files.

Level 3 - Based on the artifact, if any, in the selected node where the artifact is thought to be of less interest than the associated file. This level is returned by the Results tab for artifacts like Hash Set Hits.

Level 1 - Very general and should always be available. The Hex, Text, and Metadata tabs are all this level

Level 0 - For cases where the content viewer should never be displayed by default.

Parameters
nodeNode to check for preference
Returns
an int (0-10) higher return means the viewer has higher priority

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.

Definition at line 109 of file TextContentViewer.java.

boolean org.sleuthkit.autopsy.contentviewers.textcontentviewer.TextContentViewer.isSupported ( Node  node)

Checks whether the given node is supported by the viewer. This will be used to enable or disable the tab for the viewer.

Parameters
nodeNode to check for support
Returns
True if the node can be displayed / processed, else false

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.

Definition at line 89 of file TextContentViewer.java.

void org.sleuthkit.autopsy.contentviewers.textcontentviewer.TextContentViewer.resetComponent ( )
void org.sleuthkit.autopsy.contentviewers.textcontentviewer.TextContentViewer.setNode ( Node  selectedNode)

Autopsy will call this when this panel is focused with the file that should be analyzed. When called with null, must clear all references to previous nodes.

Parameters
selectedNodethe node which is used to determine what is displayed in this viewer

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.

Definition at line 54 of file TextContentViewer.java.

References org.sleuthkit.autopsy.contentviewers.textcontentviewer.TextContentViewerPanel.setNode().

Member Data Documentation

volatile Node org.sleuthkit.autopsy.contentviewers.textcontentviewer.TextContentViewer.currentNode = null
private

Definition at line 35 of file TextContentViewer.java.

final TextContentViewerPanel org.sleuthkit.autopsy.contentviewers.textcontentviewer.TextContentViewer.panel
private

Definition at line 34 of file TextContentViewer.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.