Package org.jfree.chart.labels
Class StandardCategoryToolTipGenerator
- java.lang.Object
-
- org.jfree.chart.labels.AbstractCategoryItemLabelGenerator
-
- org.jfree.chart.labels.StandardCategoryToolTipGenerator
-
- All Implemented Interfaces:
java.io.Serializable,java.lang.Cloneable,CategoryToolTipGenerator,org.jfree.util.PublicCloneable
- Direct Known Subclasses:
BoxAndWhiskerToolTipGenerator,IntervalCategoryToolTipGenerator
public class StandardCategoryToolTipGenerator extends AbstractCategoryItemLabelGenerator implements CategoryToolTipGenerator, java.io.Serializable
A standard tool tip generator that can be used with aCategoryItemRenderer.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringDEFAULT_TOOL_TIP_FORMAT_STRINGThe default format string.
-
Constructor Summary
Constructors Constructor Description StandardCategoryToolTipGenerator()Creates a new generator with a default number formatter.StandardCategoryToolTipGenerator(java.lang.String labelFormat, java.text.DateFormat formatter)Creates a new generator with the specified date formatter.StandardCategoryToolTipGenerator(java.lang.String labelFormat, java.text.NumberFormat formatter)Creates a new generator with the specified number formatter.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(java.lang.Object obj)Tests this generator for equality with an arbitrary object.java.lang.StringgenerateToolTip(CategoryDataset dataset, int row, int column)Generates the tool tip text for an item in a dataset.-
Methods inherited from class org.jfree.chart.labels.AbstractCategoryItemLabelGenerator
clone, createItemArray, generateColumnLabel, generateLabelString, generateRowLabel, getDateFormat, getLabelFormat, getNumberFormat, hashCode
-
-
-
-
Field Detail
-
DEFAULT_TOOL_TIP_FORMAT_STRING
public static final java.lang.String DEFAULT_TOOL_TIP_FORMAT_STRING
The default format string.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
StandardCategoryToolTipGenerator
public StandardCategoryToolTipGenerator()
Creates a new generator with a default number formatter.
-
StandardCategoryToolTipGenerator
public StandardCategoryToolTipGenerator(java.lang.String labelFormat, java.text.NumberFormat formatter)
Creates a new generator with the specified number formatter.- Parameters:
labelFormat- the label format string (nullnot permitted).formatter- the number formatter (nullnot permitted).
-
StandardCategoryToolTipGenerator
public StandardCategoryToolTipGenerator(java.lang.String labelFormat, java.text.DateFormat formatter)
Creates a new generator with the specified date formatter.- Parameters:
labelFormat- the label format string (nullnot permitted).formatter- the date formatter (nullnot permitted).
-
-
Method Detail
-
generateToolTip
public java.lang.String generateToolTip(CategoryDataset dataset, int row, int column)
Generates the tool tip text for an item in a dataset. Note: in the current dataset implementation, each row is a series, and each column contains values for a particular category.- Specified by:
generateToolTipin interfaceCategoryToolTipGenerator- Parameters:
dataset- the dataset (nullnot permitted).row- the row index (zero-based).column- the column index (zero-based).- Returns:
- The tooltip text (possibly
null).
-
equals
public boolean equals(java.lang.Object obj)
Tests this generator for equality with an arbitrary object.- Overrides:
equalsin classAbstractCategoryItemLabelGenerator- Parameters:
obj- the object (nullpermitted).- Returns:
- A boolean.
-
-