TPTP 4.5.0 Testing Tools Project
Internal API Specification

org.eclipse.hyades.test.ui.internal.navigator
Class TestNavigator

java.lang.Object
  extended by org.eclipse.core.commands.common.EventManager
      extended by org.eclipse.ui.part.WorkbenchPart
          extended by org.eclipse.ui.part.ViewPart
              extended by org.eclipse.hyades.ui.internal.navigator.Navigator
                  extended by org.eclipse.hyades.ui.internal.navigator.TreeNavigator
                      extended by org.eclipse.hyades.test.ui.internal.navigator.TestNavigator
All Implemented Interfaces:
java.util.EventListener, org.eclipse.core.runtime.IAdaptable, org.eclipse.core.runtime.IExecutableExtension, TestNavigatorProvider.IGlobalProxyNodeListener, org.eclipse.hyades.test.ui.navigator.IProxyNodeListener, org.eclipse.hyades.test.ui.navigator.ITestNavigator, org.eclipse.hyades.ui.internal.navigator.INavigator, org.eclipse.hyades.ui.internal.navigator.ITreeNavigator, org.eclipse.hyades.ui.util.IDisposable, org.eclipse.jface.action.IMenuListener, org.eclipse.jface.util.IPropertyChangeListener, org.eclipse.jface.viewers.IDoubleClickListener, org.eclipse.jface.viewers.IOpenListener, org.eclipse.jface.viewers.ISelectionChangedListener, org.eclipse.swt.events.KeyListener, org.eclipse.swt.internal.SWTEventListener, org.eclipse.ui.IPartListener, org.eclipse.ui.IPersistable, org.eclipse.ui.ISelectionListener, org.eclipse.ui.IViewPart, org.eclipse.ui.IWorkbenchPart, org.eclipse.ui.IWorkbenchPart2, org.eclipse.ui.IWorkbenchPart3, org.eclipse.ui.part.ISetSelectionTarget, org.eclipse.ui.part.IWorkbenchPartOrientation

public class TestNavigator
extends org.eclipse.hyades.ui.internal.navigator.TreeNavigator
implements org.eclipse.ui.ISelectionListener, TestNavigatorProvider.IGlobalProxyNodeListener, org.eclipse.hyades.test.ui.navigator.ITestNavigator

Concreate implementation of the Navigatorfor the Hyades Test objects


Field Summary
static int BACKGROUND_JOB_POOL_SIZE
          The size of the background job pool.
protected static int CP_FOLDER
           
protected static int CP_LOGICAL
           
protected static java.lang.String DIALOGSTORE_HTN_VIEW
           
static java.lang.String ID
          Deprecated. use ITestNavigator.ID instead.
protected static java.lang.String SET_SHOW_EOBJECT_CHILDREN
           
protected static java.lang.String SET_SHOW_FOLDERS
           
protected static java.lang.String SET_SORTER_CRITERIA
           
static int VIEW_ID_LOGICAL
           
static int VIEW_ID_RESOURCE
           
 
Fields inherited from class org.eclipse.hyades.ui.internal.navigator.TreeNavigator
frameList, SET_WORKING_SET, TAG_EXPAND_STATE, TAG_FRAME, workingSetFilter
 
Fields inherited from class org.eclipse.hyades.ui.internal.navigator.Navigator
actionGroup, activeNavigator, ID_POPUP_MENU, initialViewerInput, layout, linkingEnabled, memento, navigatorID, SET_LINK_TO_EDITOR, settings, structuredViewer, TAG_ELEMENT, TAG_FACTORY_ID, TAG_SELECTION, TAG_STORE_VALUE
 
Fields inherited from interface org.eclipse.ui.IWorkbenchPart
PROP_TITLE
 
Constructor Summary
TestNavigator()
          Constructor for TestNavigator
 
Method Summary
protected  void adjustTreeViewer(org.eclipse.jface.viewers.TreeViewer treeViewer)
           
protected  org.eclipse.jface.viewers.IStructuredSelection convertToViewer(org.eclipse.jface.viewers.ISelection selection)
           
protected  void createActions()
           
protected  org.eclipse.hyades.ui.internal.navigator.TreeNavigatorFrameSource createFrameSource()
           
protected  java.lang.Object createViewerInput()
           
 void dispose()
           
 void doubleClick(org.eclipse.jface.viewers.DoubleClickEvent event)
           
protected  boolean editorActivated(org.eclipse.ui.IEditorPart editor)
           
