org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/widgets/timegraph/widgets/ITimeDataProvider.java

   1 /*****************************************************************************
   2  * Copyright (c) 2007 Intel Corporation, 2010, 2012 Ericsson.
   3  * All rights reserved. This program and the accompanying materials
   4  * are made available under the terms of the Eclipse Public License v1.0
   5  * which accompanies this distribution, and is available at
   6  * http://www.eclipse.org/legal/epl-v10.html
   7  *
   8  * Contributors:
   9  *   Intel Corporation - Initial API and implementation
  10  *   Ruslan A. Scherbakov, Intel - Initial API and implementation
  11  *   Alvaro Sanchez-Leon - Updated for TMF
  12  *   Patrick Tasse - Refactoring
  13  *
  14  *****************************************************************************/
  15
  16 package org.eclipse.linuxtools.tmf.ui.widgets.timegraph.widgets;
  17
  18 /**
  19  * Time data provider interface, for use in the timegraph widget.
  20  *
  21  * @version 1.0
  22  * @author Alvaro Sanchez-Leon
  23  * @author Patrick Tasse
  24  */
  25 public interface ITimeDataProvider {
  26
  27     long getSelectedTime();
  28
  29     long getBeginTime();
  30
  31     long getEndTime();
  32
  33     long getMinTime();
  34
  35     long getMaxTime();
  36
  37     long getTime0();
  38
  39     long getTime1();
  40
  41     long getMinTimeInterval();
  42
  43     /**
  44      * Updates the time range and notify registered listeners
  45      *
  46      * @param time0
  47      * @param time1
  48      */
  49     void setStartFinishTimeNotify(long time0, long time1);
  50
  51     /**
  52      * Update the time range but do not trigger event notification
  53      *
  54      * @param time0
  55      * @param time1
  56      */
  57     void setStartFinishTime(long time0, long time1);
  58
  59     /**
  60      * Notify registered listeners without updating the time range
  61      */
  62     void notifyStartFinishTime();
  63
  64     /**
  65      * Updates the selected time, adjusts the time range if necessary and notifies
  66      * any registered listeners about the new selected time and new range (if necessary)
  67      *
  68      * @param time - A Time to set
  69      * @param ensureVisible - Ensure visibility of new time (will adjust time range if necessary)
  70      */
  71     public void setSelectedTimeNotify(long time, boolean ensureVisible);
  72
  73     /**
  74      * Updates the selected time and adjusts the time range if necessary
  75      * without notifying registered listeners.
  76      *
  77      * @param time - A Time to set
  78      * @param ensureVisible - Ensure visibility of new time (will adjust time range if necessary)
  79      */
  80     public void setSelectedTime(long time, boolean ensureVisible);
  81
  82     void resetStartFinishTime();
  83
  84     int getNameSpace();
  85
  86     void setNameSpace(int width);
  87
  88     int getTimeSpace();
  89
  90     boolean isCalendarFormat();
  91 }