TPTP 4.1.0 Platform Project
Public API Specification

org.eclipse.tptp.platform.analysis.engine.ui.engineview
Class AbstractEngineView

java.lang.Object
  extended byorg.eclipse.ui.part.WorkbenchPart
      extended byorg.eclipse.ui.part.ViewPart
          extended byorg.eclipse.tptp.platform.analysis.engine.ui.engineview.AbstractEngineView
All Implemented Interfaces:
org.eclipse.core.runtime.IAdaptable, IEngineView, org.eclipse.core.runtime.IExecutableExtension, org.eclipse.ui.IPersistable, org.eclipse.ui.IViewPart, org.eclipse.ui.IWorkbenchPart, org.eclipse.ui.IWorkbenchPart2, org.eclipse.ui.part.IWorkbenchPartOrientation
Direct Known Subclasses:
CodeReviewView

public abstract class AbstractEngineView
extends org.eclipse.ui.part.ViewPart
implements IEngineView, org.eclipse.core.runtime.IExecutableExtension

AbstractEngineView


Field Summary
protected  BasicViewerFilter contentFilter
           
 
Fields inherited from interface org.eclipse.ui.IWorkbenchPart
PROP_TITLE
 
Constructor Summary
AbstractEngineView()
          Constructor.
 
Method Summary
 void addFilterGroup(IEngineViewFilterGroup filterGroup)
          Add a filter group.
 void addViewProvider(IEngineViewProvider provider)
          Add a view provider.
 void cancelAnalysis()
          Stop the analyzis.
protected  EngineContextMenuManager createEngineContextMenuManager()
           
 void createPartControl(org.eclipse.swt.widgets.Composite parent)
          Create part control.
protected  SearchBox createSearchBox(org.eclipse.swt.widgets.Composite parent)
           
protected  void createToolBarActions(org.eclipse.jface.action.IToolBarManager manager)
           
protected  void displayStatus(org.eclipse.jface.viewers.IStructuredSelection selection)
           
 void dispose()
          Dispose.
protected  ResultSetBuilder getBuilder()
           
protected  java.lang.String getDetailsViewId()
           
 IEngine getEngine()
          Get the engine.
protected  EngineContextMenuManager getEngineContextMenuManager()
           
protected  EngineLookup getEngineLookup()
           
protected abstract  java.lang.String getPreferencesCategory()
           
protected abstract  java.lang.String getPreferencesId()
           
 IResultSet getResults()
          Get the result set.
 org.eclipse.jface.viewers.TreeViewer getTreeViewer()
          Get the tree viewer.
 IEngineViewProvider getViewProvider()
          Get the view provider.
 IEngineViewProvider[] getViewProviders()
          Get the view providers.
 boolean isRunningAnalysis()
          Is the analysis running.
protected  void launchDetails(org.eclipse.jface.viewers.IStructuredSelection selection)
           
protected  void newSelection(org.eclipse.jface.viewers.IStructuredSelection selection, boolean activate)
           
 void runAnalysis(IEngineListener listener)
          Analyze.
 void setEngine(IEngine engine)
          Set hte engine.
protected  void setEngine(java.lang.String id)
           
 void setFocus()
          Set the focus.
 void setInitializationData(org.eclipse.core.runtime.IConfigurationElement config, java.lang.String propertyName, java.lang.Object data)
          Initialization.
 void setViewProvider(IEngineViewProvider currentProvider)
          Set a view provider.
protected abstract  void updatePartName()
           
 
Methods inherited from class org.eclipse.ui.part.ViewPart
checkSite, getViewSite, init, init, saveState, setContentDescription, setPartName
 
Methods inherited from class org.eclipse.ui.part.WorkbenchPart
addPropertyListener, firePropertyChange, getAdapter, getConfigurationElement, getContentDescription, getDefaultImage, getOrientation, getPartName, getSite, getTitle, getTitleImage, getTitleToolTip, removePropertyListener, setSite, setTitle, setTitleImage, setTitleToolTip, showBusy
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eclipse.ui.IViewPart
getViewSite, init, init, saveState
 
Methods inherited from interface org.eclipse.ui.IWorkbenchPart
addPropertyListener, getSite, getTitle, getTitleImage, getTitleToolTip, removePropertyListener
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 

