org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/viewers/timeAnalysis/ITimeAnalysisViewer.java

   1 /*******************************************************************************
   2  * Copyright (c) 2009, 2010 Ericsson
   3  *
   4  * All rights reserved. This program and the accompanying materials are
   5  * made available under the terms of the Eclipse Public License v1.0 which
   6  * accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *   Alvaro Sanchez-Leon - Initial API and implementation
  11  *******************************************************************************/
  12
  13  package org.eclipse.linuxtools.tmf.ui.viewers.timeAnalysis;
  14
  15 import org.eclipse.jface.viewers.ISelection;
  16 import org.eclipse.jface.viewers.ISelectionProvider;
  17 import org.eclipse.linuxtools.tmf.ui.viewers.ITmfViewer;
  18 import org.eclipse.linuxtools.tmf.ui.viewers.timeAnalysis.model.ITimeEvent;
  19 import org.eclipse.linuxtools.tmf.ui.viewers.timeAnalysis.model.ITmfTimeAnalysisEntry;
  20 import org.eclipse.linuxtools.tmf.ui.viewers.timeAnalysis.model.TimeEvent;
  21 import org.eclipse.swt.events.ControlEvent;
  22 import org.eclipse.swt.widgets.Control;
  23
  24 /**
  25  * <b><u>ITimeAnalysisWidget</u></b>
  26  * <p>
  27  *
  28  * TODO: Implement me. Please.
  29  */
  30 public interface ITimeAnalysisViewer extends ITmfViewer {
  31
  32     public enum TimeFormat {
  33                 RELATIVE, ABSOLUTE
  34         };
  35
  36         /**
  37          * @param e
  38          */
  39         public void controlResized(ControlEvent e);
  40
  41         /**
  42          *
  43          * @param traceArr
  44          * @param start
  45          *            Specifies a fixed start time to the information to be
  46          *            displayed
  47          * @param end
  48          *            Specifies a fixed end time to the information to be displayed
  49          * @param updateTimeBounds
  50          *            If True - Time Range boundaries update is required
  51          */
  52         public abstract void display(ITmfTimeAnalysisEntry[] traceArr, long start,
  53                         long end, boolean updateTimeBounds);
  54
  55         /**
  56          * The start and End time are taken from the limits used by the children
  57          * events
  58          *
  59          * @param traceArr
  60          */
  61         public abstract void display(ITmfTimeAnalysisEntry[] traceArr);
  62
  63         public void addWidgetSelectionListner(ITmfTimeSelectionListener listener);
  64
  65         public void addWidgetTimeScaleSelectionListner(
  66                         ITmfTimeScaleSelectionListener listener);
  67
  68         public void filterTraces();
  69
  70         public ITmfTimeAnalysisEntry getSelectedTrace();
  71
  72         public ISelection getSelection();
  73
  74         public void groupTraces(boolean on);
  75
  76         public boolean isInFocus();
  77
  78         public void removeWidgetSelectionListner(ITmfTimeSelectionListener listener);
  79
  80         public void removeWidgetTimeScaleSelectionListner(
  81                         ITmfTimeScaleSelectionListener listener);
  82
  83         public void resetStartFinishTime();
  84
  85         public void selectNextEvent();
  86
  87         public void selectPrevEvent();
  88
  89         public void selectNextTrace();
  90
  91         public void selectPrevTrace();
  92
  93         public void showLegend();
  94
  95         public void zoomIn();
  96
  97         public void zoomOut();
  98
  99         public void setSelectedTime(long time, boolean ensureVisible, Object source);
 100
 101         public void setSelectedEvent(ITimeEvent event, Object Source);
 102
 103         public void setSelectedTraceTime(ITmfTimeAnalysisEntry trace, long time, Object Source);
 104
 105         public void setSelectVisTimeWindow(long time0, long time1, Object Source);
 106
 107         public void setAcceptSelectionAPIcalls(boolean acceptCalls);
 108
 109         public void setTimeCalendarFormat(boolean toAbsoluteCaltime);
 110
 111         public boolean isCalendarFormat();
 112
 113         public boolean isVisibleVerticalScroll();
 114
 115         public void setVisibleVerticalScroll(boolean visibleVerticalScroll);
 116
 117         public int getBorderWidth();
 118
 119         public void setBorderWidth(int borderWidth);
 120
 121         public int getHeaderHeight();
 122
 123         public void setHeaderHeight(int headerHeight);
 124
 125         public int getItemHeight();
 126
 127         public void setItemHeight(int rowHeight);
 128
 129         public void resizeControls();
 130
 131         public void setSelectedTrace(ITmfTimeAnalysisEntry trace);
 132
 133         public ISelection getSelectionTrace();
 134
 135         public void setNameWidthPref(int width);
 136
 137         public int getNameWidthPref(int width);
 138
 139         public void addFilterSelectionListner(ITmfTimeFilterSelectionListener listener);
 140
 141         public void removeFilterSelectionListner(
 142                         ITmfTimeFilterSelectionListener listener);
 143
 144         public int getTimeSpace();
 145
 146         public void itemUpdate(ITmfTimeAnalysisEntry parent, TimeEvent item);
 147
 148         public Control getControl();
 149
 150         public ISelectionProvider getSelectionProvider();
 151
 152         /**
 153          * <p>
 154          * Provide the possibility to control the wait cursor externally
 155          * </p>
 156          * <p>
 157          * e.g. data requests in progress
 158          * </p>
 159          *
 160          * @param waitInd
 161          *            - true change to wait cursor
 162          */
 163         public void waitCursor(boolean waitInd);
 164
 165     public void setFocus();
 166
 167 }