ilog.views.chart.servlet

Class IlvDefaultChartToolTip

java.lang.Object

ilog.views.chart.servlet.IlvDefaultChartToolTip

All Implemented Interfaces:

IlvIMapAttributes

public class IlvDefaultChartToolTip
extends Object
implements IlvIMapAttributes

This class implements a simple tooltip, consisting of two lines of text: a title and a main information line.

Since:

JViews 8.7

See Also:

IlvDefaultChartHitmapDefinition.getToolTipAsHTML(IlvIMapAttributes)

Constructor Summary

Constructors

Constructor and Description
IlvDefaultChartToolTip(String title, IlvDataSet dataSet) Creates a tooltip with a given title and suitable for a given data set as a whole.
IlvDefaultChartToolTip(String title, IlvDataSet dataSet, int idx) Creates a tooltip with a given title and suitable for a given data point in a data set.
IlvDefaultChartToolTip(String title, IlvTreeListModel model, TreePath path) Creates a tooltip with a given title and suitable for a given data object in a data model.
IlvDefaultChartToolTip(String title, String mainLine) Creates a tooltip with given title and main line.

Method Summary

Modifier and Type	Method and Description
String	getALT() Returns the main line given to or compute by the constructor.
String	getExtraAttributes() Returns extra attributes for interactive effects.
String	getHREF() Returns the anchor reference for the interactive effect of a hyperlink.
String	getTarget() Returns the name of the target frame for the interactive effect of a hyperlink.
String	getTitle() Returns the title given to or compute by the constructor.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvDefaultChartToolTip

public IlvDefaultChartToolTip(String title,
                              String mainLine)

Creates a tooltip with given title and main line.

Parameters:

title - The first line of the tooltip.

mainLine - The second line of the tooltip.

IlvDefaultChartToolTip

public IlvDefaultChartToolTip(String title,
                              IlvDataSet dataSet,
                              int idx)

Creates a tooltip with a given title and suitable for a given data point in a data set.

Parameters:

title - The first line of the tooltip.

dataSet - A data set represented in the chart.

idx - The index of a data point in the data set.

IlvDefaultChartToolTip

public IlvDefaultChartToolTip(String title,
                              IlvDataSet dataSet)

Creates a tooltip with a given title and suitable for a given data set as a whole.

Parameters:

title - The first line of the tooltip.

dataSet - A data set represented in the chart.

IlvDefaultChartToolTip

public IlvDefaultChartToolTip(String title,
                              IlvTreeListModel model,
                              TreePath path)

Creates a tooltip with a given title and suitable for a given data object in a data model.

Parameters:

title - The first line of the tooltip.

model - Tree model.

path - A tree path starting at the tree model root and ending at the specific tree model node.

Method Detail

getTitle

public String getTitle()

Returns the title given to or compute by the constructor.

Specified by:

getTitle in interface IlvIMapAttributes

getALT

public String getALT()

Returns the main line given to or compute by the constructor.

Specified by:

getALT in interface IlvIMapAttributes

getHREF

public String getHREF()

Returns the anchor reference for the interactive effect of a hyperlink.

This method by default returns null. It can be overridden in subclasses.

Note: In this JViews release, hyperlink effects are not supported through the hitmap mechanism.

Specified by:

getHREF in interface IlvIMapAttributes

getTarget

public String getTarget()

Returns the name of the target frame for the interactive effect of a hyperlink. null can be used to denote the current frame.

This method by default returns null. It can be overridden in subclasses.

Note: In this JViews release, hyperlink effects are not supported through the hitmap mechanism.

Specified by:

getTarget in interface IlvIMapAttributes

getExtraAttributes

public String getExtraAttributes()

Returns extra attributes for interactive effects. This method returns extra attributes (for example onMouseOut, onMouseOver, ...). The returned string must be compliant with the expected attributes format. For example:

 onMouseOver="script code ..." onMouseOut="script code ..."
 

This method by default returns null. It can be overridden in subclasses.

Note: In this JViews release, extra attributes for interactive effects are not supported through the hitmap mechanism.

Specified by:

getExtraAttributes in interface IlvIMapAttributes