edu.rice.cs.hpc.viewer.scope.flat.FlatScopeViewActions Class Reference

Inheritance diagram for edu.rice.cs.hpc.viewer.scope.flat.FlatScopeViewActions:
Inheritance graph
[legend]
Collaboration diagram for edu.rice.cs.hpc.viewer.scope.flat.FlatScopeViewActions:
Collaboration graph
[legend]

List of all members.

Public Types

enum  ActionType { ZoomIn, ZoomOut }

Public Member Functions

 FlatScopeViewActions (Shell shell, IWorkbenchWindow window, Composite parent, CoolBar coolbar)
void flatten ()
 Flatten the tree one level more.
void unflatten ()
 Unflatten flattened tree (tree has to be flattened before).
boolean canUnflatten ()
void checkStates (Scope nodeSelected)
 An abstract method to be implemented: check the state of buttons for the selected node Each action (either caller view, calling context view or flat view) may have different implementation for this verification.
void checkStates ()
void updateContent (Experiment exp, RootScope scope)
 The tree has been updated or has new content.
void setTreeViewer (ScopeTreeViewer tree)
 Update the content of tree viewer.
void showInfoMessage (String sMsg)
void showErrorMessage (String strMsg)
 Show an error message on the message bar (closed to the toolbar) and wait for 5 seconds before removing the message.
void showHotCallPath ()
 show the hot path below the selected node in the tree
Scope getSelectedNode ()
 Retrieve the selected node.
void zoomIn ()
 Zoom-in the children.
void zoomOut ()
 Zoom-out the node.
ScopeZoom getScopeZoom ()
 retrieve the class scope zoom of this object
void addExtNewMetric ()
 create a new metric based on a free expression
void resizeColumns ()
 Resize the columns.
String getContent (TreeItem[]items, String sSeparator)
 Retrieve the content of the table into a string.
String getContent (TreePath[]elements, String sSeparator)
 Function to copy all visible nodes into a buffer string.
boolean shouldZoomInBeEnabled (Scope node)
 Check if zoom-in button should be enabled.
boolean shouldZoomOutBeEnabled ()
 In case there is no selected node, we determine the zoom-out button can be enabled only and only if we have at least one item in the stack.
void checkNodeButtons ()
 Check if zooms and hot-path button need to be disabled or not This is required to solve bug no 132: https://outreach.scidac.gov/tracker/index.php?func=detail&aid=132&group_id=22&atid=169.
void disableButtons ()
 Disable buttons.
void setColumnStatus (boolean[]status)

Static Public Attributes

static double fTHRESHOLD = 0.6

Protected Member Functions

Composite createGUI (Composite parent, CoolBar coolbar)
 Create your own specific GUI.
void registerAction (IActionType type)
void addTreeColumn (TreeColumn colMetric)
 add a new column for metric

Protected Attributes

ScopeTreeViewer treeViewer
RootScope myRootScope
ScopeZoom objZoom = null
IWorkbenchWindow objWindow
IScopeActionsGUI objActionsGUI
Composite parent
Shell objShell

Private Types

enum  FlatAction { Flatten, Unflatten }

Private Member Functions

void pushElementStates ()
 store the current expanded elements into a stack
void popElementStates ()
 recover the latest expanded element into stack
void updateAction (IActionType type, Scope root)
void addChildren (Scope node, Scope arrNodes)

Private Attributes

Stack< ScopestackFlatNodes
Stack< Object[]> stackExpandedNodes
Stack< IActionTypestackActions

Detailed Description

Author:
laksonoadhianto

Definition at line 23 of file FlatScopeViewActions.java.


Member Enumeration Documentation

Enumerator:
ZoomIn 
ZoomOut 

Definition at line 46 of file ScopeViewActions.java.

Enumerator:
Flatten 
Unflatten 

Definition at line 25 of file FlatScopeViewActions.java.


Constructor & Destructor Documentation

edu.rice.cs.hpc.viewer.scope.flat.FlatScopeViewActions.FlatScopeViewActions ( Shell  shell,
IWorkbenchWindow  window,
Composite  parent,
CoolBar  coolbar 
)

Member Function Documentation

void edu.rice.cs.hpc.viewer.scope.flat.FlatScopeViewActions.addChildren ( Scope  node,
Scope  arrNodes 
) [private]
void edu.rice.cs.hpc.viewer.scope.ScopeViewActions.addExtNewMetric (  )  [inherited]
void edu.rice.cs.hpc.viewer.scope.ScopeViewActions.addTreeColumn ( TreeColumn  colMetric  )  [protected, inherited]
boolean edu.rice.cs.hpc.viewer.scope.flat.FlatScopeViewActions.canUnflatten (  ) 
void edu.rice.cs.hpc.viewer.scope.ScopeViewActions.checkNodeButtons (  )  [virtual, inherited]
void edu.rice.cs.hpc.viewer.scope.flat.FlatScopeViewActions.checkStates (  )  [virtual]
void edu.rice.cs.hpc.viewer.scope.flat.FlatScopeViewActions.checkStates ( Scope  nodeSelected  )  [virtual]

An abstract method to be implemented: check the state of buttons for the selected node Each action (either caller view, calling context view or flat view) may have different implementation for this verification.

Parameters:
nodeSelected 

Implements edu.rice.cs.hpc.viewer.scope.ScopeViewActions.

Definition at line 144 of file FlatScopeViewActions.java.

References edu.rice.cs.hpc.viewer.scope.ScopeZoom.canZoomIn(), edu.rice.cs.hpc.viewer.scope.flat.FlatScopeViewActions.checkStates(), edu.rice.cs.hpc.viewer.scope.IScopeActionsGUI.enableHotCallPath(), edu.rice.cs.hpc.viewer.scope.IScopeActionsGUI.enableZoomIn(), edu.rice.cs.hpc.viewer.scope.ScopeActions.objActionsGUI, and edu.rice.cs.hpc.viewer.scope.ScopeViewActions.objZoom.