static java.util.Iterator getAllInstancesIterator()
           
 org.eclipse.hyades.test.ui.navigator.IFileProxyManager getCurrentFileProxyManager()
           
 int getCurrentViewIndex()
           
 org.eclipse.core.resources.IFile getFile(java.lang.Object object)
          Returns the file associated to a given object that is located in this navigator.
static FileFactoryManager getFileFactoryManager()
           
static org.eclipse.hyades.test.ui.navigator.IFileProxyManager getFileProxyManager()
          Deprecated.  
static TestNavigatorFilterExtensionsManager getFiltersManager()
          Give access to the filters manager of the test navigator
protected  java.lang.String getHelpContextId()
          Returns the help context id for this navigator or null if no help is provided.
 java.lang.String getID()
           
 java.lang.Object getInitialViewerInput()
           
 FixedSizeJobPool getJobPool()
           
 org.eclipse.ui.plugin.AbstractUIPlugin getPlugin()
           
static java.lang.String getRegisteredTypeName(java.lang.String type)
          Returns the name of the given used in UI.
 org.eclipse.hyades.ui.internal.logicalfolder.LogicalFolder getRootLogicalFolder(java.lang.String name)
          Returns the root logical folder that has the given name or null if there is no such folder.
protected  java.lang.String getStatusLineMessage(org.eclipse.jface.viewers.IStructuredSelection structuredSelection)
           
 java.lang.String getStoreSection()
           
static TestAssetGroupProxyManager getTestAssetGroupProxyManager()
           
static TestNavigator getTestNavigator(org.eclipse.ui.IWorkbenchWindow workbenchWindow)
          Returns the test navigator opened in a given workbench window or null if there isn't any.
static org.eclipse.hyades.test.ui.navigator.ITypeProviderContext getTypeProviderContext()
           
static TypeProviderManager getTypeProviderManager()
           
 void handleChange(int type)
           
 void init(org.eclipse.ui.IViewSite site, org.eclipse.ui.IMemento memento)
           
protected  void initSettings()
           
 boolean isMonitoringResourceChange()
          Returns whether the test navigator is monitoring resource changes
 boolean isShowingEObjectChildren()
          Returns whether the navigator is showing the children of the emf objects.
 boolean isShowingFolders()
          Returns whether the navigator is showing projects and folders.
 boolean isVisibleResource(org.eclipse.core.resources.IResource resource)
           
protected  void linkToEditor(org.eclipse.jface.viewers.IStructuredSelection structuredSelection)
           
protected  java.util.List loadElements(org.eclipse.ui.IMemento memento)
           
protected  void loadSettings()
           
 void nodeChanged(java.lang.Object node)
          Invoked by test providers to notify that a node and its children should be refreshed.
 void nodesChanged()
           
 void registerRootLogcalFolder(org.eclipse.hyades.ui.internal.logicalfolder.LogicalFolder logicalFolder)
          Registers a root logical folder to this test navigator.
 void selectionChanged(org.eclipse.ui.IWorkbenchPart part, org.eclipse.jface.viewers.ISelection selection)
           
 void selectReveal(org.eclipse.jface.viewers.ISelection selection)
           
 void setMonitoringResourceChange(boolean enabled)
          Sets whether the resource navigator should monitor resource changes.
 void setShowingEObjectChildren(boolean enabled)
          Sets whether this navigator's is showing the children of the EMF objects.
 void setShowingFolders(boolean enabled)
          Sets whether this navigator's is showing projects and folders.
 void setView(int viewerIndex)
           
 
Methods inherited from class org.eclipse.hyades.ui.internal.navigator.TreeNavigator
createFrameList, createViewer, createWorkingSetFilter, getFrameList, getFrameName, getFrameToolTipText, getTreeViewer, getWorkingSet, getWorkingSetFilter, initContextMenu, initWorkingSet, loadExpandState, loadFrame, loadMemento, propertyChange, saveExpandState, saveFrame, saveState, setWorkingSet, updateTitle
 
Methods inherited from class org.eclipse.hyades.ui.internal.navigator.Navigator
convertFromViewer, createPartControl, getActionGroup, getLayout, getSettings, getStructuredSelection, getViewContentProvider, getViewer, getViewLabelProvider, isActiveNavigator, isInitialized, isLinkingEnabled, keyPressed, keyReleased, loadSelection, menuAboutToShow, open, partActivated, partBroughtToTop, partClosed, partDeactivated, partOpened, saveElement, saveSelection, selectionChanged, setActionGroup, setFocus, setLayout, setLinkingEnabled, updateActionBars, updateStatusLine
 
