oracle.dss.graph
Class ToolTipTextCallback

java.lang.Object
  |
  +--oracle.dss.graph.ToolTipTextCallback

All Implemented Interfaces:

tdg.ToolTipCallBack

public class ToolTipTextCallback

extends java.lang.Object

implements tdg.ToolTipCallBack

The callback that provides tooltips to PFJ to display in the graph. Implements ToolTipCallback interface in PFJ. Application developers should not call the methods in this class.

To change the tooltips that are displayed for the graph, you can call Graph methods that affect the display of tooltips, or you can provide an implementation of the CustomToolTipCallback interface and then register the callback by calling Graph.setCustomToolTipCallback. This class calls the CustomToolTipCallback implementation, if one has been registered with the Graph, to get tool tips.

See Also:

Graph.setGroupTooltipLabelType(int), Graph.setMarkerTooltipType(int), Graph.setSeriesTooltipLabelType(int), Graph.setToolTipDelay(int), Graph.setCustomToolTipCallback(oracle.dss.graph.CustomToolTipCallback)

Constructor Summary

ToolTipTextCallback(Graph graph, numFormatCallback)
Constructor.

Method Summary

java.lang.Object	getColumnLabels(int col) Retrieves the label for a column.
void	getDataAccess() Retrieves the current DataAccess for the graph.
java.lang.String	getDynamicToolTip(tdg.TDGMouseState aMouseState, boolean UserOrDeveloper) Retrieves the text to display in a tooltip.
java.lang.String	getFormattedValue(double dVal, int axis, boolean isPercent, boolean isPieSlice) Retrieves a formatted data value.
int	getGroupTooltipLabelType() Retrieves the kind of information that is displayed in tooltips for groups.
int	getMarkerTooltipType() Retrieves the kind of information that is displayed in tooltips for data markers.
java.lang.Object	getRowLabels(int row) Retrieves the label for a row.
int	getSeriesTooltipLabelType() Retrieves the kind of information that is displayed in tooltips for series.
double	getValue(int row, int col) Retrieves a data value.
boolean	isAssignedToY2(int seriesID) Indicates whether a series is assigned to the Y2-axis.
void	setAxisLabelTipDisplayed(boolean yesNo) Specifies whether to display tooltip text for legend text and axis labels.
void	setDataRowShownAsASeries(boolean yesNo) Specifies whether data rows appear as series in the graph.
void	setGraphFormatManager(GraphFormatManager m) Specifies the format manager that this ToolTipTextCallback uses.
void	setGraphType(int type) Specifies the graph type of the graph for which this ToolTipTextCallback handles tool tips.
void	setGroupTooltipLabelType(int type) Specifies the kind of information to display in tooltips for groups.
void	setMarkerTooltipType(int type) Specifies the type of information that this graph displays in tooltips for markers.
void	setSeriesTooltipLabelType(int type) Specifies the kind of information to display in tooltips for series.

Methods inherited from class java.lang.Object

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

Constructor Detail

ToolTipTextCallback

public ToolTipTextCallback(Graph graph,
                            numFormatCallback)

Constructor. Application developers should never have to construct this method, because the Graph does it automatically.

Parameters:

graph - The Graph for which this ToolTipTextCallback will handle tool tips.

numFormatCallback - The callback that will format numbers for this ToolTipTextCallback.

Method Detail

getDataAccess

public void getDataAccess()

Retrieves the current DataAccess for the graph. The DataAccess provides access to the data that this callback needs to display.

getDynamicToolTip

public java.lang.String getDynamicToolTip(tdg.TDGMouseState aMouseState,
                                          boolean UserOrDeveloper)

Retrieves the text to display in a tooltip. This text contains information about the graph component over which the mouse is positioned. This method is specified in the ToolTipCallback interface in PFJ.

Specified by:

getDynamicToolTip in interface tdg.ToolTipCallBack

Parameters:

aMouseState - The mouse state information from PFJ.

UserOrDeveloper - true if the Graph is in "developer mode," requiring tooltips with more information, for debugging, false if the Graph is in "user mode," requiring tooltips that are appropriate for end users. The default is false.

Returns:

The text to display in a tooltip.

getFormattedValue

public java.lang.String getFormattedValue(double dVal,
                                          int axis,
                                          boolean isPercent,
                                          boolean isPieSlice)

Retrieves a formatted data value.

Parameters:

dval - The data value to be formatted.

axis - A constant that represents the axis to which the value belongs. Each axis has a different ViewFormat, and so can have different formatting attributes.

isPercent - true if dval is a percentage, false if it is not.

isPieSlice - true if dval is represented as a pie slice in the graph, false if it is not.

Returns:

The formatted data value.

getColumnLabels

public java.lang.Object getColumnLabels(int col)

Retrieves the label for a column.

Parameters:

col - The column whose label you want.

Returns:

The label for the specified column.

getRowLabels

public java.lang.Object getRowLabels(int row)

Retrieves the label for a row.

Parameters:

row - The row whose label to get.

Returns:

The label for the specified row.

getValue

public double getValue(int row,
                       int col)

Retrieves a data value. The row and col parameters identify the data value to retrieve. Currently, the data value must be a number value.

Parameters:

row - The row of the data value that you want.

