Public Member Functions
DataContentViewer	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 DataContentViewer modules must implement. These modules analyze an individual file that the user has selected and display results in some form of JPanel. We find it easiest to use the NetBeans IDE to first make a "JPanel Form" class and then have it implement DataContentViewer. This allows you to easily use the UI builder for the layout.

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

Definition at line 35 of file DataContentViewer.java.

Member Function Documentation

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

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

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

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

String org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.getToolTip ( )

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

int org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.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.

Parameters

node	Node to check for preference

Returns: an int (0-10) higher return means the viewer has higher priority 0 means not supported 1 to 2 means the module will display all file types (such as the hex viewer) 3-10 are prioritized by Content viewer developer. Modules that operate on very few file types should be towards 10.

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

void org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.resetComponent ( )

Resets the contents of the viewer / component.

void org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.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.

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

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

Public Member Functions

Detailed Description

Member Function Documentation