|
Oracle™ Business Intelligence Beans Java API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.dss.graph.ToolTipTextCallback
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.
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 |
public ToolTipTextCallback(Graph graph, numFormatCallback)
Graph
does it automatically.graph
- The Graph
for which this ToolTipTextCallback
will handle tool tips.numFormatCallback
- The callback that will format numbers for this ToolTipTextCallback
.Method Detail |
public void getDataAccess()
DataAccess
for the graph. The DataAccess
provides access to the data that this callback needs to display.public java.lang.String getDynamicToolTip(tdg.TDGMouseState aMouseState, boolean UserOrDeveloper)
ToolTipCallback
interface in PFJ.getDynamicToolTip
in interface tdg.ToolTipCallBack
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
.public java.lang.String getFormattedValue(double dVal, int axis, boolean isPercent, boolean isPieSlice)
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.public java.lang.Object getColumnLabels(int col)
col
- The column whose label you want.public java.lang.Object getRowLabels(int row)
row
- The row whose label to get.public double getValue(int row, int col)
row
and col
parameters identify the data value to retrieve. Currently, the data value must be a number value.row
- The row of the data value that you want.col
- The column of the data value that you want.public boolean isAssignedToY2(int seriesID)
seriesID
- The series about which you want information.true
if series
is assigned to the Y2-axis, false
if it is assigned to the Y1-axis.public void setAxisLabelTipDisplayed(boolean yesNo)
yesNo
- true
to display tooltips for legend text and axis labels, false
to hide tooltips for these labels.public void setDataRowShownAsASeries(boolean yesNo)
Graph.setDataRowShownAsASeries
method class calls this method. Application developers should call the method in the Graph
rather than this method.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).Graph.setDataRowShownAsASeries(boolean)
public void setGraphFormatManager(GraphFormatManager m)
ToolTipTextCallback
uses. The Graph.setGraphFormatManager
method calls this method. Application developers should not need to call this method.m
- The GraphFormatManager
to use.Graph#setGraphFormatManager
public void setGraphType(int type)
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.type
- A constant that represents the graph type. Constants are defined in the Graph
class.Graph.setGraphType(int)
public int getGroupTooltipLabelType()
Graph.TLT_MEMBER
, so that the group dimension member appears, without a dimension name. Graph.getGroupTooltipLabelType
calls this method.Graph
class, and they begin with TLT_.Graph.getGroupTooltipLabelType()
public void setGroupTooltipLabelType(int type)
GroupTooltipLabelType
attribute is Graph.TLT_MEMBER
, which displays the dimension member only. Graph.setGroupTooltipLabelType
calls this method.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_.Graph.setGroupTooltipLabelType(int)
public int getMarkerTooltipType()
Graph.MTT_VALUES
, which displays the data value that the marker represents. Graph.getMarkerTooltipType
calls this method.Graph
class, and they begin with MTT_.Graph.getMarkerTooltipType()
public void setMarkerTooltipType(int type)
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.
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 (|).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)
public int getSeriesTooltipLabelType()
Graph.TLT_MEMBER
, so that the group dimension member appears, without a dimension name. Graph.getSeriesTooltipLabelType
calls this method.Graph
class, and they begin with TLT_.Graph.getSeriesTooltipLabelType()
public void setSeriesTooltipLabelType(int type)
GroupTooltipLabelType
attribute is Graph.TLT_MEMBER
, which displays the dimension member only. Graph.setSeriesTooltipLabelType
calls this method.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_.Graph.setSeriesTooltipLabelType(int)
|
Oracle™ Business Intelligence Beans Java API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |