projects / deliverable / tracecompass.git / blame
| Commit | Line | Data |
|---|---|---|
| be222f56 PT |
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 | /** | |
| 28 | * @return The selected time | |
| 29 | */ | |
| 30 | long getSelectedTime(); | |
| 31 | ||
| 32 | /** | |
| 33 | * @return The beginning time | |
| 34 | */ | |
| 35 | long getBeginTime(); | |
| 36 | ||
| 37 | /** | |
| 38 | * @return The end time | |
| 39 | */ | |
| 40 | long getEndTime(); | |
| 41 | ||
| 42 | /** | |
| 43 | * @return The minimum time | |
| 44 | */ | |
| 45 | long getMinTime(); | |
| 46 | ||
| 47 | /** | |
| 48 | * @return The maximum time | |
| 49 | */ | |
| 50 | long getMaxTime(); | |
| 51 | ||
| 52 | /** | |
| 53 | * @return The start time of the current selection window | |
| 54 | */ | |
| 55 | long getTime0(); | |
| 56 | ||
| 57 | /** | |
| 58 | * @return The end time of the current selection window | |
| 59 | */ | |
| 60 | long getTime1(); | |
| 61 | ||
| 62 | /** | |
| 63 | * @return The minimal time interval | |
| 64 | */ | |
| 65 | long getMinTimeInterval(); | |
| 66 | ||
| 67 | /** | |
| 68 | * Updates the time range and notify registered listeners | |
| 69 | * | |
| 70 | * @param time0 | |
| 71 | * @param time1 | |
| 72 | */ | |
| 73 | void setStartFinishTimeNotify(long time0, long time1); | |
| 74 | ||
| 75 | /** | |
| 76 | * Update the time range but do not trigger event notification | |
| 77 | * | |
| 78 | * @param time0 | |
| 79 | * @param time1 | |
| 80 | */ | |
| 81 | void setStartFinishTime(long time0, long time1); | |
| 82 | ||
| 83 | /** | |
| 84 | * Notify registered listeners without updating the time range | |
| 85 | */ | |
| 86 | void notifyStartFinishTime(); | |
| 87 | ||
| 88 | /** | |
| 89 | * Updates the selected time, adjusts the time range if necessary and | |
| 90 | * notifies any registered listeners about the new selected time and new | |
| 91 | * range (if necessary) | |
| 92 | * | |
| 93 | * @param time | |
| 94 | * A Time to set | |
| 95 | * @param ensureVisible | |
| 96 | * Ensure visibility of new time (will adjust time range if | |
| 97 | * necessary) | |
| 98 | */ | |
| 99 | public void setSelectedTimeNotify(long time, boolean ensureVisible); | |
| 100 | ||
| 101 | /** | |
| 102 | * Updates the selected time and adjusts the time range if necessary without | |
| 103 | * notifying registered listeners. | |
| 104 | * | |
| 105 | * @param time | |
| 106 | * A Time to set | |
| 107 | * @param ensureVisible | |
| 108 | * Ensure visibility of new time (will adjust time range if | |
| 109 | * necessary) | |
| 110 | */ | |
| 111 | public void setSelectedTime(long time, boolean ensureVisible); | |
| 112 | ||
| 113 | /** | |
| 114 | * Reset the start and end times | |
| 115 | */ | |
| 116 | void resetStartFinishTime(); | |
| 117 | ||
| 118 | /** | |
| 119 | * @return The names' width | |
| 120 | */ | |
| 121 | int getNameSpace(); | |
| 122 | ||
| 123 | /** | |
| 124 | * Set the names' width | |
| 125 | * | |
| 126 | * @param width | |
| 127 | */ | |
| 128 | void setNameSpace(int width); | |
| 129 | ||
| 130 | /** | |
| 131 | * @return The width for timestamps | |
| 132 | */ | |
| 133 | int getTimeSpace(); | |
| 134 | ||
| 135 | /** | |
| 136 | * @return If the calendar format is absolute (true) or relative (false) | |
| 137 | */ | |
| 138 | boolean isCalendarFormat(); | |
| 139 | } |