uk.ac.kcl.cch.jb.pliny.views.utils
Interface IResourceTreeView

All Superinterfaces:
org.eclipse.core.runtime.IAdaptable, org.eclipse.ui.IPersistable, org.eclipse.ui.IViewPart, org.eclipse.ui.IWorkbenchPart
All Known Implementing Classes:
NoteSearchView, ResourceExplorerView

public interface IResourceTreeView
extends org.eclipse.ui.IViewPart

all ViewParts that wish to implement a Resource Explorer like GUI should implement this interface. Note that it extends Eclipse's org.eclipse.ui.IViewPart.

Author:
John Bradley
See Also:
ResourceExplorerView, NoteSearchView

Field Summary
 
Fields inherited from interface org.eclipse.ui.IWorkbenchPart
PROP_TITLE
 
Method Summary
 org.eclipse.gef.commands.CommandStack getCommandStack()
          returns the view's CommandStack.
 org.eclipse.jface.viewers.TreeViewer getMyViewer()
          return the main tree viewer that displays items in this View.
 Vector getSelectedObjectsToOpen()
          returns a Vector containing Pliny Model elements that are selected and ready to open in their own editors.
 Vector getSelectedResourceExplorerItems()
          returns a Vector containing instances of IResourceExplorerItems that are currently selected by the user.
 
Methods inherited from interface org.eclipse.ui.IViewPart
getViewSite, init, init, saveState
 
Methods inherited from interface org.eclipse.ui.IWorkbenchPart
addPropertyListener, createPartControl, dispose, getSite, getTitle, getTitleImage, getTitleToolTip, removePropertyListener, setFocus
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 

Method Detail

getMyViewer

public org.eclipse.jface.viewers.TreeViewer getMyViewer()
return the main tree viewer that displays items in this View.

Returns:
the main TreeViewer.

getSelectedResourceExplorerItems

public Vector getSelectedResourceExplorerItems()
returns a Vector containing instances of IResourceExplorerItems that are currently selected by the user.

Returns:
a Vector of IResourceExplorerItems.

getSelectedObjectsToOpen

public Vector getSelectedObjectsToOpen()
returns a Vector containing Pliny Model elements that are selected and ready to open in their own editors. This code needs to contain special handling code to take care of the special needs of items under the 'DisplayedIn' category.

Returns:
Vector of Pliny Model elements

getCommandStack

public org.eclipse.gef.commands.CommandStack getCommandStack()
returns the view's CommandStack.

Returns:
CommandStack for the view.