edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView Class Reference

Abstract class of view-part for different types of views:

calling context view (top down)
callers view (bottom-down)
flat view (static)
thread scope view (not implemented yet, but it will shows metric of a thread).

More...

Inheritance diagram for edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView:

[legend]

Collaboration diagram for edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView:

[legend]

List of all members.

Classes
class	ScopeMouseListener
class	ScopeViewTreeAction
	Actions/menus for Scope view tree. More...
Public Member Functions
	AbstractBaseScopeView ()
void	createPartControl (Composite aParent)
	Create the content of the view.
void	dispose ()
void	setInput (Database db, RootScope scope, boolean keepColumnStatus)
	Update the data input for Scope View, depending also on the scope.
void	initDatabase (Database db, RootScope scope, boolean keepColumnStatus)
void	setViewTitle (String sName)
	Modify the title of the view.
void	setFocus ()
ScopeViewActions	getViewActions ()
ScopeTreeViewer	getTreeViewer ()
	return the tree of this viewer (even though there's no experiment active)
Experiment	getExperiment ()
RootScope	getRootScope ()
Database	getDatabase ()
abstract void	updateDisplay ()
	Tell children to update the content with the new database Update the content of the tree view when a new experiment is loaded.
Protected Member Functions
Composite	createToolBarArea (Composite parent)
	Create the toolbar layout.
CoolBar	initToolbar (Composite toolbarArea)
	Create and Initialize coolbar, set the layout and return the coolbar.
abstract void	initTableColumns (boolean keepColumnStatus)
abstract ScopeViewActions	createActions (Composite parent, CoolBar coolbar)
	The derived class has to implement this method to create its own actions For instance, caller view and cct view has the same actions but flat view may have additional actions (flattening .
abstract void	mouseDownEvent (Event event)
abstract void	createAdditionalContextMenu (IMenuManager mgr, Scope scope)
abstract AbstractContentProvider	getScopeContentProvider ()
abstract void	enableFilter (boolean isEnabled)
abstract CellLabelProvider	getLabelProvider ()
Protected Attributes
ScopeTreeViewer	treeViewer
Database	database
RootScope	myRootScope
ColumnViewerSorter	sorterTreeColumn
ScopeViewActions	objViewActions
CoolBar	objCoolbar
	bar composite for placing toolbar and tool items
Private Member Functions
void	displayFileEditor (Scope scope)
	Display the source code of the node in the editor area.
boolean	isItemSelected ()
	Helper method to know if an item has been selected.
Scope	getSelectedItem ()
	Helper method to retrieve the selected item.
void	fillContextMenu (IMenuManager mgr)
	Creating the context submenu for the view TODO Created only the line selected.
void	copyToClipboard ()
	Procedure to copy the selected items into string clipboard.
void	createContextMenu ()
	Creating context menu manager.
Private Attributes
EditorManager	editorSourceCode
Clipboard	cb = null
GC	gc = null
ISourceProviderListener	listener
Action	acZoomin
	Menu action to zoom-in a node.
Action	acZoomout
	Menu action to zoom a node.

Detailed Description

Abstract class of view-part for different types of views:

calling context view (top down)
callers view (bottom-down)
flat view (static)
thread scope view (not implemented yet, but it will shows metric of a thread).

Definition at line 66 of file AbstractBaseScopeView.java.

Constructor & Destructor Documentation

edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.AbstractBaseScopeView ( )

Definition at line 89 of file AbstractBaseScopeView.java.

References edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.enableFilter(), and edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.listener.

Member Function Documentation

void edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.copyToClipboard ( ) [private]

Procedure to copy the selected items into string clipboard.

Definition at line 268 of file AbstractBaseScopeView.java.

References edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.cb, edu.rice.cs.hpc.viewer.scope.ScopeViewActions.getContent(), edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.objViewActions, and edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.treeViewer.

Referenced by edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.fillContextMenu().

abstract ScopeViewActions edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.createActions	(	Composite	parent,
		CoolBar	coolbar
	)			`[protected, pure virtual]`

The derived class has to implement this method to create its own actions For instance, caller view and cct view has the same actions but flat view may have additional actions (flattening .

..)

Parameters:

	parent
	coolbar

Returns:

Implemented in edu.rice.cs.hpc.viewer.scope.bottomup.CallerScopeView, edu.rice.cs.hpc.viewer.scope.flat.FlatScopeView, and edu.rice.cs.hpc.viewer.scope.topdown.ScopeView.

Referenced by edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.createPartControl().

abstract void edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.createAdditionalContextMenu	(	IMenuManager	mgr,
		Scope	scope
	)			`[protected, pure virtual]`

Implemented in edu.rice.cs.hpc.viewer.scope.bottomup.CallerScopeView, edu.rice.cs.hpc.viewer.scope.flat.FlatScopeView, and edu.rice.cs.hpc.viewer.scope.topdown.ScopeView.

Referenced by edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.fillContextMenu().

void edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.createContextMenu ( ) [private]

Creating context menu manager.

Definition at line 283 of file AbstractBaseScopeView.java.

References edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.fillContextMenu(), edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.isItemSelected(), and edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.treeViewer.

Referenced by edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.createPartControl().

void edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.createPartControl ( Composite aParent )

Create the content of the view.

add listener when left button mouse is clicked On MAC it doesn't matter which button, but on Windows, we need to make sure !

Add Listener for change of selection so that every change will update the status of the toolbar buttons (able or disabled)

Definition at line 324 of file AbstractBaseScopeView.java.

Composite edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.createToolBarArea ( Composite parent ) [protected]

Create the toolbar layout.

Parameters:

parent

Returns:

Definition at line 447 of file AbstractBaseScopeView.java.

Referenced by edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.createPartControl().

void edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.displayFileEditor ( Scope scope ) [private]

Display the source code of the node in the editor area.

Parameters:

node

the current OR selected node

Definition at line 124 of file AbstractBaseScopeView.java.

References edu.rice.cs.hpc.viewer.editor.EditorManager.displayFileEditor(), edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.editorSourceCode, edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.objViewActions, and edu.rice.cs.hpc.viewer.scope.ScopeViewActions.showErrorMessage().

Referenced by edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.ScopeMouseListener.displaySourceCode(), and edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.fillContextMenu().

void edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.dispose ( )

Reimplemented in edu.rice.cs.hpc.viewer.scope.BaseScopeView.

Definition at line 473 of file AbstractBaseScopeView.java.

References edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.gc.

abstract void edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.enableFilter ( boolean isEnabled ) [protected, pure virtual]

Implemented in edu.rice.cs.hpc.viewer.scope.BaseScopeView.

Referenced by edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.AbstractBaseScopeView().

void edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.fillContextMenu ( IMenuManager mgr ) [private]

Creating the context submenu for the view TODO Created only the line selected.

Parameters:

mgr

Fix bug which appears when the user wants to see the context menu of the top row of the table (the aggregate metrics)

Definition at line 188 of file AbstractBaseScopeView.java.

Referenced by edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.createContextMenu().

Database edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.getDatabase ( )

Definition at line 550 of file AbstractBaseScopeView.java.

References edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.database.

Referenced by edu.rice.cs.hpc.viewer.actions.ShowView.execute().

Experiment edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.getExperiment ( )

Definition at line 536 of file AbstractBaseScopeView.java.

References edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.database, and edu.rice.cs.hpc.viewer.window.Database.getExperiment().

Referenced by edu.rice.cs.hpc.viewer.scope.BaseScopeView.enableFilter(), edu.rice.cs.hpc.viewer.actions.ResetPerspective.execute(), edu.rice.cs.hpc.viewer.actions.CloseDatabase.execute(), edu.rice.cs.hpc.viewer.util.BaseWindowTitle.setTitle(), and edu.rice.cs.hpc.viewer.scope.BaseScopeView.updateDisplay().

abstract CellLabelProvider edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.getLabelProvider ( ) [protected, pure virtual]

Implemented in edu.rice.cs.hpc.viewer.scope.bottomup.CallerScopeView, edu.rice.cs.hpc.viewer.scope.flat.FlatScopeView, and edu.rice.cs.hpc.viewer.scope.topdown.ScopeView.

Referenced by edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.createPartControl().

RootScope edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.getRootScope ( )

Definition at line 546 of file AbstractBaseScopeView.java.

References edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.myRootScope.

Referenced by edu.rice.cs.hpc.viewer.actions.ShowView.execute().

abstract AbstractContentProvider edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.getScopeContentProvider ( ) [protected, pure virtual]

Implemented in edu.rice.cs.hpc.viewer.scope.bottomup.CallerScopeView, edu.rice.cs.hpc.viewer.scope.flat.FlatScopeView, and edu.rice.cs.hpc.viewer.scope.topdown.ScopeView.

Referenced by edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.createPartControl().

Scope edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.getSelectedItem ( ) [private]

Helper method to retrieve the selected item.

Returns:

Fix bug which appears when the user wants to see the context menu of the top row of the table (the aggregate metrics)

Definition at line 169 of file AbstractBaseScopeView.java.

References edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.treeViewer.

Referenced by edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.fillContextMenu().

ScopeTreeViewer edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.getTreeViewer ( )

return the tree of this viewer (even though there's no experiment active)

Returns:

Definition at line 528 of file AbstractBaseScopeView.java.

References edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.treeViewer.

Referenced by edu.rice.cs.hpc.viewer.scope.topdown.ScopeView.getColumnMouseDown(), and edu.rice.cs.hpc.viewer.actions.ShowView.DatabaseLabelProvider.getText().

ScopeViewActions edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.getViewActions ( )

Definition at line 521 of file AbstractBaseScopeView.java.

References edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.objViewActions.

Referenced by edu.rice.cs.hpc.viewer.scope.ScopeViewActionsGUI.showHideColumnsAllViews().

void edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.initDatabase	(	Database	db,
		RootScope	scope,
		boolean	keepColumnStatus
	)

Definition at line 496 of file AbstractBaseScopeView.java.

References edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.database, edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.initTableColumns(), edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.myRootScope, edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.objViewActions, edu.rice.cs.hpc.viewer.scope.ScopeViewActions.setTreeViewer(), and edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.treeViewer.

Referenced by edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.setInput().

abstract void edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.initTableColumns ( boolean keepColumnStatus ) [protected, pure virtual]

Implemented in edu.rice.cs.hpc.viewer.scope.BaseScopeView.

Referenced by edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.initDatabase().

CoolBar edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.initToolbar ( Composite toolbarArea ) [protected]

Create and Initialize coolbar, set the layout and return the coolbar.

Parameters:

toolbarArea

Returns:

Definition at line 460 of file AbstractBaseScopeView.java.

Referenced by edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.createPartControl().

boolean edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.isItemSelected ( ) [private]

Helper method to know if an item has been selected.

Returns:: true if an item is selected, false otherwise

Definition at line 161 of file AbstractBaseScopeView.java.

References edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.treeViewer.

Referenced by edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.createContextMenu().

abstract void edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.mouseDownEvent ( Event event ) [protected, pure virtual]

Implemented in edu.rice.cs.hpc.viewer.scope.bottomup.CallerScopeView, edu.rice.cs.hpc.viewer.scope.flat.FlatScopeView, and edu.rice.cs.hpc.viewer.scope.topdown.ScopeView.

Referenced by edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.ScopeMouseListener.handleEvent().

void edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.setFocus ( )

Definition at line 517 of file AbstractBaseScopeView.java.

References edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.treeViewer.

void edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.setInput	(	Database	db,
		RootScope	scope,
		boolean	keepColumnStatus
	)

Update the data input for Scope View, depending also on the scope.

Definition at line 485 of file AbstractBaseScopeView.java.

References edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.initDatabase(), and edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.updateDisplay().

Referenced by edu.rice.cs.hpc.viewer.actions.ShowView.execute(), and edu.rice.cs.hpc.viewer.experiment.ExperimentView.openView().

void edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.setViewTitle ( String sName )

Modify the title of the view.

Parameters:

sName

Definition at line 514 of file AbstractBaseScopeView.java.

abstract void edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.updateDisplay ( ) [pure virtual]

Tell children to update the content with the new database Update the content of the tree view when a new experiment is loaded.

Implemented in edu.rice.cs.hpc.viewer.scope.BaseScopeView.

Referenced by edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.setInput().

Member Data Documentation

Action edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.acZoomin [private]

Initial value:

 new Action("Zoom-in"){
        public void run() {
            objViewActions.zoomIn();
        }
    }

Menu action to zoom-in a node.

Definition at line 142 of file AbstractBaseScopeView.java.

Referenced by edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.fillContextMenu().

Action edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.acZoomout [private]

Initial value:

 new Action("Zoom-out"){
        public void run() {
            objViewActions.zoomOut();
        }
    }

Menu action to zoom a node.

Definition at line 151 of file AbstractBaseScopeView.java.

Referenced by edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.fillContextMenu().

Clipboard edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.cb = null [private]

Definition at line 76 of file AbstractBaseScopeView.java.

Referenced by edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.copyToClipboard().

Database edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.database [protected]

Definition at line 70 of file AbstractBaseScopeView.java.

Referenced by edu.rice.cs.hpc.viewer.scope.topdown.ScopeView.createAdditionalContextMenu(), edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.getDatabase(), edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.getExperiment(), edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.initDatabase(), edu.rice.cs.hpc.viewer.scope.BaseScopeView.initTableColumns(), and edu.rice.cs.hpc.viewer.scope.BaseScopeView.updateDisplay().

EditorManager edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.editorSourceCode [private]

Definition at line 75 of file AbstractBaseScopeView.java.

Referenced by edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.displayFileEditor().

GC edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.gc = null [private]

Definition at line 77 of file AbstractBaseScopeView.java.

Referenced by edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.createPartControl(), and edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.dispose().

ISourceProviderListener edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.listener [private]

Definition at line 79 of file AbstractBaseScopeView.java.

Referenced by edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.AbstractBaseScopeView().

RootScope edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.myRootScope [protected]

Definition at line 71 of file AbstractBaseScopeView.java.

Referenced by edu.rice.cs.hpc.viewer.scope.BaseScopeView.enableFilter(), edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.getRootScope(), edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.initDatabase(), edu.rice.cs.hpc.viewer.scope.BaseScopeView.initTableColumns(), and edu.rice.cs.hpc.viewer.scope.BaseScopeView.updateDisplay().

CoolBar edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.objCoolbar [protected]

bar composite for placing toolbar and tool items

Definition at line 84 of file AbstractBaseScopeView.java.

Referenced by edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.createPartControl().

ScopeViewActions edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.objViewActions [protected]

Definition at line 73 of file AbstractBaseScopeView.java.

ColumnViewerSorter edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.sorterTreeColumn [protected]

Definition at line 72 of file AbstractBaseScopeView.java.

Referenced by edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.createPartControl(), and edu.rice.cs.hpc.viewer.scope.BaseScopeView.initTableColumns().

ScopeTreeViewer edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.treeViewer [protected]

Definition at line 68 of file AbstractBaseScopeView.java.

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

edu.rice.cs.hpc.viewer/src/edu/rice/cs/hpc/viewer/scope/AbstractBaseScopeView.java

edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView Class Reference

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation