Package org.pepstock.charba.client.positioner

Interface TooltipPositioner

All Known Implementing Classes:

AbstractTooltipPositioner

public interface TooltipPositioner

Interface to be implemented to create a custom tooltip positionier in order address where the tooltip must be showed on canvas.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method	Description
Point	computePosition(IsChart chart, List<DatasetReference> items, Point eventPoint)	Applies own logic to returns the point where the tooltip must be showed.
CustomTooltipPosition	getName()	Returns the name of tooltip position which must be used in chart options.
static boolean	isValid(TooltipPositioner tooltipPositioner)	Returns true if tooltip positioner passed as argument is not null and its name is not null as well.

Method Detail

isValid

static boolean isValid(TooltipPositioner tooltipPositioner)

Returns true if tooltip positioner passed as argument is not null and its name is not null as well.

Parameters:

tooltipPositioner - tooltip positioner to be checked

Returns:

true if tooltip positioner passed as argument is not null and its name is not null

getName

CustomTooltipPosition getName()

Returns the name of tooltip position which must be used in chart options.

Returns:

the name of tooltip position.

See Also:

Tooltips.setPosition(org.pepstock.charba.client.enums.IsTooltipPosition)

computePosition

Point computePosition(IsChart chart,
                      List<DatasetReference> items,
                      Point eventPoint)

Applies own logic to returns the point where the tooltip must be showed.

Parameters:

chart - chart instance

items - list of dataset reference items

eventPoint - the point of event when the method has been invoked

Returns:

the point where the tooltip must be showed. If null, the default tooltip positioner will be used to provide a consistent point where tooltip will be showed