Composite edu.rice.cs.hpc.viewer.scope.flat.FlatScopeViewActions.createGUI ( Composite  parent,
CoolBar  coolbar 
) [protected, virtual]
void edu.rice.cs.hpc.viewer.scope.ScopeViewActions.disableButtons (  )  [inherited]
void edu.rice.cs.hpc.viewer.scope.flat.FlatScopeViewActions.flatten (  ) 
String edu.rice.cs.hpc.viewer.scope.ScopeViewActions.getContent ( TreePath[]  elements,
String  sSeparator 
) [inherited]

Function to copy all visible nodes into a buffer string.

Parameters:
elements 
sSeparator 
Returns:

Definition at line 482 of file ScopeViewActions.java.

References edu.rice.cs.hpc.viewer.scope.ScopeViewActions.getContent().

String edu.rice.cs.hpc.viewer.scope.ScopeViewActions.getContent ( TreeItem[]  items,
String  sSeparator 
) [inherited]

Retrieve the content of the table into a string.

Parameters:
items (list of items to be exported)
colMetrics (hidden column not included)
sSeparator (separator)
Returns:
String: content of the table

Definition at line 427 of file ScopeViewActions.java.

References edu.rice.cs.hpc.viewer.scope.ScopeTreeViewer.getTextBasedOnColumnStatus(), and edu.rice.cs.hpc.viewer.scope.ScopeViewActions.treeViewer.

Referenced by edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.copyToClipboard(), edu.rice.cs.hpc.viewer.scope.ScopeViewActionsGUI.exportCSV(), and edu.rice.cs.hpc.viewer.scope.ScopeViewActions.getContent().

ScopeZoom edu.rice.cs.hpc.viewer.scope.ScopeViewActions.getScopeZoom (  )  [inherited]

retrieve the class scope zoom of this object

Returns:

Definition at line 332 of file ScopeViewActions.java.

References edu.rice.cs.hpc.viewer.scope.ScopeViewActions.objZoom.

Scope edu.rice.cs.hpc.viewer.scope.ScopeViewActions.getSelectedNode (  )  [inherited]
void edu.rice.cs.hpc.viewer.scope.flat.FlatScopeViewActions.popElementStates (  )  [private]
void edu.rice.cs.hpc.viewer.scope.flat.FlatScopeViewActions.pushElementStates (  )  [private]
void edu.rice.cs.hpc.viewer.scope.flat.FlatScopeViewActions.registerAction ( IActionType  type  )  [protected, virtual]
void edu.rice.cs.hpc.viewer.scope.ScopeViewActions.resizeColumns (  )  [virtual, inherited]
void edu.rice.cs.hpc.viewer.scope.ScopeActions.setColumnStatus ( boolean[]  status  )  [inherited]
void edu.rice.cs.hpc.viewer.scope.ScopeViewActions.setTreeViewer ( ScopeTreeViewer  tree  )  [virtual, inherited]
boolean edu.rice.cs.hpc.viewer.scope.ScopeViewActions.shouldZoomInBeEnabled ( Scope  node  )  [inherited]

Check if zoom-in button should be enabled.

Parameters:
node 
Returns:

Definition at line 506 of file ScopeViewActions.java.

References edu.rice.cs.hpc.viewer.scope.ScopeZoom.canZoomIn(), and edu.rice.cs.hpc.viewer.scope.ScopeViewActions.objZoom.

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

boolean edu.rice.cs.hpc.viewer.scope.ScopeViewActions.shouldZoomOutBeEnabled (  )  [inherited]

In case there is no selected node, we determine the zoom-out button can be enabled only and only if we have at least one item in the stack.

Returns:

Definition at line 515 of file ScopeViewActions.java.

References edu.rice.cs.hpc.viewer.scope.ScopeZoom.canZoomOut(), and edu.rice.cs.hpc.viewer.scope.ScopeViewActions.objZoom.

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

void edu.rice.cs.hpc.viewer.scope.ScopeViewActions.showErrorMessage ( String  strMsg  )  [inherited]
void edu.rice.cs.hpc.viewer.scope.ScopeViewActions.showHotCallPath (  )  [inherited]
void edu.rice.cs.hpc.viewer.scope.ScopeViewActions.showInfoMessage ( String  sMsg  )  [inherited]
void edu.rice.cs.hpc.viewer.scope.flat.FlatScopeViewActions.unflatten (  ) 
void edu.rice.cs.hpc.viewer.scope.flat.FlatScopeViewActions.updateAction ( IActionType  type,
Scope  root 
) [private]
void edu.rice.cs.hpc.viewer.scope.ScopeViewActions.updateContent ( Experiment  exp,
RootScope  scope 
) [virtual, inherited]
void edu.rice.cs.hpc.viewer.scope.ScopeViewActions.zoomIn (  )  [inherited]
void edu.rice.cs.hpc.viewer.scope.ScopeViewActions.zoomOut (  )  [inherited]

Member Data Documentation

double edu.rice.cs.hpc.viewer.scope.ScopeActions.fTHRESHOLD = 0.6 [static, inherited]

Definition at line 22 of file ScopeActions.java.

IWorkbenchWindow edu.rice.cs.hpc.viewer.scope.ScopeViewActions.objWindow [protected, inherited]
Composite edu.rice.cs.hpc.viewer.scope.ScopeActions.parent [protected, inherited]

Definition at line 24 of file ScopeActions.java.


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

Generated on 5 May 2015 for HPCVIEWER by  doxygen 1.6.1