Methods inherited from class org.eclipse.ui.part.ViewPart
checkSite, getViewSite, init, setContentDescription, setInitializationData, setPartName
 
Methods inherited from class org.eclipse.ui.part.WorkbenchPart
addPartPropertyListener, addPropertyListener, firePartPropertyChanged, firePropertyChange, getAdapter, getConfigurationElement, getContentDescription, getDefaultImage, getOrientation, getPartName, getPartProperties, getPartProperty, getSite, getTitle, getTitleImage, getTitleToolTip, removePartPropertyListener, removePropertyListener, setPartProperty, setSite, setTitle, setTitleImage, setTitleToolTip, showBusy
 
Methods inherited from class org.eclipse.core.commands.common.EventManager
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eclipse.hyades.test.ui.navigator.ITestNavigator
getStructuredSelection
 
Methods inherited from interface org.eclipse.hyades.ui.internal.navigator.INavigator
getLayout, getSite, getStructuredSelection, getViewer, getViewSite, isInitialized, isLinkingEnabled, setLayout, setLinkingEnabled
 
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

ID

public static final java.lang.String ID
Deprecated. use ITestNavigator.ID instead.
See Also:
Constant Field Values

VIEW_ID_RESOURCE

public static final int VIEW_ID_RESOURCE
See Also:
Constant Field Values

VIEW_ID_LOGICAL

public static final int VIEW_ID_LOGICAL
See Also:
Constant Field Values

BACKGROUND_JOB_POOL_SIZE

public static final int BACKGROUND_JOB_POOL_SIZE
The size of the background job pool. This is the maximal number of background jobs that can run at the same time.

See Also:
Constant Field Values

SET_SHOW_FOLDERS

protected static final java.lang.String SET_SHOW_FOLDERS
See Also:
Constant Field Values

SET_SHOW_EOBJECT_CHILDREN

protected static final java.lang.String SET_SHOW_EOBJECT_CHILDREN
See Also:
Constant Field Values

SET_SORTER_CRITERIA

protected static final java.lang.String SET_SORTER_CRITERIA
See Also:
Constant Field Values

DIALOGSTORE_HTN_VIEW

protected static final java.lang.String DIALOGSTORE_HTN_VIEW
See Also:
Constant Field Values

CP_FOLDER

protected static final int CP_FOLDER
See Also:
Constant Field Values

CP_LOGICAL

protected static final int CP_LOGICAL
See Also:
Constant Field Values
Constructor Detail

TestNavigator

public TestNavigator()
Constructor for TestNavigator

Method Detail

getTestNavigator

public static TestNavigator getTestNavigator(org.eclipse.ui.IWorkbenchWindow workbenchWindow)
Returns the test navigator opened in a given workbench window or null if there isn't any.

Parameters:
workbenchWindow -
Returns:
TestNavigator

getFiltersManager

public static TestNavigatorFilterExtensionsManager getFiltersManager()
Give access to the filters manager of the test navigator

Returns:
filters manager

getFileFactoryManager

public static FileFactoryManager getFileFactoryManager()
Returns:
Returns the fileFactoryManager.

getFileProxyManager

public static org.eclipse.hyades.test.ui.navigator.IFileProxyManager getFileProxyManager()
Deprecated. 

Returns the current fileProxyManager of current window test navigator provider.

Returns:

getCurrentFileProxyManager

public org.eclipse.hyades.test.ui.navigator.IFileProxyManager getCurrentFileProxyManager()

getTypeProviderManager

public static TypeProviderManager getTypeProviderManager()
Returns:
Returns the typeProviderProxyManager.

getTypeProviderContext

public static org.eclipse.hyades.test.ui.navigator.ITypeProviderContext getTypeProviderContext()

getTestAssetGroupProxyManager

public static TestAssetGroupProxyManager getTestAssetGroupProxyManager()

dispose

public void dispose()
Specified by:
dispose in interface org.eclipse.hyades.ui.util.IDisposable
Specified by:
dispose in interface org.eclipse.ui.IWorkbenchPart
Overrides:
dispose in class org.eclipse.hyades.ui.internal.navigator.TreeNavigator
See Also:
IWorkbenchPart.dispose()

getStoreSection

public java.lang.String getStoreSection()
Specified by:
getStoreSection in class org.eclipse.hyades.ui.internal.navigator.Navigator
See Also:
Navigator.getStoreSection()

