org.sleuthkit.autopsy.corecomponents.DataContentViewerHex Class Reference

Inherits JPanel, and org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.

Public Member Functions
	DataContentViewerHex ()
DataContentViewer	createInstance ()
Component	getComponent ()
String	getTitle ()
String	getToolTip ()
int	isPreferred (Node node)
boolean	isSupported (Node node)
void	resetComponent ()
void	setNode (Node selectedNode)

Private Member Functions
void	customizeComponents ()
long	getOffsetRelativeToCaretPosition (Long userInput)
void	goToOffsetTextFieldActionPerformed (java.awt.event.ActionEvent evt)
void	goToPageTextFieldActionPerformed (java.awt.event.ActionEvent evt)
void	initComponents ()
void	maybeShowPopup (java.awt.event.MouseEvent evt)
void	nextPageButtonActionPerformed (java.awt.event.ActionEvent evt)
void	prevPageButtonActionPerformed (java.awt.event.ActionEvent evt)
void	setComponentsVisibility (boolean isVisible)
void	setDataView (long offset)
void	setDataViewByOffset (long offset)
void	setDataViewByPageNumber (int page)

Private Attributes
javax.swing.JMenuItem	copyMenuItem
javax.swing.JLabel	currentPageLabel
final byte[]	data = new byte[(int) pageLength]
Content	dataSource
javax.swing.JLabel	goToOffsetLabel
javax.swing.JTextField	goToOffsetTextField
javax.swing.JLabel	goToPageLabel
javax.swing.JTextField	goToPageTextField
javax.swing.JPanel	hexViewerPanel
javax.swing.JScrollPane	jScrollPane2
javax.swing.JScrollPane	jScrollPane3
javax.swing.JButton	nextPageButton
javax.swing.JLabel	ofLabel
javax.swing.JTextArea	outputTextArea
javax.swing.JLabel	pageLabel
javax.swing.JLabel	pageLabel2
javax.swing.JButton	prevPageButton
javax.swing.JPopupMenu	rightClickMenu
javax.swing.JMenuItem	selectAllMenuItem
javax.swing.JLabel	totalPageLabel
int	totalPages

Static Private Attributes
static int	currentPage = 1
static final Logger	logger = Logger.getLogger(DataContentViewerHex.class.getName())
static final long	pageLength = 16384

Detailed Description

Hex view of file contents.

Definition at line 44 of file DataContentViewerHex.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.DataContentViewerHex

(

)

Creates new form DataContentViewerHex

Definition at line 57 of file DataContentViewerHex.java.

Member Function Documentation

DataContentViewer org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.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 475 of file DataContentViewerHex.java.

void org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.customizeComponents ( )

private

Definition at line 64 of file DataContentViewerHex.java.

Component org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.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.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.

Definition at line 528 of file DataContentViewerHex.java.

long org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.getOffsetRelativeToCaretPosition ( Long  userInput )

private

• Calculates the offset relative to the current caret position.

Parameters

userInput

the user provided signed offset value.

Returns

returns the resultant offset value relative to the current caret position. -1L is returned if the resultant offset cannot be calculated.

Definition at line 298 of file DataContentViewerHex.java.

String org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.getTitle

(

)

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

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.

Definition at line 465 of file DataContentViewerHex.java.

String org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.getToolTip

(

)

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

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.

Definition at line 470 of file DataContentViewerHex.java.

void org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.goToOffsetTextFieldActionPerformed ( java.awt.event.ActionEvent  evt )

private

Definition at line 316 of file DataContentViewerHex.java.

void org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.goToPageTextFieldActionPerformed ( java.awt.event.ActionEvent  evt )

private

Definition at line 266 of file DataContentViewerHex.java.

void org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.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 88 of file DataContentViewerHex.java.

int org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.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 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. 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 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. 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, Strings, and Metadata tabs are all this level

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

Parameters

node	Node 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 523 of file DataContentViewerHex.java.

boolean org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.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

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.

Definition at line 510 of file DataContentViewerHex.java.

void org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.maybeShowPopup ( java.awt.event.MouseEvent  evt )

private

Definition at line 535 of file DataContentViewerHex.java.

void org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.nextPageButtonActionPerformed ( java.awt.event.ActionEvent  evt )

