oracle.dss.gauge

Interface CustomToolTipCallback

public interface CustomToolTipCallback

This interface provides a callback for overriding the tool tips that the Gauge provides by default. To provide custom tool tips, you implement this interface. Then you call the Gauge.setCustomToolTipCallback method to register the callback with the graph.

See Also:

Gauge#setCustomToolTipCallback

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getToolTipText(java.lang.String defaultToolTipText, ComponentHandle componentHandle) Retrieves the customized text for tooltips.

Method Detail

getToolTipText

java.lang.String getToolTipText(java.lang.String defaultToolTipText,
                              ComponentHandle componentHandle)

Retrieves the customized text for tooltips. The default tooltip handler for the Gauge calls this method to retrieve the custom text for the tooltip.

Parameters:

defaultToolTipText - The tool tip text that the Gauge provides by default.

componentHandle - The ComponentHandle for the component to which this tool tip applies. The componentHandle will actually be one of the following subclasses of ComponentHandle: DataComponentHandle, GroupComponentHandle, NonDataComponentHandle, PageItemComponentHandle, or SeriesComponentHandle.

Returns:

The text to display in the tooltip.