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

Inherited by org.sleuthkit.autopsy.corecomponents.AbstractDataResultViewer.

Public Member Functions

default void clearComponent ()
 
DataResultViewer createInstance ()
 
default void expandNode (Node node)
 
Component getComponent ()
 
String getTitle ()
 
boolean isSupported (Node node)
 
default void resetComponent ()
 
default void setContentViewer (DataContent contentViewer)
 
void setNode (Node node)
 
default void setSelectedNodes (Node[] selectedNodes)
 

Detailed Description

An interface for result viewers. A result viewer uses a Swing Component to provide a view of the application data represented by a NetBeans Node passed to it via its setNode method.

Result viewers are most commonly presented as a tab in a result view panel (DataResultPanel) inside a result view top component (DataResultTopComponent) that is docked into the upper right hand side (editor mode) of the main application window.

A result viewer is typically a JPanel that displays the child nodes of the given node using a NetBeans explorer view child component. Such a result viewer should use the explorer manager of the ancestor top component to connect the lookups of the nodes displayed in the NetBeans explorer view to the actions global context. It is strongly recommended that this type of result viewer is implemented by extending the abstract base class AbstractDataResultViewer, which will handle some key aspects of working with the ancestor top component's explorer manager.

This interface is an extension point, so classes that implement it should provide an appropriate ServiceProvider annotation.

Definition at line 46 of file DataResultViewer.java.

Member Function Documentation

default void org.sleuthkit.autopsy.corecomponentinterfaces.DataResultViewer.clearComponent ( )

Frees any resources tha have been allocated by this result viewer, in preparation for permanently disposing of it.

Implemented in org.sleuthkit.autopsy.corecomponents.DataResultViewerTable, and org.sleuthkit.autopsy.corecomponents.DataResultViewerThumbnail.

Definition at line 114 of file DataResultViewer.java.

DataResultViewer org.sleuthkit.autopsy.corecomponentinterfaces.DataResultViewer.createInstance ( )

Creates a new instance of this result viewer, which allows the application to use the capability provided by this result viewer in more than one result view. This is done by using the default instance of this result viewer as a "factory" for creating other instances.

Implemented in org.sleuthkit.autopsy.corecomponents.DataResultViewerThumbnail, and org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.

default void org.sleuthkit.autopsy.corecomponentinterfaces.DataResultViewer.expandNode ( Node  node)

Sets the node for which this result viewer should provide a view of the underlying application data model object, and expands the node.

Parameters
nodeThe node.
Deprecated:
This API is not used by the application.

Definition at line 126 of file DataResultViewer.java.

Component org.sleuthkit.autopsy.corecomponentinterfaces.DataResultViewer.getComponent ( )

Gets the Swing component for this viewer.

Returns
The component.

Implemented in org.sleuthkit.autopsy.corecomponents.AbstractDataResultViewer.

Referenced by org.sleuthkit.autopsy.corecomponents.DataResultPanel.addResultViewer().

String org.sleuthkit.autopsy.corecomponentinterfaces.DataResultViewer.getTitle ( )
boolean org.sleuthkit.autopsy.corecomponentinterfaces.DataResultViewer.isSupported ( Node  node)

Indicates whether this result viewer is able to provide a meaningful view of the application data represented by a given node. Typically, indicates whether or not this result viewer can use the given node as the root node of its child explorer view component.

Parameters
nodeThe node.
Returns
True or false.

Implemented in org.sleuthkit.autopsy.corecomponents.DataResultViewerThumbnail, and org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.

default void org.sleuthkit.autopsy.corecomponentinterfaces.DataResultViewer.resetComponent ( )

Resets the state of the Swing component for this viewer to its default state.

Implemented in org.sleuthkit.autopsy.corecomponents.DataResultViewerThumbnail.

Definition at line 107 of file DataResultViewer.java.

default void org.sleuthkit.autopsy.corecomponentinterfaces.DataResultViewer.setContentViewer ( DataContent  contentViewer)

Sets a custom content viewer to which nodes selected in this result viewer should be pushed via DataContent.setNode.

Parameters
contentViewerThe content viewer.
Deprecated:
This API is not used by the application.

Definition at line 138 of file DataResultViewer.java.

void org.sleuthkit.autopsy.corecomponentinterfaces.DataResultViewer.setNode ( Node  node)

Sets the node for which this result viewer should provide a view of the underlying application data. Typically, this means using the given node as the root node of this result viewer's child explorer view component.

Parameters
nodeThe node, may be null. If null, the call to this method is equivalent to a call to resetComponent.

Implemented in org.sleuthkit.autopsy.corecomponents.DataResultViewerThumbnail, and org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.

Referenced by org.sleuthkit.autopsy.corecomponents.DataResultPanel.stateChanged().

default void org.sleuthkit.autopsy.corecomponentinterfaces.DataResultViewer.setSelectedNodes ( Node[]  selectedNodes)

Requests selection of the given child nodes of the node passed to setNode. This method should be implemented as a no-op for result viewers that do not display the child nodes of a given root node using a NetBeans explorer view set up to use a given explorer manager.

Parameters
selectedNodesThe child nodes to select.

Implemented in org.sleuthkit.autopsy.corecomponents.AbstractDataResultViewer.

Definition at line 86 of file DataResultViewer.java.


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

Copyright © 2012-2019 Basis Technology. Generated on: Tue Jan 7 2020
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.