Autopsy  4.10.0
Graphical digital forensics platform for The Sleuth Kit and other tools.
Classes | Public Member Functions | Static Public Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes | Static Private Attributes | List of all members
org.sleuthkit.autopsy.corecomponents.DataResultPanel Class Reference

Inherits JPanel, org.sleuthkit.autopsy.corecomponentinterfaces.DataResult, ChangeListener, and Provider.

Classes

class  ExplorerManagerListener
 
class  RootNodeListener
 

Public Member Functions

void addResultViewer (DataResultViewer resultViewer)
 
boolean canClose ()
 
ExplorerManager getExplorerManager ()
 
String getPreferredID ()
 
Node getRootNode ()
 
List< DataResultViewergetViewers ()
 
boolean isMain ()
 
void open ()
 
void resetTabs (Node unusedSelectedNode)
 
void setContentViewer (DataContent customContentView)
 
void setNode (Node rootNode)
 
void setNumberOfChildNodes (Integer numberOfChildNodes)
 
void setNumMatches (Integer numberOfChildNodes)
 
void setPath (String description)
 
void setSelectedNodes (Node[] selectedNodes)
 
void setTitle (String title)
 
void stateChanged (ChangeEvent event)
 

Static Public Member Functions

static DataResultPanel createInstance (String title, String description, Node currentRootNode, int childNodeCount)
 
static DataResultPanel createInstance (String title, String description, Node currentRootNode, int childNodeCount, Collection< DataResultViewer > viewers)
 
static DataResultPanel createInstance (String title, String description, Node currentRootNode, int childNodeCount, DataContent customContentView)
 
static DataResultPanel createInstanceUninitialized (String title, String description, Node currentRootNode, int childNodeCount, DataContent customContentView)
 

Private Member Functions

void initComponents ()
 
void setupTabs (Node selectedNode)
 

Static Private Member Functions

static void createInstanceCommon (String title, String description, Node currentRootNode, int childNodeCount, DataResultPanel resultViewPanel)
 

Private Attributes

DataContent contentView
 
Node currentRootNode
 
javax.swing.JLabel descriptionLabel
 
ExplorerManager explorerManager
 
final ExplorerManagerListener explorerManagerListener
 
final boolean isMain
 
boolean listeningToTabbedPane
 
javax.swing.JLabel matchLabel
 
javax.swing.JLabel numberOfChildNodesLabel
 
final List< DataResultViewerresultViewers
 
javax.swing.JTabbedPane resultViewerTabs
 
final RootNodeListener rootNodeListener
 

Static Private Attributes

static final int NO_TAB_SELECTED = -1
 
static final String PLEASE_WAIT_NODE_DISPLAY_NAME = NbBundle.getMessage(DataResultPanel.class, "DataResultPanel.pleasewaitNodeDisplayName")
 
static final long serialVersionUID = 1L
 

Detailed Description

A result view panel is a JPanel with a JTabbedPane child component that contains a collection of result viewers and implements the DataResult interface. The result viewers in a result view panel are either supplied during construction of the panel or are obtained from the result viewer extension point (DataResultViewer service providers).

A result view panel provides an implementation of the setNode API of the the DataResult interface that pushes a given NetBeans Node into its child result viewers via the DataResultViewer.setNode API. The result viewers are responsible for providing a view of the application data represented by the node. A typical result viewer is a JPanel that displays the child nodes of the given node using a NetBeans explorer view child component.

All result view panels should be child components of top components that are explorer manager providers. The parent top component is expected to expose a lookup maintained by its explorer manager to the actions global context. The child result view panel will then find the parent top component's explorer manager at runtime, so that it can act as an explorer manager provider for its child result viewers. This connects the nodes displayed in the result viewers to the actions global context.

Result view panels can be constructed so that they push single node selections in the child result viewers to a content view (implements DataContent). The content view could be the "main" content view (DataContentTopComponent) that is normally docked into the lower right hand side of the main application window, or it could be a custom content view.

Definition at line 76 of file DataResultPanel.java.

Member Function Documentation

void org.sleuthkit.autopsy.corecomponents.DataResultPanel.addResultViewer ( DataResultViewer  resultViewer)

Adds a results viewer to this result view panel.

Parameters
resultViewerThe results viewer.

Definition at line 278 of file DataResultPanel.java.

References org.sleuthkit.autopsy.corecomponentinterfaces.DataResultViewer.getComponent(), and org.sleuthkit.autopsy.corecomponentinterfaces.DataResultViewer.getTitle().

boolean org.sleuthkit.autopsy.corecomponents.DataResultPanel.canClose ( )

