Autopsy  4.15.0
Graphical digital forensics platform for The Sleuth Kit and other tools.
Public Member Functions | List of all members
org.sleuthkit.autopsy.corecomponentinterfaces.TextViewer Interface Reference

Inherited by org.sleuthkit.autopsy.contentviewers.textcontentviewer.StringsTextViewer, org.sleuthkit.autopsy.keywordsearch.ExtractedTextViewer, and org.sleuthkit.autopsy.texttranslation.ui.TranslatedTextViewer.

Public Member Functions

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

Detailed Description

Interface that TextViewers for the TextContentViewer must implement. These modules analyze an individual file that the user has selected and display results in some form of JPanel.

TextViewer panels should handle their own vertical scrolling, the horizontal scrolling when under their panel's preferred size will be handled by the TextContentViewerPanel which contains them.

Definition at line 33 of file TextViewer.java.

Member Function Documentation

TextViewer org.sleuthkit.autopsy.corecomponentinterfaces.TextViewer.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 TextViewer. This method is used to get an instance of your specific type.

Returns
A new instance of the viewer

Implemented in org.sleuthkit.autopsy.keywordsearch.ExtractedTextViewer, org.sleuthkit.autopsy.texttranslation.ui.TranslatedTextViewer, and org.sleuthkit.autopsy.contentviewers.textcontentviewer.StringsTextViewer.

Referenced by org.sleuthkit.autopsy.contentviewers.textcontentviewer.TextContentViewerPanel.TextContentViewerPanel().

Component org.sleuthkit.autopsy.corecomponentinterfaces.TextViewer.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

Implemented in org.sleuthkit.autopsy.keywordsearch.ExtractedTextViewer, org.sleuthkit.autopsy.texttranslation.ui.TranslatedTextViewer, and org.sleuthkit.autopsy.contentviewers.textcontentviewer.StringsTextViewer.

Referenced by org.sleuthkit.autopsy.contentviewers.textcontentviewer.TextContentViewerPanel.TextContentViewerPanel().

String org.sleuthkit.autopsy.corecomponentinterfaces.TextViewer.getTitle ( )
String org.sleuthkit.autopsy.corecomponentinterfaces.TextViewer.getToolTip ( )
int org.sleuthkit.autopsy.corecomponentinterfaces.TextViewer.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. The current text viewer that can return level 7 is the Indexed 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.

Level 5 - Based on the file in the selected node and very specific to the file type.

Level 4 - Based on the file in the selected node but fairly general. Currently this is the level returned by the Indexed 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.

Level 1 - Very general and should always be available. The Strings tabs is this this level

Level 0 - For cases where the text 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

Implemented in org.sleuthkit.autopsy.keywordsearch.ExtractedTextViewer, org.sleuthkit.autopsy.texttranslation.ui.TranslatedTextViewer, and org.sleuthkit.autopsy.contentviewers.textcontentviewer.StringsTextViewer.

boolean org.sleuthkit.autopsy.corecomponentinterfaces.TextViewer.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

Implemented in org.sleuthkit.autopsy.keywordsearch.ExtractedTextViewer, org.sleuthkit.autopsy.texttranslation.ui.TranslatedTextViewer, and org.sleuthkit.autopsy.contentviewers.textcontentviewer.StringsTextViewer.

void org.sleuthkit.autopsy.corecomponentinterfaces.TextViewer.resetComponent ( )
void org.sleuthkit.autopsy.corecomponentinterfaces.TextViewer.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

Implemented in org.sleuthkit.autopsy.contentviewers.textcontentviewer.StringsTextViewer.


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

Copyright © 2012-2020 Basis Technology. Generated on: Mon Jul 6 2020
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.