col - The column of the data value that you want.

Returns:

The data value at the specified row and column. Returns 0.0 if the value at the specified row and column is not a number value.

isAssignedToY2

public boolean isAssignedToY2(int seriesID)

Indicates whether a series is assigned to the Y2-axis.

Parameters:

seriesID - The series about which you want information.

Returns:

true if series is assigned to the Y2-axis, false if it is assigned to the Y1-axis.

setAxisLabelTipDisplayed

public void setAxisLabelTipDisplayed(boolean yesNo)

Specifies whether to display tooltip text for legend text and axis labels.

Parameters:

yesNo - true to display tooltips for legend text and axis labels, false to hide tooltips for these labels.

setDataRowShownAsASeries

public void setDataRowShownAsASeries(boolean yesNo)

Specifies whether data rows appear as series in the graph. The Graph.setDataRowShownAsASeries method class calls this method. Application developers should call the method in the Graph rather than this method.

Parameters:

yesNo - true to have data rows shown as PFJ series (and data columns shown as groups), false to have data rows shown as PFJ groups (and data columns shown as series).

See Also:

Graph.setDataRowShownAsASeries(boolean)

setGraphFormatManager

public void setGraphFormatManager(GraphFormatManager m)

Specifies the format manager that this ToolTipTextCallback uses. The Graph.setGraphFormatManager method calls this method. Application developers should not need to call this method.

Parameters:

m - The GraphFormatManager to use.

See Also:

Graph#setGraphFormatManager

setGraphType

public void setGraphType(int type)

Specifies the graph type of the graph for which this ToolTipTextCallback handles tool tips. The Graph.setGraphType method calls this method as it sets the graph type of the graph. Application developers should not have to call this method.

Parameters:

type - A constant that represents the graph type. Constants are defined in the Graph class.

See Also:

Graph.setGraphType(int)

getGroupTooltipLabelType

public int getGroupTooltipLabelType()

Retrieves the kind of information that is displayed in tooltips for groups. The default value is Graph.TLT_MEMBER, so that the group dimension member appears, without a dimension name. Graph.getGroupTooltipLabelType calls this method.

Returns:

A constant that indicates the kind of information that appears in tooltips for groups. The constants are defined in the Graph class, and they begin with TLT_.

See Also:

Graph.getGroupTooltipLabelType()

setGroupTooltipLabelType

public void setGroupTooltipLabelType(int type)

Specifies the kind of information to display in tooltips for groups. The default value for the GroupTooltipLabelType attribute is Graph.TLT_MEMBER, which displays the dimension member only. Graph.setGroupTooltipLabelType calls this method.

Parameters:

type - A constant that specifies the kind of information to display in tooltips for groups. The constants are defined in the Graph class, and they begin with TLT_.

See Also:

Graph.setGroupTooltipLabelType(int)

getMarkerTooltipType

public int getMarkerTooltipType()

Retrieves the kind of information that is displayed in tooltips for data markers. The default value is Graph.MTT_VALUES, which displays the data value that the marker represents. Graph.getMarkerTooltipType calls this method.

Returns:

A constant that indicates the kind of information that appears in tooltips for groups. The constants are defined in the Graph class, and they begin with MTT_.

See Also:

Graph.getMarkerTooltipType()

setMarkerTooltipType

public void setMarkerTooltipType(int type)

Specifies the type of information that this graph displays in tooltips for markers. The information can be the value that the marker represents, the percent value (for pie graphs), the cumulative value (for stacked graphs), text that identifies the group or series, or a combination of information, such as the value, the group, and the series. Constants are defined in the Graph class, and they start with MTT_.

The default value for the MarkerTooltipType property is Graph.MTT_VALUES, which displays the data value that the marker represents. Graph.setMarkerTooltipType calls this method.

Parameters:

type - A constant that represents the type of information that the graph should display for markers. Except for MTT_NONE, the constants can be combined by using a bitwise OR (|).

See Also:

Graph.MTT_TEXT, Graph.MTT_VALUES, Graph.MTT_NONE, Graph.MTT_PERCENT_VAL, Graph.MTT_CUM_VAL, Graph.setGroupTooltipLabelType(int), Graph.setSeriesTooltipLabelType(int), Graph.setMarkerTooltipType(int)

getSeriesTooltipLabelType

public int getSeriesTooltipLabelType()

Retrieves the kind of information that is displayed in tooltips for series. The default value is Graph.TLT_MEMBER, so that the group dimension member appears, without a dimension name. Graph.getSeriesTooltipLabelType calls this method.

Returns:

A constant that indicates the kind of information that appears in tooltips for series. The constants are defined in the Graph class, and they begin with TLT_.

See Also:

Graph.getSeriesTooltipLabelType()

setSeriesTooltipLabelType

public void setSeriesTooltipLabelType(int type)

Specifies the kind of information to display in tooltips for series. The default value for the GroupTooltipLabelType attribute is Graph.TLT_MEMBER, which displays the dimension member only. Graph.setSeriesTooltipLabelType calls this method.

Parameters:

type - A constant that specifies the kind of information to display in tooltips for series. The constants are defined in the Graph class, and they begin with TLT_.

See Also:

Graph.setSeriesTooltipLabelType(int)