[290968] Contribution

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.ui / src / org / eclipse / linuxtools / tmf / ui / viewers / timeAnalysis / ITimeAnalysisViewer.java

/*******************************************************************************\r
 * Copyright (c) 2009 Ericsson\r
 * \r
 * All rights reserved. This program and the accompanying materials are\r
 * made available under the terms of the Eclipse Public License v1.0 which\r
 * accompanies this distribution, and is available at\r
 * http://www.eclipse.org/legal/epl-v10.html\r
 * \r
 * Contributors:\r
 *   Alvaro Sanchez-Leon - Initial API and implementation\r
 *******************************************************************************/\r
\r
 package org.eclipse.linuxtools.tmf.ui.viewers.timeAnalysis;\r
\r
import org.eclipse.jface.viewers.ISelection;\r
import org.eclipse.jface.viewers.ISelectionProvider;\r
import org.eclipse.linuxtools.tmf.ui.viewers.ITmfViewer;\r
import org.eclipse.linuxtools.tmf.ui.viewers.timeAnalysis.model.ITimeEvent;\r
import org.eclipse.linuxtools.tmf.ui.viewers.timeAnalysis.model.ITmfTimeAnalysisEntry;\r
import org.eclipse.linuxtools.tmf.ui.viewers.timeAnalysis.model.TimeEvent;\r
import org.eclipse.swt.events.ControlEvent;\r
import org.eclipse.swt.widgets.Control;\r
\r
/**\r
 * <b><u>ITimeAnalysisWidget</u></b>\r
 * <p>\r
 *\r
 * TODO: Implement me. Please.\r
 */\r
public interface ITimeAnalysisViewer extends ITmfViewer {\r
\r
    public enum TimeFormat {\r
		RELATIVE, ABSOLUTE\r
	};\r
\r
	/**\r
	 * @param e\r
	 */\r
	public void controlResized(ControlEvent e);\r
\r
	/**\r
	 * \r
	 * @param traceArr\r
	 * @param start\r
	 *            Specifies a fixed start time to the information to be\r
	 *            displayed\r
	 * @param end\r
	 *            Specifies a fixed end time to the information to be displayed\r
	 */\r
	public abstract void display(ITmfTimeAnalysisEntry[] traceArr, long start, long end);\r
\r
	/**\r
	 * The start and End time are taken from the limits used by the children\r
	 * events\r
	 * \r
	 * @param traceArr\r
	 */\r
	public abstract void display(ITmfTimeAnalysisEntry[] traceArr);\r
\r
	public void addWidgetSelectionListner(ITmfTimeSelectionListener listener);\r
\r
	public void addWidgetTimeScaleSelectionListner(\r
			ITmfTimeScaleSelectionListener listener);\r
\r
	public void filterTraces();\r
\r
	public ITmfTimeAnalysisEntry getSelectedTrace();\r
\r
	public ISelection getSelection();\r
\r
	public void groupTraces(boolean on);\r
\r
	public boolean isInFocus();\r
\r
	public void removeWidgetSelectionListner(ITmfTimeSelectionListener listener);\r
\r
	public void removeWidgetTimeScaleSelectionListner(\r
			ITmfTimeScaleSelectionListener listener);\r
\r
	public void resetStartFinishTime();\r
\r
	public void selectNextEvent();\r
\r
	public void selectPrevEvent();\r
\r
	public void selectNextTrace();\r
\r
	public void selectPrevTrace();\r
\r
	public void showLegend();\r
\r
	public void zoomIn();\r
\r
	public void zoomOut();\r
\r
	public void setSelectedTime(long time, boolean ensureVisible, Object source);\r
\r
	public void setSelectedEvent(ITimeEvent event, Object Source);\r
\r
	public void setSelectedTraceTime(ITmfTimeAnalysisEntry trace, long time, Object Source);\r
\r
	public void setSelectVisTimeWindow(long time0, long time1, Object Source);\r
\r
	public void setAcceptSelectionAPIcalls(boolean acceptCalls);\r
\r
	public void setTimeCalendarFormat(boolean toAbsoluteCaltime);\r
\r
	public boolean isCalendarFormat();\r
\r
	public boolean isVisibleVerticalScroll();\r
\r
	public void setVisibleVerticalScroll(boolean visibleVerticalScroll);\r
\r
	public int getBorderWidth();\r
\r
	public void setBorderWidth(int borderWidth);\r
\r
	public int getHeaderHeight();\r
\r
	public void setHeaderHeight(int headerHeight);\r
\r
	public int getItemHeight();\r
\r
	public void setItemHeight(int rowHeight);\r
\r
	public void resizeControls();\r
\r
	public void setSelectedTrace(ITmfTimeAnalysisEntry trace);\r
\r
	public ISelection getSelectionTrace();\r
\r
	public void setNameWidthPref(int width);\r
\r
	public int getNameWidthPref(int width);\r
\r
	public void addFilterSelectionListner(ITmfTimeFilterSelectionListener listener);\r
\r
	public void removeFilterSelectionListner(\r
			ITmfTimeFilterSelectionListener listener);\r
\r
	public int getTimeSpace();\r
\r
	public void itemUpdate(ITmfTimeAnalysisEntry parent, TimeEvent item);\r
\r
	public Control getControl();\r
\r
	public ISelectionProvider getSelectionProvider();\r
\r
	/**\r
	 * <p>\r
	 * Provide the possibility to control the wait cursor externally\r
	 * </p>\r
	 * <p>\r
	 * e.g. data requests in progress\r
	 * </p>\r
	 * \r
	 * @param waitInd\r
	 *            - true change to wait cursor\r
	 */\r
	public void waitCursor(boolean waitInd);\r
\r
}