Package org.eclipse.emf.ecp.ui.views

Class TreeView

  • All Implemented Interfaces:
    org.eclipse.core.runtime.IAdaptable, org.eclipse.core.runtime.IExecutableExtension, org.eclipse.jface.viewers.ISelectionProvider, org.eclipse.ui.IPersistable, 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
    Direct Known Subclasses:
    ECPProvidersView, ModelExplorerView, ModelRepositoriesView
    public abstract class TreeView
extends org.eclipse.ui.part.ViewPart
implements org.eclipse.jface.viewers.ISelectionProvider, org.eclipse.ui.part.ISetSelectionTarget
    Author:
    Eike Stepper, Eugen Neufeld

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String GLOBAL_ADDITIONS
      ID for the separator in the context menu of the TreeView to add global contributions to (placed on top).

      • Fields inherited from interface org.eclipse.ui.IWorkbenchPart

        PROP_TITLE

    • Constructor Summary

      Constructors 
      Constructor Description
      TreeView​(java.lang.String id)
      Default constructor.

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      void addSelectionChangedListener​(org.eclipse.jface.viewers.ISelectionChangedListener listener)
      protected org.eclipse.jface.viewers.ILabelDecorator createLabelDecorator()
      Creates a label decorator.
      void createPartControl​(org.eclipse.swt.widgets.Composite parent)  
      protected abstract org.eclipse.jface.viewers.TreeViewer createViewer​(org.eclipse.swt.widgets.Composite parent)
      Creates the TreeViewer.
      protected void doubleClicked​(org.eclipse.jface.viewers.DoubleClickEvent event)
      Called if a double click is triggered in the TreeViewer.
      protected void fillContextMenu​(org.eclipse.jface.action.IMenuManager manager)
      Fills the contect menu of the view.
      protected void fillLocalPullDown​(org.eclipse.jface.action.IMenuManager manager)
      Fills the menue of the view.
      protected void fillLocalToolBar​(org.eclipse.jface.action.IToolBarManager manager)
      Fills the toolbar of the view.
      java.lang.String getID()
      Retrieves the ID of this TreeView.
      org.eclipse.jface.action.Action getRefreshAction()
      Return the refresh action, which triggers a reload on the TreeViewer.
      org.eclipse.jface.viewers.IStructuredSelection getSelection()
      org.eclipse.jface.viewers.TreeViewer getViewer()
      Returns JFace TreeViewer used in this TreeViewer.
      void init​(org.eclipse.ui.IViewSite site)  
      void removeSelectionChangedListener​(org.eclipse.jface.viewers.ISelectionChangedListener listener)
      void selectReveal​(org.eclipse.jface.viewers.ISelection selection)
      void setFocus()  
      void setSelection​(org.eclipse.jface.viewers.ISelection selection)
      protected void showMessage​(java.lang.String message)
      Shows a message to the user.

      • Methods inherited from class org.eclipse.ui.part.ViewPart

        checkSite, getViewSite, init, saveState, setContentDescription, setInitializationData, setPartName

      • Methods inherited from class org.eclipse.ui.part.WorkbenchPart

        addPartPropertyListener, addPropertyListener, dispose, 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.core.runtime.IAdaptable

        getAdapter

      • Methods inherited from interface org.eclipse.ui.IWorkbenchPart

        addPropertyListener, dispose, getSite, getTitle, getTitleImage, getTitleToolTip, removePropertyListener

    • Field Detail

      • GLOBAL_ADDITIONS

        public static final java.lang.String GLOBAL_ADDITIONS
        ID for the separator in the context menu of the TreeView to add global contributions to (placed on top).
        See Also:
        Constant Field Values

    • Constructor Detail

      • TreeView

        public TreeView​(java.lang.String id)
        Default constructor.
        Parameters:
        id - the ID of the Tree View, used to identify the TreeView

    • Method Detail

      • getID

        public final java.lang.String getID()
        Retrieves the ID of this TreeView.
        Returns:
        the id as a String

      • getViewer

        public final org.eclipse.jface.viewers.TreeViewer getViewer()
        Returns JFace TreeViewer used in this TreeViewer.
        Returns:
        a TreeViewer

      • getRefreshAction

        public final org.eclipse.jface.action.Action getRefreshAction()
        Return the refresh action, which triggers a reload on the TreeViewer.
        Returns:
        an Action

      • init

        public void init​(org.eclipse.ui.IViewSite site)
          throws org.eclipse.ui.PartInitException
        Specified by:
        init in interface org.eclipse.ui.IViewPart
        Overrides:
        init in class org.eclipse.ui.part.ViewPart
        Throws:
        org.eclipse.ui.PartInitException

      • createPartControl

        public final void createPartControl​(org.eclipse.swt.widgets.Composite parent)
        Specified by:
        createPartControl in interface org.eclipse.ui.IWorkbenchPart
        Specified by:
        createPartControl in class org.eclipse.ui.part.WorkbenchPart

      • setFocus

        public void setFocus()
        Specified by:
        setFocus in interface org.eclipse.ui.IWorkbenchPart
        Specified by:
        setFocus in class org.eclipse.ui.part.WorkbenchPart

      • getSelection

        public org.eclipse.jface.viewers.IStructuredSelection getSelection()
        Specified by:
        getSelection in interface org.eclipse.jface.viewers.ISelectionProvider

      • setSelection

        public void setSelection​(org.eclipse.jface.viewers.ISelection selection)
        Specified by:
        setSelection in interface org.eclipse.jface.viewers.ISelectionProvider

      • addSelectionChangedListener

        public void addSelectionChangedListener​(org.eclipse.jface.viewers.ISelectionChangedListener listener)
        Specified by:
        addSelectionChangedListener in interface org.eclipse.jface.viewers.ISelectionProvider

      • removeSelectionChangedListener

        public void removeSelectionChangedListener​(org.eclipse.jface.viewers.ISelectionChangedListener listener)
        Specified by:
        removeSelectionChangedListener in interface org.eclipse.jface.viewers.ISelectionProvider

      • selectReveal

        public void selectReveal​(org.eclipse.jface.viewers.ISelection selection)
        Specified by:
        selectReveal in interface org.eclipse.ui.part.ISetSelectionTarget

      • showMessage

        protected void showMessage​(java.lang.String message)
        Shows a message to the user.
        Parameters:
        message - the message as a String

      • createLabelDecorator

        protected org.eclipse.jface.viewers.ILabelDecorator createLabelDecorator()
        Creates a label decorator.
        Returns:
        the label decorator to be used by the TreeView

      • createViewer

        protected abstract org.eclipse.jface.viewers.TreeViewer createViewer​(org.eclipse.swt.widgets.Composite parent)
        Creates the TreeViewer. To be implemented by sub classes.
        Parameters:
        parent - the parent composite to place the TreeViewer on.
        Returns:
        the TreeViewer

      • fillLocalPullDown

        protected void fillLocalPullDown​(org.eclipse.jface.action.IMenuManager manager)
        Fills the menue of the view. Can be overridden by sub classes.
        Parameters:
        manager - the IMenuManager to be filled.

      • fillLocalToolBar

        protected void fillLocalToolBar​(org.eclipse.jface.action.IToolBarManager manager)
        Fills the toolbar of the view. Can be overridden by sub classes.
        Parameters:
        manager - the IToolBarManager to be filled.

      • fillContextMenu

        protected void fillContextMenu​(org.eclipse.jface.action.IMenuManager manager)
        Fills the contect menu of the view. Can be overriden by sub classes.
        Parameters:
        manager - the IMenuManager to be filled.

      • doubleClicked

        protected void doubleClicked​(org.eclipse.jface.viewers.DoubleClickEvent event)
        Called if a double click is triggered in the TreeViewer. Can be overridden by sub classes to add some behavior on double click.
        Parameters:
        event - the DoubleClickEvent