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 ( )

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

Returns: the title of TextViewer

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.getToolTip ( )

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

Returns: the tooltip for this TextViewer

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().

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 6 - Used for data artifact viewers. These have higher priority over file content viewers because a Node will likely have the ‘source’ file for a data artifact and we want to give the artifact priority. Currently used by the Data Artifacts viewer.

Level 5 - Used for type-specific file content viewers that are optimized for that type, such as displaying an image or a PDF file with images and proper layout. Currently used by the Application viewer.

Level 4 - Used for type-specific file content viewers that are not optimized. For example, displaying only the plain text from a PDF would be at this level, but displaying the same PDF with images and layout would be level 5. Currently used by the Text viewer that returns text from Solr.

Level 3 - Used for viewing Data Artifacts that refer to files and the user may want to view the files more than the artifact itself. This is currently used by the Data Artifact viewer when a Web Download artifact is selected.

Level 2 - Used for viewing Analysis Results. This is a lower priority than Data Artifacts and file content because Analysis Results are used to identify content of interest and therefore the content itself should be shown. Currently used by the Analysis Results viewer. * Level 1 - Used for metadata viewers that give more information and context about the primary file or artifact. Currently used by Metadata, Annotations, Context, Other Occurrences, and OS Account.

Level 0 - Used for general purpose file content viewers that are not file specific and will always be enabled. Currently used by Text/Strings and Hex.

Parameters

node	Node 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

node	Node 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 ( )

Resets the contents of the viewer / component.

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.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

selectedNode the 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:

/home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/corecomponentinterfaces/TextViewer.java

Public Member Functions

Detailed Description

Member Function Documentation