Package org.eclipse.tracecompass.tmf.ui.widgets.timegraph

Class TimeGraphPresentationProvider

java.lang.Object

org.eclipse.tracecompass.tmf.ui.widgets.timegraph.TimeGraphPresentationProvider

All Implemented Interfaces:

ITimeGraphPresentationProvider

Direct Known Subclasses:

TimeChartAnalysisProvider

public class TimeGraphPresentationProvider
extends Object
implements ITimeGraphPresentationProvider

Provider class for the time graph provider

Since:

3.4

Author:

Patrick Tasse

Field Summary

Fields inherited from interface org.eclipse.tracecompass.tmf.ui.widgets.timegraph.ITimeGraphPresentationProvider

INVISIBLE, TRANSPARENT

Constructor Summary

Constructors

Constructor	Description
TimeGraphPresentationProvider()	Constructor
TimeGraphPresentationProvider(String stateTypeName)	Constructor

Method Summary

Modifier and Type	Method	Description
void	addColorListener(ITimeGraphColorListener listener)	Adds a color settings listener, to be notified when the presentation provider's state colors change.
boolean	displayTimesInTooltip()	Check whether time and duration should be displayed in tooltip (after items from ITimeGraphPresentationProvider.getEventHoverToolTipInfo(ITimeEvent)).
ITmfTimeGraphDrawingHelper	getDrawingHelper()	Returns the drawing helper for this presentation provider.
Map<String,String>	getEventHoverToolTipInfo(ITimeEvent event)	Returns a map of name and value providing additional information to display in the tool tip for this event.
Map<String,String>	getEventHoverToolTipInfo(ITimeEvent event, long hoverTime)	Returns a map of name and value providing additional information to display in the tool tip for this event.
String	getEventName(ITimeEvent event)	Returns the name of this event.
int	getItemHeight(ITimeGraphEntry entry)	Returns the height of this item.
org.eclipse.swt.graphics.Image	getItemImage(ITimeGraphEntry entry)	Provides the image icon for a given entry.
StateItem[]	getStateTable()	Returns table of states with state name to state color relationship.
int	getStateTableIndex(ITimeEvent event)	Returns the index in the state table corresponding to this time event.
String	getStateTypeName()	Returns the name of state types.
String	getStateTypeName(ITimeGraphEntry entry)	Returns the name of state type depending on the given entry.
void	postDrawControl(org.eclipse.swt.graphics.Rectangle bounds, org.eclipse.swt.graphics.GC gc)	Called after drawing the control
void	postDrawEntry(ITimeGraphEntry entry, org.eclipse.swt.graphics.Rectangle bounds, org.eclipse.swt.graphics.GC gc)	Called after drawing an entry
void	postDrawEvent(ITimeEvent event, org.eclipse.swt.graphics.Rectangle bounds, org.eclipse.swt.graphics.GC gc)	Called after drawing an event
void	refresh()	Notifies listeners of the state table change
void	removeColorListener(ITimeGraphColorListener listener)	Removes a color settings listener.
void	setDrawingHelper(ITmfTimeGraphDrawingHelper helper)	Sets this presentation provider's drawing helper.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.tracecompass.tmf.ui.widgets.timegraph.ITimeGraphPresentationProvider

getEventStyle, getFilterInput, getLinkTypeName, getPreferenceKey, getSpecificEventStyle

Constructor Details

TimeGraphPresentationProvider

public TimeGraphPresentationProvider(String stateTypeName)

Constructor

Parameters:

stateTypeName - The state type name

TimeGraphPresentationProvider

public TimeGraphPresentationProvider()

Constructor

Method Details

getStateTypeName

public String getStateTypeName()

Description copied from interface: ITimeGraphPresentationProvider

Returns the name of state types.

Specified by:

getStateTypeName in interface ITimeGraphPresentationProvider

Returns:

the name of state types

getStateTypeName

public String getStateTypeName(ITimeGraphEntry entry)

Description copied from interface: ITimeGraphPresentationProvider

Returns the name of state type depending on the given entry. Note that this overwrites the name which is return by getStateTypeName().

Specified by:

getStateTypeName in interface ITimeGraphPresentationProvider

Parameters:

entry - the entry

Returns:

the name of state type depending on the given entry or null.

getStateTable

public StateItem[] getStateTable()

Description copied from interface: ITimeGraphPresentationProvider

Returns table of states with state name to state color relationship.

Specified by:

getStateTable in interface ITimeGraphPresentationProvider

Returns:

table of states with color and name

See Also:

• ITimeGraphPresentationProvider.getStateTableIndex(org.eclipse.tracecompass.tmf.ui.widgets.timegraph.model.ITimeEvent)

getStateTableIndex

public int getStateTableIndex(ITimeEvent event)

Description copied from interface: ITimeGraphPresentationProvider

Returns the index in the state table corresponding to this time event. The index should correspond to a state in the state table, otherwise the color SWT.COLOR_BLACK will be used. If the index returned is TRANSPARENT, only the event borders will be drawn. If the index returned is INVISIBLE or another negative, the event will not be drawn.

Specified by:

getStateTableIndex in interface ITimeGraphPresentationProvider

Parameters:

event - the time event

Returns:

the corresponding state table index