initSettings

protected void initSettings()
Overrides:
initSettings in class org.eclipse.hyades.ui.internal.navigator.Navigator
See Also:
Navigator.initSettings()

init

public void init(org.eclipse.ui.IViewSite site,
                 org.eclipse.ui.IMemento memento)
          throws org.eclipse.ui.PartInitException
Specified by:
init in interface org.eclipse.ui.IViewPart
Overrides:
init in class org.eclipse.hyades.ui.internal.navigator.Navigator
Throws:
org.eclipse.ui.PartInitException
See Also:
IViewPart.init(org.eclipse.ui.IViewSite, org.eclipse.ui.IMemento)

getFile

public org.eclipse.core.resources.IFile getFile(java.lang.Object object)
Returns the file associated to a given object that is located in this navigator.

Parameters:
object -
Returns:
IFile

setMonitoringResourceChange

public void setMonitoringResourceChange(boolean enabled)
Sets whether the resource navigator should monitor resource changes.

Parameters:
enabled -

isMonitoringResourceChange

public boolean isMonitoringResourceChange()
Returns whether the test navigator is monitoring resource changes


loadSettings

protected void loadSettings()
Overrides:
loadSettings in class org.eclipse.hyades.ui.internal.navigator.TreeNavigator
See Also:
Navigator.loadSettings()

adjustTreeViewer

protected void adjustTreeViewer(org.eclipse.jface.viewers.TreeViewer treeViewer)
Overrides:
adjustTreeViewer in class org.eclipse.hyades.ui.internal.navigator.TreeNavigator
See Also:
TreeNavigator.adjustTreeViewer(org.eclipse.jface.viewers.TreeViewer)

editorActivated

protected boolean editorActivated(org.eclipse.ui.IEditorPart editor)
Specified by:
editorActivated in class org.eclipse.hyades.ui.internal.navigator.Navigator
See Also:
Navigator.editorActivated(org.eclipse.ui.IEditorPart)

linkToEditor

protected void linkToEditor(org.eclipse.jface.viewers.IStructuredSelection structuredSelection)
Specified by:
linkToEditor in class org.eclipse.hyades.ui.internal.navigator.Navigator
See Also:
Navigator.linkToEditor(org.eclipse.jface.viewers.IStructuredSelection)

getPlugin

public org.eclipse.ui.plugin.AbstractUIPlugin getPlugin()
Specified by:
getPlugin in interface org.eclipse.hyades.ui.internal.navigator.INavigator
See Also:
INavigator.getPlugin()

createViewerInput

protected java.lang.Object createViewerInput()
Specified by:
createViewerInput in class org.eclipse.hyades.ui.internal.navigator.Navigator
See Also:
Navigator.createViewerInput()

createActions

protected void createActions()
Specified by:
createActions in class org.eclipse.hyades.ui.internal.navigator.Navigator
See Also:
Navigator.createActions()

isShowingFolders

public boolean isShowingFolders()
Returns whether the navigator is showing projects and folders.

Specified by:
isShowingFolders in interface org.eclipse.hyades.ui.internal.navigator.INavigator
Returns:
true if is showing project and folders, false if not.

setShowingFolders

public void setShowingFolders(boolean enabled)
Sets whether this navigator's is showing projects and folders.

Parameters:
enabled - true to enable, false to disable

isShowingEObjectChildren

public boolean isShowingEObjectChildren()
Returns whether the navigator is showing the children of the emf objects.

Returns:
true if is showing the children, false if not.

setShowingEObjectChildren

public void setShowingEObjectChildren(boolean enabled)
Sets whether this navigator's is showing the children of the EMF objects.

Parameters:
enabled - true to enable, false to disable

getStatusLineMessage

protected java.lang.String getStatusLineMessage(org.eclipse.jface.viewers.IStructuredSelection structuredSelection)
Overrides:
getStatusLineMessage in class org.eclipse.hyades.ui.internal.navigator.Navigator
See Also:
Navigator.getStatusLineMessage(org.eclipse.jface.viewers.IStructuredSelection)

doubleClick

public void doubleClick(org.eclipse.jface.viewers.DoubleClickEvent event)
Specified by:
doubleClick in interface org.eclipse.jface.viewers.IDoubleClickListener
Overrides:
doubleClick in class org.eclipse.hyades.ui.internal.navigator.TreeNavigator
See Also:
IDoubleClickListener.doubleClick(org.eclipse.jface.viewers.DoubleClickEvent)

