Class TooltipModifierBase

The TooltipModifierBase is part of the ChartModifier API, which factors out handling of Axis and Chart Label templates, and provides a touch-over templated tooltip, provided by the output of the Hit-Test operation on a IRenderableSeries.

Inheritance
java.lang.Object
ReceiveMotionEventsBase
ChartModifierCore
ChartModifierBase
TouchModifierBase
MasterSlaveTouchModifierBase
TooltipModifierBase
Inherited Members
Namespace:
Assembly: .dll
Syntax
public abstract class TooltipModifierBase extends MasterSlaveTouchModifierBase

Constructors

TooltipModifierBase(TooltipBehaviorBase<?> tooltipBehavior)

Creates a new instance of the TooltipModifierBase class.

Declaration
protected TooltipModifierBase(TooltipBehaviorBase<?> tooltipBehavior)
Parameters
Type Name Description
TooltipBehaviorBase<?> tooltipBehavior

The TooltipBehavior which will be associated with this modifier.

Fields

includedSeriesProperty

Declaration
protected final SmartProperty<IncludedItems> includedSeriesProperty
Field Value
Type Description
SmartProperty<IncludedItems>

showTooltipProperty

Declaration
protected final SmartPropertyBoolean showTooltipProperty
Field Value
Type Description
SmartPropertyBoolean

sourceModeProperty

Declaration
protected final SmartProperty<SourceMode> sourceModeProperty
Field Value
Type Description
SmartProperty<SourceMode>

tooltipBehavior

Declaration
protected final TooltipBehaviorBase<?> tooltipBehavior
Field Value
Type Description
TooltipBehaviorBase<?>

useInterpolationProperty

Declaration
protected final SmartPropertyBoolean useInterpolationProperty
Field Value
Type Description
SmartPropertyBoolean

Methods

applyThemeProvider(IThemeProvider themeProvider)

Applies specified theme to current instance

Declaration
public void applyThemeProvider(IThemeProvider themeProvider)
Parameters
Type Name Description
IThemeProvider themeProvider
Overrides

attachTo(IServiceContainer services)

Declaration
public void attachTo(IServiceContainer services)
Parameters
Type Name Description
IServiceContainer services
Overrides

clearAll()

When overridden in a derived class, this method should clear all markers and tooltips from the SciChartSurface#getModifierSurface().

Declaration
protected void clearAll()
Overrides

detach()

Declaration
public void detach()
Overrides

getAllRenderableSeries()

Declaration
protected final List<renderableSeries.IRenderableSeries> getAllRenderableSeries()
Returns
Type Description
List<IRenderableSeries>

getObservableSeries()

Gets the ObservableCollection of the IRenderableSeries from the parent SciChartSurface

Declaration
protected ObservableCollection<renderableSeries.IRenderableSeries> getObservableSeries()
Returns
Type Description
ObservableCollection<IRenderableSeries>

The ObservableCollection of the IRenderableSeries from the parent SciChartSurface.

getShowTooltip()

Gets a value indicating whether to show tooltip or not.

Declaration
public final boolean getShowTooltip()
Returns
Type Description
boolean

True if modifier should show tooltip, else false.

getSourceMode()

Gets the SourceMode type of series on which interaction is performed.

Declaration
public final SourceMode getSourceMode()
Returns
Type Description
SourceMode

The SourceMode type of series.

getUseInterpolation()

Gets whether the interaction should use interpolation.

Declaration
public final boolean getUseInterpolation()
Returns
Type Description
boolean

True if the interaction will use interpolation, else false.

handleMasterTouchDownEvent(PointF point)

When overridden in a derived class, called to handle the Master ChartModifierBase MotionEvent#ACTION_DOWN

Declaration
protected void handleMasterTouchDownEvent(PointF point)
Parameters
Type Name Description
android.graphics.PointF point
Overrides

handleMasterTouchMoveEvent(PointF point)

When overridden in a derived class, called to handle the Master ChartModifierBase MotionEvent#ACTION_MOVE

Declaration
protected void handleMasterTouchMoveEvent(PointF point)
Parameters
Type Name Description
android.graphics.PointF point
Overrides

handleMasterTouchUpEvent(PointF point)

When overridden in a derived class, called to handle the Master ChartModifierBase MotionEvent#ACTION_UP

Declaration
protected void handleMasterTouchUpEvent(PointF point)
Parameters
Type Name Description
android.graphics.PointF point
Overrides

handleSlaveTouchDownEvent(PointF point)

When overridden in a derived class, called to handle the Slave ChartModifierBase MotionEvent#ACTION_DOWN

Declaration
protected void handleSlaveTouchDownEvent(PointF point)
Parameters
Type Name Description
android.graphics.PointF point
Overrides

handleSlaveTouchMoveEvent(PointF point)

When overridden in a derived class, called to handle the Slave ChartModifierBase MotionEvent#ACTION_MOVE

Declaration
protected void handleSlaveTouchMoveEvent(PointF point)
Parameters
Type Name Description
android.graphics.PointF point
Overrides

handleSlaveTouchUpEvent(PointF point)

When overridden in a derived class, called to handle the Slave ChartModifierBase MotionEvent#ACTION_UP

Declaration
protected void handleSlaveTouchUpEvent(PointF point)
Parameters
Type Name Description
android.graphics.PointF point
Overrides

includeRenderableSeries(renderableSeries.IRenderableSeries renderableSeries, boolean isIncluded)

Includes or excludes IRenderableSeries

Declaration
public void includeRenderableSeries(renderableSeries.IRenderableSeries renderableSeries, boolean isIncluded)
Parameters
Type Name Description
renderableSeries.IRenderableSeries renderableSeries

The IRenderableSeries to include or exclude
boolean isIncluded

True to include, false to exclude

onRenderableSeriesDrasticallyChanged()

Called when RenderableSeries collection drastically changed

Declaration
public void onRenderableSeriesDrasticallyChanged()
Overrides

setShowTooltip(boolean showTooltip)

Sets a value indicating whether to show tooltip or not.

Declaration
public final void setShowTooltip(boolean showTooltip)
Parameters
Type Name Description
boolean showTooltip

Value which indicates whether show tooltip or not.

setSourceMode(SourceMode sourceMode)

Sets the SourceMode type of series on which interaction is performed.

Declaration
public final void setSourceMode(SourceMode sourceMode)
Parameters
Type Name Description
SourceMode sourceMode

The new SourceMode type of series on which interaction is performed.

setUseInterpolation(boolean useInterpolation)

Sets whether the interaction should use interpolation.

Declaration
public final void setUseInterpolation(boolean useInterpolation)
Parameters
Type Name Description
boolean useInterpolation

Value which indicates whether the interaction should use interpolation.