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

Inherits TopComponent, org.sleuthkit.autopsy.corecomponentinterfaces.DataResult, and Provider.

Public Member Functions

 DataResultTopComponent (boolean isMain, String title)
 
ExplorerManager getExplorerManager ()
 
int getPersistenceType ()
 
void open ()
 
List< DataResultViewergetViewers ()
 
void componentOpened ()
 
void componentClosed ()
 
String getPreferredID ()
 
void setNode (Node selectedNode)
 
void setTitle (String title)
 
void setPath (String pathText)
 
boolean isMain ()
 
boolean canClose ()
 
void resetTabs (Node selectedNode)
 
void setSelectedNodes (Node[] selected)
 
Node getRootNode ()
 

Static Public Member Functions

static void initInstance (String pathText, Node givenNode, int totalMatches, DataResultTopComponent newDataResult)
 
static DataResultTopComponent createInstance (String title, String pathText, Node givenNode, int totalMatches)
 
static DataResultTopComponent createInstance (String title, final String mode, String pathText, Node givenNode, int totalMatches, DataContentTopComponent dataContentWindow)
 
static DataResultTopComponent createInstance (String title)
 
static List< String > getActiveComponentIds ()
 

Protected Member Functions

String preferredID ()
 

Private Member Functions

void customizeComponent (boolean isMain, String title)
 
void initComponents ()
 
void setCustomMode ()
 

Private Attributes

ExplorerManager explorerManager = new ExplorerManager()
 
DataResultPanel dataResultPanel
 
boolean isMain
 
String customModeName
 

Static Private Attributes

static final Logger logger = Logger.getLogger(DataResultTopComponent.class.getName())
 
static final List< String > activeComponentIds = Collections.synchronizedList(new ArrayList<String>())
 

Detailed Description

Top component which displays results (top-right editor mode by default).

There is a main tc instance that responds to directory tree selections. Others can also create an additional result viewer tc using one of the factory methods, that can be:

For embedding custom data result in other top components window, use DataResultPanel component instead, since we cannot nest top components.

Encapsulates the internal DataResultPanel and delegates to it.

Implements DataResult interface by delegating to the encapsulated DataResultPanel.

Definition at line 54 of file DataResultTopComponent.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.DataResultTopComponent ( boolean  isMain,
String  title 
)

Create a new data result top component

Parameters
isMainwhether it is the main, application default result viewer, there can be only 1 main result viewer
titletitle of the data result window

Definition at line 72 of file DataResultTopComponent.java.

References org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.customizeComponent(), and org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.initComponents().

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

Member Function Documentation

boolean org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.canClose ( )
void org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.componentClosed ( )

Definition at line 263 of file DataResultTopComponent.java.

void org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.componentOpened ( )
static DataResultTopComponent org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.createInstance ( String  title,
String  pathText,
Node  givenNode,
int  totalMatches 
)
static

Creates a new non-default DataResult component and initializes it

Parameters
titleTitle of the component window
pathTextDescriptive text about the source of the nodes displayed
givenNodeThe new root node
totalMatchesCardinality of root node's children
Returns
a new, not default, initialized DataResultTopComponent instance

Definition at line 140 of file DataResultTopComponent.java.

References org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.DataResultTopComponent(), and org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.initInstance().

static DataResultTopComponent org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.createInstance ( String  title,
final String  mode,
String  pathText,
Node  givenNode,
int  totalMatches,
DataContentTopComponent  dataContentWindow 
)
static

Creates a new non-default DataResult component linked with a custom data content, and initializes it.

Parameters
titleTitle of the component window
modecustom mode to dock this custom TopComponent to
pathTextDescriptive text about the source of the nodes displayed
givenNodeThe new root node
totalMatchesCardinality of root node's children
dataContentWindowa handle to data content top component window to
Returns
a new, not default, initialized DataResultTopComponent instance

Definition at line 160 of file DataResultTopComponent.java.

References org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.DataResultTopComponent(), and org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.initInstance().

static DataResultTopComponent org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.createInstance ( String  title)
static

Creates a new non-default DataResult component. You probably want to use initInstance after it

Parameters
title
Returns
a new, not default, not fully initialized DataResultTopComponent instance

Definition at line 174 of file DataResultTopComponent.java.

References org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.DataResultTopComponent().

void org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.customizeComponent ( boolean  isMain,
String  title 
)
private
static List<String> org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.getActiveComponentIds ( )
static

Get a list with names of active windows ids, e.g. for the menus

Returns

Definition at line 189 of file DataResultTopComponent.java.

References org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.activeComponentIds.

ExplorerManager org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.getExplorerManager ( )
int org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.getPersistenceType ( )

Definition at line 218 of file DataResultTopComponent.java.

String org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.getPreferredID ( )

Gets the unique TopComponent ID of this class.

Returns
preferredID the unique ID

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataResult.

Definition at line 275 of file DataResultTopComponent.java.

Node org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.getRootNode ( )
List<DataResultViewer> org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.getViewers ( )

Get child viewers within this DataResult

Returns

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataResult.

Definition at line 233 of file DataResultTopComponent.java.

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

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

References org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.dataResultPanel.

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

static void org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.initInstance ( String  pathText,
Node  givenNode,
int  totalMatches,
DataResultTopComponent  newDataResult 
)
static

Initialize previously created tc instance with additional data

Parameters
pathText
givenNode
totalMatches
newDataResultpreviously created with createInstance() uninitialized instance

Definition at line 119 of file DataResultTopComponent.java.

References org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.open(), org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.setNode(), and org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.setPath().

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

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

Checks if this is the main (uncloseable) instance of DataResult

Returns
true if it is the main instance, otherwise false

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataResult.

Definition at line 295 of file DataResultTopComponent.java.

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

void org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.open ( )
String org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.preferredID ( )
protected

Definition at line 270 of file DataResultTopComponent.java.

void org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.resetTabs ( Node  selectedNode)

Resets the tabs based on the selected Node. If the selected node is null or not supported, disable that tab as well.

Parameters
selectedNodethe selected content Node

Definition at line 310 of file DataResultTopComponent.java.

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

void org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.setCustomMode ( )
private
void org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.setNode ( Node  selectedNode)
void org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.setPath ( String  pathText)

Sets the descriptive context text at the top of the pane.

Parameters
pathTextDescriptive text giving context for the current results

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataResult.

Definition at line 290 of file DataResultTopComponent.java.

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

Referenced by org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.initInstance(), and org.sleuthkit.autopsy.directorytree.DirectoryTreeTopComponent.respondSelection().

void org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.setSelectedNodes ( Node[]  selected)
void org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.setTitle ( String  title)

Sets the title of this TopComponent

Parameters
titlethe given title (String)

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataResult.

Definition at line 285 of file DataResultTopComponent.java.

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

Member Data Documentation

final List<String> org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.activeComponentIds = Collections.synchronizedList(new ArrayList<String>())
staticprivate
String org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.customModeName
private

Definition at line 60 of file DataResultTopComponent.java.

DataResultPanel org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.dataResultPanel
private
ExplorerManager org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.explorerManager = new ExplorerManager()
private
boolean org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.isMain
private

Definition at line 59 of file DataResultTopComponent.java.

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

Definition at line 56 of file DataResultTopComponent.java.


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

Copyright © 2012-2015 Basis Technology. Generated on: Mon Oct 19 2015
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.