convertToViewer

protected org.eclipse.jface.viewers.IStructuredSelection convertToViewer(org.eclipse.jface.viewers.ISelection selection)
Overrides:
convertToViewer in class org.eclipse.hyades.ui.internal.navigator.Navigator
See Also:
Navigator.convertToViewer(org.eclipse.jface.viewers.ISelection)

handleChange

public void handleChange(int type)
Specified by:
handleChange in interface org.eclipse.hyades.ui.internal.navigator.INavigator
Overrides:
handleChange in class org.eclipse.hyades.ui.internal.navigator.Navigator
See Also:
INavigator.handleChange(int)

getInitialViewerInput

public java.lang.Object getInitialViewerInput()
Overrides:
getInitialViewerInput in class org.eclipse.hyades.ui.internal.navigator.Navigator
See Also:
Navigator.getInitialViewerInput()

createFrameSource

protected org.eclipse.hyades.ui.internal.navigator.TreeNavigatorFrameSource createFrameSource()
Overrides:
createFrameSource in class org.eclipse.hyades.ui.internal.navigator.TreeNavigator
See Also:
TreeNavigator.createFrameSource()

registerRootLogcalFolder

public void registerRootLogcalFolder(org.eclipse.hyades.ui.internal.logicalfolder.LogicalFolder logicalFolder)
Registers a root logical folder to this test navigator.

Parameters:
logicalFolder -

getRootLogicalFolder

public org.eclipse.hyades.ui.internal.logicalfolder.LogicalFolder getRootLogicalFolder(java.lang.String name)
Returns the root logical folder that has the given name or null if there is no such folder.

Parameters:
name -

loadElements

protected java.util.List loadElements(org.eclipse.ui.IMemento memento)
Overrides:
loadElements in class org.eclipse.hyades.ui.internal.navigator.Navigator
See Also:
Navigator.loadElements(org.eclipse.ui.IMemento)

getHelpContextId

protected java.lang.String getHelpContextId()
Returns the help context id for this navigator or null if no help is provided.

Overrides:
getHelpContextId in class org.eclipse.hyades.ui.internal.navigator.Navigator
Returns:
String

getID

public java.lang.String getID()
Specified by:
getID in interface org.eclipse.hyades.ui.internal.navigator.INavigator
Overrides:
getID in class org.eclipse.hyades.ui.internal.navigator.Navigator

isVisibleResource

public boolean isVisibleResource(org.eclipse.core.resources.IResource resource)

selectionChanged

public void selectionChanged(org.eclipse.ui.IWorkbenchPart part,
                             org.eclipse.jface.viewers.ISelection selection)
Specified by:
selectionChanged in interface org.eclipse.ui.ISelectionListener
Overrides:
selectionChanged in class org.eclipse.hyades.ui.internal.navigator.Navigator
See Also:
ISelectionListener.selectionChanged(org.eclipse.ui.IWorkbenchPart, org.eclipse.jface.viewers.ISelection)

setView

public void setView(int viewerIndex)

getCurrentViewIndex

public int getCurrentViewIndex()
Returns:
Returns the currentViewIndex.

nodeChanged

public void nodeChanged(java.lang.Object node)
Invoked by test providers to notify that a node and its children should be refreshed.

Specified by:
nodeChanged in interface org.eclipse.hyades.test.ui.navigator.IProxyNodeListener

nodesChanged

public void nodesChanged()
Specified by:
nodesChanged in interface TestNavigatorProvider.IGlobalProxyNodeListener

getAllInstancesIterator

public static java.util.Iterator getAllInstancesIterator()
Returns:

selectReveal

public void selectReveal(org.eclipse.jface.viewers.ISelection selection)
Specified by:
selectReveal in interface org.eclipse.hyades.test.ui.navigator.ITestNavigator
Specified by:
selectReveal in interface org.eclipse.ui.part.ISetSelectionTarget
Overrides:
selectReveal in class org.eclipse.hyades.ui.internal.navigator.Navigator

getRegisteredTypeName

public static java.lang.String getRegisteredTypeName(java.lang.String type)
Returns the name of the given used in UI. This name is declared in the extension of org.eclipse.hyades.ui.typeDescriptions

Parameters:
type - a test type.
Returns:
the exposed name of the given type.

getJobPool

public FixedSizeJobPool getJobPool()

TPTP 4.5.0 Testing Tools Project
Internal API Specification