Indicates whether or not this panel can be closed at the time of the call.

Returns
True or false.

Definition at line 511 of file DataResultPanel.java.

References org.sleuthkit.autopsy.casemodule.Case.getCurrentCaseThrows(), and org.sleuthkit.autopsy.casemodule.Case.hasData().

static DataResultPanel org.sleuthkit.autopsy.corecomponents.DataResultPanel.createInstance ( String  title,
String  description,
Node  currentRootNode,
int  childNodeCount 
)
static

Creates and opens a Swing JPanel with a JTabbedPane child component that contains instances of the result viewers (DataResultViewer) provided by the result viewer extension point (service providers that implement DataResultViewer). The result view panel will push single node selections from its child result viewers to the "main" content view that is normally docked into the lower right hand side of the main application window.

Parameters
titleThe title for the result view panel.
descriptionDescriptive text about the source of the nodes displayed.
currentRootNodeThe current root (parent) node for the nodes displayed. May be changed by calling setNode.
childNodeCountThe cardinality of the root node's children.
Returns
A result view panel.

Definition at line 107 of file DataResultPanel.java.

References org.sleuthkit.autopsy.corecomponents.DataContentTopComponent.findInstance(), and org.sleuthkit.autopsy.corecomponents.DataResultPanel.open().

static DataResultPanel org.sleuthkit.autopsy.corecomponents.DataResultPanel.createInstance ( String  title,
String  description,
Node  currentRootNode,
int  childNodeCount,
Collection< DataResultViewer viewers 
)
static

Creates and opens a Swing JPanel with a JTabbedPane child component that contains a given collection of result viewers (DataResultViewer) instead of the result viewers provided by the results viewer extension point. The result view panel will push single node selections from its child result viewers to the "main" content view that is normally docked into the lower right hand side of the main application window.

Parameters
titleThe title for the result view panel.
descriptionDescriptive text about the source of the nodes displayed.
currentRootNodeThe current root (parent) node for the nodes displayed. May be changed by calling setNode.
childNodeCountThe cardinality of the root node's children.
viewersA collection of result viewers to use instead of the result viewers provided by the results viewer extension point.
Returns
A result view panel.

Definition at line 134 of file DataResultPanel.java.

References org.sleuthkit.autopsy.corecomponents.DataContentTopComponent.findInstance(), and org.sleuthkit.autopsy.corecomponents.DataResultPanel.open().

static DataResultPanel org.sleuthkit.autopsy.corecomponents.DataResultPanel.createInstance ( String  title,
String  description,
Node  currentRootNode,
int  childNodeCount,
DataContent  customContentView 
)
static

Creates and opens a Swing JPanel with a JTabbedPane child component that contains instances of the result viewers (DataResultViewer) provided by the result viewer extension point (service providers that implement DataResultViewer). The result view panel will push single node selections from its child result viewers to the supplied content view, which can be null if a content view is not needed.

Parameters
titleThe title for the result view panel.
descriptionDescriptive text about the source of the nodes displayed.
currentRootNodeThe current root (parent) node for the nodes displayed. May be changed by calling setNode.
childNodeCountThe cardinality of the root node's children.
customContentViewA custom content view to use instead of the "main" content view that is normally docked into the lower right hand side of the main application window. May be null, if no content view is needed.
Returns
A result view panel.

Definition at line 163 of file DataResultPanel.java.

References org.sleuthkit.autopsy.corecomponents.DataResultPanel.open().

static void org.sleuthkit.autopsy.corecomponents.DataResultPanel.createInstanceCommon ( String  title,
String  description,
Node  currentRootNode,
int  childNodeCount,
DataResultPanel  resultViewPanel 
)
staticprivate

Executes code common to all of the result view panel factory methods.

Parameters
titleThe title for the result view panel.
descriptionDescriptive text about the source of the nodes displayed.
currentRootNodeThe current root (parent) node for the nodes displayed. May be changed by calling setNode.
childNodeCountThe cardinality of the root node's children.
resultViewPanelA new results view panel.

Definition at line 206 of file DataResultPanel.java.

References org.sleuthkit.autopsy.corecomponents.DataResultPanel.setNode(), org.sleuthkit.autopsy.corecomponents.DataResultPanel.setNumberOfChildNodes(), org.sleuthkit.autopsy.corecomponents.DataResultPanel.setPath(), and org.sleuthkit.autopsy.corecomponents.DataResultPanel.setTitle().

static DataResultPanel org.sleuthkit.autopsy.corecomponents.DataResultPanel.createInstanceUninitialized ( String  title,
String  description,
Node  currentRootNode,
int  childNodeCount,
DataContent  customContentView 
)
static

