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 import org.eclipse.swt.widgets.ScrollBar;
  24
  25 /**
  26  * <b><u>ITimeAnalysisWidget</u></b>
  27  * <p>
  28  *
  29  * TODO: Implement me. Please.
  30  */
  31 public interface ITimeAnalysisViewer extends ITmfViewer {
  32
  33     public enum TimeFormat {
  34                 RELATIVE, ABSOLUTE
  35         };
  36
  37         /**
  38          * @param e
  39          */
  40         public void controlResized(ControlEvent e);
  41
  42         /**
  43          *
  44          * @param traceArr
  45          * @param start
  46          *            Specifies a fixed start time to the information to be
  47          *            displayed
  48          * @param end
  49          *            Specifies a fixed end time to the information to be displayed
  50          * @param updateTimeBounds
  51          *            If True - Time Range boundaries update is required
  52          */
  53         public abstract void display(ITmfTimeAnalysisEntry[] traceArr, long start,
  54                         long end, boolean updateTimeBounds);
  55
  56         /**
  57          * The start and End time are taken from the limits used by the children
  58          * events
  59          *
  60          * @param traceArr
  61          */
  62         public abstract void display(ITmfTimeAnalysisEntry[] traceArr);
  63
  64         public void addWidgetSelectionListner(ITmfTimeSelectionListener listener);
  65
  66         public void addWidgetTimeScaleSelectionListner(
  67                         ITmfTimeScaleSelectionListener listener);
  68
  69         public void filterTraces();
  70
  71         public ITmfTimeAnalysisEntry getSelectedTrace();
  72
  73         public ISelection getSelection();
  74
  75         public void groupTraces(boolean on);
  76
  77         public boolean isInFocus();
  78
  79         public void removeWidgetSelectionListner(ITmfTimeSelectionListener listener);
  80
  81         public void removeWidgetTimeScaleSelectionListner(
  82                         ITmfTimeScaleSelectionListener listener);
  83
  84         public void resetStartFinishTime();
  85
  86         public void selectNextEvent();
  87
  88         public void selectPrevEvent();
  89
  90         public void selectNextTrace();
  91
  92         public void selectPrevTrace();
  93
  94         public void showLegend();
  95
  96         public void zoomIn();
  97
  98         public void zoomOut();
  99
 100         public void setSelectedTime(long time, boolean ensureVisible, Object source);
 101
 102         public void setSelectedEvent(ITimeEvent event, Object Source);
 103
 104         public void setSelectedTraceTime(ITmfTimeAnalysisEntry trace, long time, Object Source);
 105
 106         public void setSelectVisTimeWindow(long time0, long time1, Object Source);
 107
 108         public void setAcceptSelectionAPIcalls(boolean acceptCalls);
 109
 110         public void setTimeCalendarFormat(boolean toAbsoluteCaltime);
 111
 112         public boolean isCalendarFormat();
 113
 114         public boolean isVisibleVerticalScroll();
 115
 116         public void setVisibleVerticalScroll(boolean visibleVerticalScroll);
 117
 118         public int getBorderWidth();
 119
 120         public void setBorderWidth(int borderWidth);
 121
 122         public int getHeaderHeight();
 123
 124         public void setHeaderHeight(int headerHeight);
 125
 126         public int getItemHeight();
 127
 128         public void setItemHeight(int rowHeight);
 129
 130     public void setMinimumItemWidth(int width);
 131
 132         public void resizeControls();
 133
 134         public void setSelectedTrace(ITmfTimeAnalysisEntry trace);
 135
 136         public ISelection getSelectionTrace();
 137
 138         public void setNameWidthPref(int width);
 139
 140         public int getNameWidthPref(int width);
 141
 142         public void addFilterSelectionListner(ITmfTimeFilterSelectionListener listener);
 143
 144         public void removeFilterSelectionListner(
 145                         ITmfTimeFilterSelectionListener listener);
 146
 147         public int getTimeSpace();
 148
 149         public void itemUpdate(ITmfTimeAnalysisEntry parent, TimeEvent item);
 150
 151         public Control getControl();
 152
 153         public ISelectionProvider getSelectionProvider();
 154
 155         /**
 156          * <p>
 157          * Provide the possibility to control the wait cursor externally
 158          * </p>
 159          * <p>
 160          * e.g. data requests in progress
 161          * </p>
 162          *
 163          * @param waitInd
 164          *            - true change to wait cursor
 165          */
 166         public void waitCursor(boolean waitInd);
 167
 168     public void setFocus();
 169
 170     /**
 171      * Update the time bounds without changing the visible range
 172      *
 173      * @param beginTime
 174      * @param endTime
 175      */
 176     public void setTimeBounds(long beginTime, long endTime);
 177
 178     /**
 179      * Get the horizontal scrollbar
 180      * @return the horizontal scrollbar
 181      */
 182     public ScrollBar getHorizontalBar();
 183
 184     /**
 185      * Get the vertical scrollbar
 186      * @return the vertical scrollbar
 187      */
 188     public ScrollBar getVerticalBar();
 189
 190     /**
 191      * Set the top index
 192      * @param index the top index
 193      */
 194     public void setTopIndex(int index);
 195
 196 }