private

Definition at line 261 of file DataContentViewerHex.java.

void org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.prevPageButtonActionPerformed ( java.awt.event.ActionEvent  evt )

private

Definition at line 256 of file DataContentViewerHex.java.

void org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.resetComponent

(

)

Resets the contents of the viewer / component.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.

Definition at line 480 of file DataContentViewerHex.java.

void org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.setComponentsVisibility ( boolean  isVisible )

private

To set the visibility of specific components in this class.

Parameters

isVisible

whether to show or hide the specific components

Definition at line 495 of file DataContentViewerHex.java.

void org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.setDataView ( long  offset )

private

Definition at line 390 of file DataContentViewerHex.java.

References org.sleuthkit.autopsy.datamodel.DataConversion.byteArrayToHex().

void org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.setDataViewByOffset ( long  offset )

private

Sets the DataView (The tabbed panel) by offset

Parameters

offset

Page to display (1-based counting)

Definition at line 381 of file DataContentViewerHex.java.

void org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.setDataViewByPageNumber ( int  page )

private

Sets the DataView (The tabbed panel) by page number

Parameters

page	Page to display (1-based counting)

Definition at line 363 of file DataContentViewerHex.java.

void org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.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.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.

Definition at line 442 of file DataContentViewerHex.java.

Member Data Documentation

javax.swing.JMenuItem org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.copyMenuItem

private

Definition at line 338 of file DataContentViewerHex.java.

int org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.currentPage = 1

staticprivate

Definition at line 48 of file DataContentViewerHex.java.

javax.swing.JLabel org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.currentPageLabel

private

Definition at line 339 of file DataContentViewerHex.java.

final byte [] org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.data = new byte[(int) pageLength]

private

Definition at line 47 of file DataContentViewerHex.java.

Content org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.dataSource

private

Definition at line 50 of file DataContentViewerHex.java.

javax.swing.JLabel org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.goToOffsetLabel

private

Definition at line 340 of file DataContentViewerHex.java.

javax.swing.JTextField org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.goToOffsetTextField

private

Definition at line 341 of file DataContentViewerHex.java.

javax.swing.JLabel org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.goToPageLabel

private

Definition at line 342 of file DataContentViewerHex.java.

javax.swing.JTextField org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.goToPageTextField

private

Definition at line 343 of file DataContentViewerHex.java.

javax.swing.JPanel org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.hexViewerPanel

private

Definition at line 344 of file DataContentViewerHex.java.

javax.swing.JScrollPane org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.jScrollPane2

private

Definition at line 345 of file DataContentViewerHex.java.

javax.swing.JScrollPane org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.jScrollPane3

private

Definition at line 346 of file DataContentViewerHex.java.

final Logger org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.logger = Logger.getLogger(DataContentViewerHex.class.getName())

staticprivate

Definition at line 52 of file DataContentViewerHex.java.

javax.swing.JButton org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.nextPageButton

private

Definition at line 347 of file DataContentViewerHex.java.

javax.swing.JLabel org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.ofLabel

private

Definition at line 348 of file DataContentViewerHex.java.

javax.swing.JTextArea org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.outputTextArea

private

Definition at line 349 of file DataContentViewerHex.java.

javax.swing.JLabel org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.pageLabel

private

Definition at line 350 of file DataContentViewerHex.java.

javax.swing.JLabel org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.pageLabel2

private

Definition at line 351 of file DataContentViewerHex.java.

final long org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.pageLength = 16384

staticprivate

Definition at line 46 of file DataContentViewerHex.java.

javax.swing.JButton org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.prevPageButton

private

Definition at line 352 of file DataContentViewerHex.java.

javax.swing.JPopupMenu org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.rightClickMenu

private

Definition at line 353 of file DataContentViewerHex.java.

javax.swing.JMenuItem org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.selectAllMenuItem

private

Definition at line 354 of file DataContentViewerHex.java.

javax.swing.JLabel org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.totalPageLabel

private

Definition at line 355 of file DataContentViewerHex.java.

int org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.totalPages

private

Definition at line 49 of file DataContentViewerHex.java.

---

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

• /home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/corecomponents/DataContentViewerHex.java