Creates, but does not open, a Swing JPanel with a JTabbedPane child component that contains instances of the result viewers (DataResultViewer) provided by the result viewer extension point (service providers that implement DataResultViewer). The result view panel will push single node selections from its child result viewers to the supplied custom content view.

Parameters
titleThe title for the result view panel.
descriptionDescriptive text about the source of the nodes displayed.
currentRootNodeThe current root (parent) node for the nodes displayed. May be changed by calling setNode.
childNodeCountThe cardinality of the root node's children.
customContentViewA content view to use in place of the default content view.
Returns
A result view panel.

Definition at line 189 of file DataResultPanel.java.

Referenced by org.sleuthkit.autopsy.contentviewers.MessageContentViewer.MessageContentViewer(), and org.sleuthkit.autopsy.timeline.TimeLineTopComponent.TimeLineTopComponent().

ExplorerManager org.sleuthkit.autopsy.corecomponents.DataResultPanel.getExplorerManager ( )
String org.sleuthkit.autopsy.corecomponents.DataResultPanel.getPreferredID ( )

Gets the preferred identifier for this result view panel in the window system.

Returns
The preferred identifier.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataResult.

Definition at line 248 of file DataResultPanel.java.

Node org.sleuthkit.autopsy.corecomponents.DataResultPanel.getRootNode ( )

Gets the root node of this result view panel. For the "main" panel, the root node is the currently selected node in the application tree view docked into the left side of the main application window.

Returns
The root node.

Definition at line 403 of file DataResultPanel.java.

Referenced by org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.getRootNode().

List<DataResultViewer> org.sleuthkit.autopsy.corecomponents.DataResultPanel.getViewers ( )

Gets the result viewers for this result view panel.

Returns
A list of result viewers.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataResult.

Definition at line 289 of file DataResultPanel.java.

Referenced by org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.getViewers().

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

boolean org.sleuthkit.autopsy.corecomponents.DataResultPanel.isMain ( )

Gets whether or not this result view panel is the "main" result view panel used to view the child nodes of a node selected in the application tree view (DirectoryTreeTopComponent) that is normally docked into the left hand side of the main window.

Returns
True or false.
Deprecated:
This method has no valid use case.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataResult.

Definition at line 733 of file DataResultPanel.java.

void org.sleuthkit.autopsy.corecomponents.DataResultPanel.open ( )
void org.sleuthkit.autopsy.corecomponents.DataResultPanel.resetTabs ( Node  unusedSelectedNode)

Resets the state of this results panel.

Parameters
unusedSelectedNodeUnused.
Deprecated:
Use setNode(null) instead.

Definition at line 758 of file DataResultPanel.java.

void org.sleuthkit.autopsy.corecomponents.DataResultPanel.setContentViewer ( DataContent  customContentView)

Sets the content view for this result view panel. Needs to be called before the first call to open.

Parameters
customContentViewA content view to use in place of the default content view.

Definition at line 300 of file DataResultPanel.java.

void org.sleuthkit.autopsy.corecomponents.DataResultPanel.setNode ( Node  rootNode)

Sets the current root node for this result view panel. The child nodes of the current root node will be displayed in the child result viewers. For the "main" panel, the root node is the currently selected node in the application tree view docked into the left side of the main application window.

Parameters
rootNodeThe root node for this panel, may be null if the panel is to be reset.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataResult.

Definition at line 356 of file DataResultPanel.java.

References org.sleuthkit.autopsy.corecomponents.DataResultPanel.RootNodeListener.reset().

Referenced by org.sleuthkit.autopsy.contentviewers.MessageContentViewer.configureAttachments(), org.sleuthkit.autopsy.corecomponents.DataResultPanel.createInstanceCommon(), org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.resetTabs(), and org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.setNode().

void org.sleuthkit.autopsy.corecomponents.DataResultPanel.setNumberOfChildNodes ( Integer  numberOfChildNodes)

Sets the label text that displays the number of the child nodes displayed by this result view panel's result viewers.

Parameters
numberOfChildNodesThe number of child nodes.

Definition at line 413 of file DataResultPanel.java.

Referenced by org.sleuthkit.autopsy.corecomponents.DataResultPanel.createInstanceCommon(), and org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.setNumberOfChildNodes().

void org.sleuthkit.autopsy.corecomponents.DataResultPanel.setNumMatches ( Integer  numberOfChildNodes)

Sets the label text that displays the number of the child nodes displayed by this result view panel's result viewers.

Parameters
numberOfChildNodesThe number of child nodes.
Deprecated:
Use setNumberOfChildNodes instead.