Field Detail

contentFilter

protected BasicViewerFilter contentFilter
Constructor Detail

AbstractEngineView

public AbstractEngineView()
Constructor.

Method Detail

setInitializationData

public void setInitializationData(org.eclipse.core.runtime.IConfigurationElement config,
                                  java.lang.String propertyName,
                                  java.lang.Object data)
Initialization.

Specified by:
setInitializationData in interface org.eclipse.core.runtime.IExecutableExtension

getResults

public IResultSet getResults()
Get the result set.

Specified by:
getResults in interface IEngineView
Returns:

getEngine

public IEngine getEngine()
Get the engine.

Specified by:
getEngine in interface IEngineView
Returns:

setEngine

public void setEngine(IEngine engine)
Set hte engine.

Specified by:
setEngine in interface IEngineView
Parameters:
engine -

addViewProvider

public void addViewProvider(IEngineViewProvider provider)
Add a view provider.

Specified by:
addViewProvider in interface IEngineView
Parameters:
provider -

getViewProviders

public IEngineViewProvider[] getViewProviders()
Get the view providers.

Specified by:
getViewProviders in interface IEngineView
Returns:

setViewProvider

public void setViewProvider(IEngineViewProvider currentProvider)
Set a view provider.

Specified by:
setViewProvider in interface IEngineView
Parameters:
currentProvider -

getViewProvider

public IEngineViewProvider getViewProvider()
Get the view provider.

Specified by:
getViewProvider in interface IEngineView
Returns:

addFilterGroup

public void addFilterGroup(IEngineViewFilterGroup filterGroup)
Add a filter group.

Specified by:
addFilterGroup in interface IEngineView
Parameters:
filterGroup -

getTreeViewer

public org.eclipse.jface.viewers.TreeViewer getTreeViewer()
Get the tree viewer.

Specified by:
getTreeViewer in interface IEngineView
Returns:

isRunningAnalysis

public boolean isRunningAnalysis()
Is the analysis running.

Specified by:
isRunningAnalysis in interface IEngineView
Returns:

runAnalysis

public void runAnalysis(IEngineListener listener)
Analyze.

Specified by:
runAnalysis in interface IEngineView
Parameters:
listener -

cancelAnalysis

public void cancelAnalysis()
Stop the analyzis.

Specified by:
cancelAnalysis in interface IEngineView

createSearchBox

protected SearchBox createSearchBox(org.eclipse.swt.widgets.Composite parent)

createPartControl

public void createPartControl(org.eclipse.swt.widgets.Composite parent)
Create part control.

Specified by:
createPartControl in interface org.eclipse.ui.IWorkbenchPart

setFocus

public void setFocus()
Set the focus.

Specified by:
setFocus in interface org.eclipse.ui.IWorkbenchPart

dispose

public void dispose()
Dispose.

Specified by:
dispose in interface org.eclipse.ui.IWorkbenchPart

createEngineContextMenuManager

protected EngineContextMenuManager createEngineContextMenuManager()

getBuilder

protected ResultSetBuilder getBuilder()

getEngineLookup

protected EngineLookup getEngineLookup()

createToolBarActions

protected void createToolBarActions(org.eclipse.jface.action.IToolBarManager manager)

updatePartName

protected abstract void updatePartName()

getPreferencesCategory

protected abstract java.lang.String getPreferencesCategory()

getPreferencesId

protected abstract java.lang.String getPreferencesId()

newSelection

protected void newSelection(org.eclipse.jface.viewers.IStructuredSelection selection,
                            boolean activate)

launchDetails

protected void launchDetails(org.eclipse.jface.viewers.IStructuredSelection selection)

displayStatus

protected void displayStatus(org.eclipse.jface.viewers.IStructuredSelection selection)

setEngine

protected void setEngine(java.lang.String id)

getEngineContextMenuManager

protected EngineContextMenuManager getEngineContextMenuManager()

getDetailsViewId

protected java.lang.String getDetailsViewId()
                                     throws java.lang.Exception
Throws:
java.lang.Exception

TPTP 4.1.0 Platform Project
Public API Specification