See Also:

• ITimeGraphPresentationProvider.getStateTable()
• ITimeGraphPresentationProvider.TRANSPARENT
• ITimeGraphPresentationProvider.INVISIBLE

getDrawingHelper

public ITmfTimeGraphDrawingHelper getDrawingHelper()

Description copied from interface: ITimeGraphPresentationProvider

Returns the drawing helper for this presentation provider.

Specified by:

getDrawingHelper in interface ITimeGraphPresentationProvider

Returns:

The drawing helper

setDrawingHelper

public void setDrawingHelper(ITmfTimeGraphDrawingHelper helper)

Description copied from interface: ITimeGraphPresentationProvider

Sets this presentation provider's drawing helper. This helper be needed to know where to draw items, get its coordinates given a time, etc.

Specified by:

setDrawingHelper in interface ITimeGraphPresentationProvider

Parameters:

helper - The drawing helper

postDrawControl

public void postDrawControl(org.eclipse.swt.graphics.Rectangle bounds,
 org.eclipse.swt.graphics.GC gc)

Description copied from interface: ITimeGraphPresentationProvider

Called after drawing the control

Specified by:

postDrawControl in interface ITimeGraphPresentationProvider

Parameters:

bounds - The drawing rectangle

gc - The graphics context

postDrawEntry

public void postDrawEntry(ITimeGraphEntry entry,
 org.eclipse.swt.graphics.Rectangle bounds,
 org.eclipse.swt.graphics.GC gc)

Description copied from interface: ITimeGraphPresentationProvider

Called after drawing an entry

Specified by:

postDrawEntry in interface ITimeGraphPresentationProvider

Parameters:

entry - the entry that was drawn

bounds - the drawing rectangle

gc - the graphics context

postDrawEvent

public void postDrawEvent(ITimeEvent event,
 org.eclipse.swt.graphics.Rectangle bounds,
 org.eclipse.swt.graphics.GC gc)

Description copied from interface: ITimeGraphPresentationProvider

Called after drawing an event

Specified by:

postDrawEvent in interface ITimeGraphPresentationProvider

Parameters:

event - the event that was drawn

bounds - the drawing rectangle

gc - the graphics context

getItemHeight

public int getItemHeight(ITimeGraphEntry entry)

Description copied from interface: ITimeGraphPresentationProvider

Returns the height of this item. This value is ignored if the time graph has a fixed item height.

Specified by:

getItemHeight in interface ITimeGraphPresentationProvider

Parameters:

entry - the entry

Returns:

the item height

See Also:

• TimeGraphViewer.setItemHeight(int)

getItemImage

public org.eclipse.swt.graphics.Image getItemImage(ITimeGraphEntry entry)

Description copied from interface: ITimeGraphPresentationProvider

Provides the image icon for a given entry.

Specified by:

getItemImage in interface ITimeGraphPresentationProvider

Parameters:

entry - the entry

Returns:

the image icon

getEventName

public String getEventName(ITimeEvent event)

Description copied from interface: ITimeGraphPresentationProvider

Returns the name of this event.

Specified by:

getEventName in interface ITimeGraphPresentationProvider

Parameters:

event - The event

Returns:

The event name

getEventHoverToolTipInfo

public Map<String,String> getEventHoverToolTipInfo(ITimeEvent event)

Description copied from interface: ITimeGraphPresentationProvider

Returns a map of name and value providing additional information to display in the tool tip for this event.

Specified by:

getEventHoverToolTipInfo in interface ITimeGraphPresentationProvider

Parameters:

event - the time event

Returns:

a map of tool tip information

getEventHoverToolTipInfo

public Map<String,String> getEventHoverToolTipInfo(ITimeEvent event,
 long hoverTime)

Description copied from interface: ITimeGraphPresentationProvider

Returns a map of name and value providing additional information to display in the tool tip for this event.

Specified by:

getEventHoverToolTipInfo in interface ITimeGraphPresentationProvider

Parameters:

event - the time event

hoverTime - the time corresponding to the mouse hover position

Returns:

a map of tool tip information

displayTimesInTooltip

public boolean displayTimesInTooltip()

Description copied from interface: ITimeGraphPresentationProvider

Check whether time and duration should be displayed in tooltip (after items from ITimeGraphPresentationProvider.getEventHoverToolTipInfo(ITimeEvent)).

Specified by:

displayTimesInTooltip in interface ITimeGraphPresentationProvider

Returns:

true if times and duration should be displayed on tooltip, false otherwise.

addColorListener

public void addColorListener(ITimeGraphColorListener listener)

Description copied from interface: ITimeGraphPresentationProvider

Adds a color settings listener, to be notified when the presentation provider's state colors change.

Specified by:

addColorListener in interface ITimeGraphPresentationProvider

Parameters:

listener - The new listener for color settings changes

removeColorListener

public void removeColorListener(ITimeGraphColorListener listener)

Description copied from interface: ITimeGraphPresentationProvider

Removes a color settings listener.

Specified by:

removeColorListener in interface ITimeGraphPresentationProvider

Parameters:

listener - The color settings listener to remove

refresh

public void refresh()

Notifies listeners of the state table change

Specified by:

refresh in interface ITimeGraphPresentationProvider

Since:

3.2