Definition at line 746 of file DataResultPanel.java.

void org.sleuthkit.autopsy.corecomponents.DataResultPanel.setPath ( String  description)

Sets the descriptive text about the source of the nodes displayed in this result view panel.

Parameters
descriptionThe text to display.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataResult.

Definition at line 269 of file DataResultPanel.java.

Referenced by org.sleuthkit.autopsy.corecomponents.DataResultPanel.createInstanceCommon(), and org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.setPath().

void org.sleuthkit.autopsy.corecomponents.DataResultPanel.setSelectedNodes ( Node[]  selectedNodes)

Selects the given child nodes of the root node in this panel's result viewers.

Parameters
selectedNodesThe child nodes to be selected.

Definition at line 423 of file DataResultPanel.java.

Referenced by org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.setSelectedNodes().

void org.sleuthkit.autopsy.corecomponents.DataResultPanel.setTitle ( String  title)

Sets the title of this result view panel.

Parameters
titleThe title.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataResult.

Definition at line 258 of file DataResultPanel.java.

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

void org.sleuthkit.autopsy.corecomponents.DataResultPanel.setupTabs ( Node  selectedNode)
private

Sets the state of the child result viewers, based on a selected root node.

Parameters
selectedNodeThe selected node.

Definition at line 433 of file DataResultPanel.java.

void org.sleuthkit.autopsy.corecomponents.DataResultPanel.stateChanged ( ChangeEvent  event)

Responds to a tab selection changed event by setting the root node of the corresponding result viewer.

Parameters
eventThe change event.

Definition at line 491 of file DataResultPanel.java.

References org.sleuthkit.autopsy.corecomponents.DataResultPanel.NO_TAB_SELECTED, and org.sleuthkit.autopsy.corecomponentinterfaces.DataResultViewer.setNode().

Member Data Documentation

DataContent org.sleuthkit.autopsy.corecomponents.DataResultPanel.contentView
private

Definition at line 85 of file DataResultPanel.java.

Node org.sleuthkit.autopsy.corecomponents.DataResultPanel.currentRootNode
private

Definition at line 87 of file DataResultPanel.java.

javax.swing.JLabel org.sleuthkit.autopsy.corecomponents.DataResultPanel.descriptionLabel
private

Definition at line 715 of file DataResultPanel.java.

ExplorerManager org.sleuthkit.autopsy.corecomponents.DataResultPanel.explorerManager
private

Definition at line 86 of file DataResultPanel.java.

final ExplorerManagerListener org.sleuthkit.autopsy.corecomponents.DataResultPanel.explorerManagerListener
private

Definition at line 83 of file DataResultPanel.java.

final boolean org.sleuthkit.autopsy.corecomponents.DataResultPanel.isMain
private

Definition at line 81 of file DataResultPanel.java.

boolean org.sleuthkit.autopsy.corecomponents.DataResultPanel.listeningToTabbedPane
private

Definition at line 88 of file DataResultPanel.java.

javax.swing.JLabel org.sleuthkit.autopsy.corecomponents.DataResultPanel.matchLabel
private

Definition at line 716 of file DataResultPanel.java.

final int org.sleuthkit.autopsy.corecomponents.DataResultPanel.NO_TAB_SELECTED = -1
staticprivate
javax.swing.JLabel org.sleuthkit.autopsy.corecomponents.DataResultPanel.numberOfChildNodesLabel
private

Definition at line 717 of file DataResultPanel.java.

final String org.sleuthkit.autopsy.corecomponents.DataResultPanel.PLEASE_WAIT_NODE_DISPLAY_NAME = NbBundle.getMessage(DataResultPanel.class, "DataResultPanel.pleasewaitNodeDisplayName")
staticprivate

Definition at line 80 of file DataResultPanel.java.

final List<DataResultViewer> org.sleuthkit.autopsy.corecomponents.DataResultPanel.resultViewers
private

Definition at line 82 of file DataResultPanel.java.

javax.swing.JTabbedPane org.sleuthkit.autopsy.corecomponents.DataResultPanel.resultViewerTabs
private

Definition at line 718 of file DataResultPanel.java.

final RootNodeListener org.sleuthkit.autopsy.corecomponents.DataResultPanel.rootNodeListener
private

Definition at line 84 of file DataResultPanel.java.

final long org.sleuthkit.autopsy.corecomponents.DataResultPanel.serialVersionUID = 1L
staticprivate

Definition at line 78 of file DataResultPanel.java.


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

Copyright © 2012-2018 Basis Technology. Generated on: Fri Mar 22 2019
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.