Package org.eclipse.tracecompass.tmf.ui.viewers.xychart

Class TmfBaseProvider

java.lang.Object

org.eclipse.tracecompass.tmf.ui.viewers.xychart.TmfBaseProvider

Direct Known Subclasses:

TmfClosestDataPointTooltipProvider, TmfCommonXLineChartTooltipProvider, TmfHistogramTooltipProvider, TmfMouseDragProvider, TmfMouseDragZoomProvider, TmfMouseSelectionProvider, TmfMouseWheelZoomProvider, TmfSimpleTooltipProvider

public abstract class TmfBaseProvider
extends Object

Base class for any provider such as tool tip, zoom and selection providers.

Since:

6.0

Author:

Bernd Hufmann

Constructor Summary

Constructors

Constructor	Description
TmfBaseProvider(ITmfChartTimeProvider tmfChartViewer)	Standard constructor.

Method Summary

Modifier and Type	Method	Description
void	dispose()	Method deregisters provider from chart viewer.
ITmfChartTimeProvider	getChartViewer()	Returns the chart viewer reference.
List<@NonNull IXYSeries>	getSeries()	Gets the series
TmfAbstractToolTipHandler	getTooltipHandler()	Get a tooltip handler, if available
IAxis	getXAxis()	Get the X axis
IAxis	getYAxis()	Get the Y Axis
void	redraw()	Causes the window to be redrawn by invoking a paint request.
void	refresh()	Method to refresh the viewer.
void	setToolTipText(String tooltip)	Sets the basic tooltip text it is recommended to use TmfAbstractToolTipHandler instead

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TmfBaseProvider

public TmfBaseProvider(ITmfChartTimeProvider tmfChartViewer)

Standard constructor.

Parameters:

tmfChartViewer - The parent histogram object

Method Details

getChartViewer

public ITmfChartTimeProvider getChartViewer()

Returns the chart viewer reference.

Returns:

the chart viewer reference

getSeries

public List<@NonNull IXYSeries> getSeries()

Gets the series

Returns:

the series

getXAxis

public IAxis getXAxis()

Get the X axis

Returns:

the X axis

getYAxis

public IAxis getYAxis()

Get the Y Axis

Returns:

the Y axis

redraw

public void redraw()

Causes the window to be redrawn by invoking a paint request.

setToolTipText

public void setToolTipText(String tooltip)

Sets the basic tooltip text it is recommended to use TmfAbstractToolTipHandler instead

Parameters:

tooltip - the tooltip string

getTooltipHandler

public TmfAbstractToolTipHandler getTooltipHandler()

Get a tooltip handler, if available

Returns:

the tooltip handler

dispose

public void dispose()

Method deregisters provider from chart viewer. Subclasses may override this method to dispose any resources.

refresh

public void refresh()

Method to refresh the viewer. It will redraw the viewer.