com.telerik.widget.chart.visualization.behaviors

Class ChartPopupBehavior

java.lang.Object

com.telerik.android.common.PropertyManager

com.telerik.widget.chart.visualization.behaviors.ChartBehavior

com.telerik.widget.chart.visualization.behaviors.ChartPopupBehavior

All Implemented Interfaces:

TooltipAdapter

Direct Known Subclasses:

ChartTooltipBehavior, ChartTrackBallBehavior

public abstract class ChartPopupBehavior
extends ChartBehavior
implements TooltipAdapter

Chart behaviour that adds tooltip functionality to the chart instance so that individual data points can be observed in more detail following the user's gestures.

Constructor Summary

Constructors

Constructor and Description
ChartPopupBehavior(Context context) Creates an instance of ChartPopupBehavior.

Method Summary

Modifier and Type	Method and Description
boolean	alignTooltipVertically() States whether the tooltip should be placed vertically or horizontally to the currently selected target.
RectF	availableLayoutSlot() Gets the layout slot in which the popup will be arranged.
boolean	close() Closes the popup if needed.
ChartDataContext	extractTooltipContext(DataPoint point) Extracts data context for a given data point using a ValueExtractor
ChartDataContext	extractTooltipContext(Point location) Extracts context data for a given location.
boolean	getApplyDefaultStyles() Gets a value determining whether to apply the default styles or not.
TooltipContextNeededListener	getContextNeededListener() Gets the current listener responsible for providing context to the tooltip.
ChartDataContext	getLastChartContext() Gets the previous chart data context if there is one.
float	getMaxTouchDistanceTolerance() Gets the max touch target distance of the behavior.
RadRect	getPlotAreaClip() Gets the clip of the current plot area.
TooltipPresenterBase	getPopupPresenter() Gets the presenter that renders this behavior.
Object[]	getTooltipData(Object context) Gets the data for the tooltip using the passed context.
boolean	isTooltipDisplayed() Gets a value stating whether the tooltip is currently being displayed.
boolean	open(DataPoint dataPoint) Attempts to open the popup and returns a boolean stating the result of this attempt.
boolean	open(Point location, Point rawLocation) Attempts to open the popup and returns a boolean stating the result of this attempt.
Point	rawOffset() The offset from the touch event according to the current target view instance and the world coordinates of the same touch event.
void	setApplyDefaultStyles(boolean applyDefaultStyles) Sets a value determining whether to apply the default styles or not.
void	setMaxTouchDistanceTolerance(float value) Gets the max touch target distance of the behavior.
void	setPopupPresenter(TooltipPresenterBase popupPresenter) Sets the presenter that renders this behavior.
void	setTooltipContextNeededListener(TooltipContextNeededListener listener) Sets the current listener responsible for providing context to the tooltip.

Methods inherited from class com.telerik.widget.chart.visualization.behaviors.ChartBehavior

attach, chart, detach, onDoubleTap, onDown, onDrag, onHold, onPinch, onPinchComplete, onTap, onUp, reset

Methods inherited from class com.telerik.android.common.PropertyManager

getValue, resetPropertyValue, setValue, setValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.telerik.android.primitives.widget.tooltip.contracts.TooltipAdapter

contentAdapter, setContentAdapter

Constructor Detail

ChartPopupBehavior

public ChartPopupBehavior(Context context)

Creates an instance of ChartPopupBehavior.

Parameters:

context - The app context.

Method Detail

availableLayoutSlot

public RectF availableLayoutSlot()

Gets the layout slot in which the popup will be arranged.

Specified by:

availableLayoutSlot in interface TooltipAdapter

Returns:

the currently available layout slot.

alignTooltipVertically

public boolean alignTooltipVertically()

Description copied from interface: TooltipAdapter

States whether the tooltip should be placed vertically or horizontally to the currently selected target.

Specified by:

alignTooltipVertically in interface TooltipAdapter

Returns:

true to place it above or bellow with above being the first choice, false to place it left or right with right being the first choice.

getLastChartContext

public ChartDataContext getLastChartContext()

Gets the previous chart data context if there is one. If there is no previous context returns null.

getMaxTouchDistanceTolerance

public float getMaxTouchDistanceTolerance()

Gets the max touch target distance of the behavior. If the user touches farther than the touch target from a data point, nothing will be displayed.

setMaxTouchDistanceTolerance

public void setMaxTouchDistanceTolerance(float value)

Gets the max touch target distance of the behavior. If the user touches farther than the touch target from a data point, nothing will be displayed.

Parameters:

value - The new max touch distance.

getPopupPresenter

public TooltipPresenterBase getPopupPresenter()

Gets the presenter that renders this behavior.

setPopupPresenter

public void setPopupPresenter(TooltipPresenterBase popupPresenter)

Sets the presenter that renders this behavior.

Parameters:

popupPresenter - The new popup presenter.

isTooltipDisplayed

public boolean isTooltipDisplayed()

Gets a value stating whether the tooltip is currently being displayed.

Returns:

true if the tooltip is visible, false otherwise.

getContextNeededListener

public TooltipContextNeededListener getContextNeededListener()

Gets the current listener responsible for providing context to the tooltip.

Returns:

the current content needed listener.

setTooltipContextNeededListener

public void setTooltipContextNeededListener(TooltipContextNeededListener listener)

Sets the current listener responsible for providing context to the tooltip.

Parameters:

listener - the new listener.

rawOffset

public Point rawOffset()

Description copied from interface: TooltipAdapter

The offset from the touch event according to the current target view instance and the world coordinates of the same touch event.

Specified by:

rawOffset in interface TooltipAdapter

Returns:

the current offset.

getTooltipData

public Object[] getTooltipData(Object context)

Description copied from interface: TooltipAdapter

Gets the data for the tooltip using the passed context.

Specified by:

getTooltipData in interface TooltipAdapter

Parameters:

context - context used to extract the data for the current tooltip.

Returns:

the extracted data.

open

public boolean open(Point location,
                    Point rawLocation)

Attempts to open the popup and returns a boolean stating the result of this attempt.

Parameters:

location - the location at which the gesture was recorded.

rawLocation - the location of the gesture in world coordinates.

Returns:

true if the open attempt was successful, false otherwise.

open

public boolean open(DataPoint dataPoint)

Attempts to open the popup and returns a boolean stating the result of this attempt.

Parameters:

dataPoint - the data point for which the tooltip will be opened.

Returns:

true if the open attempt was successful, false otherwise.

extractTooltipContext

public ChartDataContext extractTooltipContext(Point location)

Extracts context data for a given location.

Parameters:

location - the location for which data context will be extracted.

Returns:

the extracted data or null if no data was extracted.

extractTooltipContext

public ChartDataContext extractTooltipContext(DataPoint point)

Extracts data context for a given data point using a ValueExtractor

Parameters:

point - the data point from which data will be extracted.

Returns:

the extracted data.

getPlotAreaClip

public RadRect getPlotAreaClip()

Description copied from interface: TooltipAdapter

Gets the clip of the current plot area.

Specified by:

getPlotAreaClip in interface TooltipAdapter

Returns:

the clip of the current plot area.

close

public boolean close()

Closes the popup if needed.

getApplyDefaultStyles

public boolean getApplyDefaultStyles()

Gets a value determining whether to apply the default styles or not.

Returns:

true will result in application of the default styles, false will prevent it.

setApplyDefaultStyles

public void setApplyDefaultStyles(boolean applyDefaultStyles)

Sets a value determining whether to apply the default styles or not.

Parameters:

applyDefaultStyles - the value.