Package org.eclipse.tracecompass.tmf.ui.views

Class TmfView

java.lang.Object
org.eclipse.core.commands.common.EventManager
org.eclipse.ui.part.WorkbenchPart
org.eclipse.ui.part.ViewPart
org.eclipse.tracecompass.tmf.ui.views.TmfView
All Implemented Interfaces:
org.eclipse.core.runtime.IAdaptable, org.eclipse.core.runtime.IExecutableExtension, ITmfComponent, org.eclipse.ui.IPersistable, org.eclipse.ui.IViewPart, org.eclipse.ui.IWorkbenchPart, org.eclipse.ui.IWorkbenchPart2, org.eclipse.ui.IWorkbenchPart3, org.eclipse.ui.part.IWorkbenchPartOrientation
Direct Known Subclasses:
AbstractSegmentsStatisticsView, AbstractSegmentStoreDensityView, AbstractSegmentStoreTableView, AbstractTimeGraphView, ColorsView, FilterView, HistogramView, TimeChartView, TmfChartView, TmfSynchronizationView
public abstract class TmfView extends org.eclipse.ui.part.ViewPart implements ITmfComponent
Basic abstract TMF view class implementation.
It registers any sub class to the signal manager for receiving and sending TMF signals.
Subclasses may optionally implement the ITmfTimeAligned, ITmfAllowMultiple and ITmfPinnable interfaces to enable those features.
Author:
Francois Chouinard

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    VIEW_ID_SEPARATOR
    The separator used between the primary and secondary id of a view id.

    Fields inherited from interface org.eclipse.ui.IWorkbenchPart

    PROP_TITLE

  • Constructor Summary

    Constructors
    Constructor
    Description
    TmfView(String viewName)
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    broadcast(TmfSignal signal)
    Propagate a signal to all the interested listeners in the same thread of execution.
    void
    broadcastAsync(TmfSignal signal)
    Propagate a signal to all the interested listeners in a separate thread.
    void
    createPartControl(org.eclipse.swt.widgets.Composite parent)
     
    void
    dispose()
    Disposes this view and de-registers itself from the signal manager
    String
    getName()
     
    org.eclipse.swt.widgets.Composite
    getParentComposite()
    Returns the parent control of the view
    boolean
    isPinned()
    Returns whether the view is pinned.

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

    getViewSite, init, init, saveState, setInitializationData

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

    addPartPropertyListener, addPropertyListener, getAdapter, getContentDescription, getOrientation, getPartName, getPartProperties, getPartProperty, getSite, getTitle, getTitleImage, getTitleToolTip, removePartPropertyListener, removePropertyListener, setFocus, setPartProperty, showBusy

    Methods inherited from class java.lang.Object

    equals, 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, getSite, getTitle, getTitleImage, getTitleToolTip, removePropertyListener, setFocus

  • Field Details

    • VIEW_ID_SEPARATOR

      public static final String VIEW_ID_SEPARATOR
      The separator used between the primary and secondary id of a view id.
      Since:
      3.2
      See Also:

  • Constructor Details

    • TmfView

      public TmfView(String viewName)
      Constructor. Creates a TMF view and registers to the signal manager.
      Parameters:
      viewName - A view name

  • Method Details

    • dispose

      public void dispose()
      Disposes this view and de-registers itself from the signal manager
      Specified by:
      dispose in interface ITmfComponent
      Specified by:
      dispose in interface org.eclipse.ui.IWorkbenchPart
      Overrides:
      dispose in class org.eclipse.ui.part.WorkbenchPart

    • getName

      public String getName()
      Specified by:
      getName in interface ITmfComponent
      Returns:
      the component ID (display name)

    • broadcast

      public void broadcast(TmfSignal signal)
      Description copied from interface: ITmfComponent
      Propagate a signal to all the interested listeners in the same thread of execution.
      Specified by:
      broadcast in interface ITmfComponent
      Parameters:
      signal - the signal to broadcast

    • broadcastAsync

      public void broadcastAsync(TmfSignal signal)
      Description copied from interface: ITmfComponent
      Propagate a signal to all the interested listeners in a separate thread.
      Specified by:
      broadcastAsync in interface ITmfComponent
      Parameters:
      signal - the signal to broadcast

    • isPinned

      public boolean isPinned()
      Returns whether the view is pinned.
      Returns:
      if the view is pinned

    • createPartControl

      public 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

    • getParentComposite

      public org.eclipse.swt.widgets.Composite getParentComposite()
      Returns the parent control of the view
      Returns:
      the parent control
      Since:
      1.0