jgnash.ui.commodity
Class SecurityItemLabelGenerator

java.lang.Object
  extended by jgnash.ui.commodity.SecurityItemLabelGenerator
All Implemented Interfaces:
org.jfree.chart.labels.XYToolTipGenerator

public class SecurityItemLabelGenerator
extends java.lang.Object
implements org.jfree.chart.labels.XYToolTipGenerator

Tooltip generator for the security history chart

Version:
$Id$
Author:
Craig Cavanaugh

Field Summary
private  java.lang.String closeLabel
           
private  java.text.DateFormat dateFormatter
          The date formatter.
private  java.lang.String dateLabel
           
private  java.text.NumberFormat numberFormatter
          The number formatter.
 
Constructor Summary
private SecurityItemLabelGenerator(java.text.DateFormat dateFormatter, java.text.NumberFormat numberFormatter)
          Creates a tool tip generator using the supplied date formatter.
  SecurityItemLabelGenerator(SecurityNode node)
          Creates an item label generator using the default date and number formats.
 
Method Summary
 java.lang.String generateToolTip(org.jfree.data.xy.XYDataset dataset, int series, int item)
          Generates a tooltip text item for a particular item within a series.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

dateFormatter

private java.text.DateFormat dateFormatter
The date formatter.


numberFormatter

private java.text.NumberFormat numberFormatter
The number formatter.


dateLabel

private java.lang.String dateLabel

closeLabel

private java.lang.String closeLabel
Constructor Detail

SecurityItemLabelGenerator

public SecurityItemLabelGenerator(SecurityNode node)
Creates an item label generator using the default date and number formats.

Parameters:
node - SecurityNode to base format on

SecurityItemLabelGenerator

private SecurityItemLabelGenerator(java.text.DateFormat dateFormatter,
                                   java.text.NumberFormat numberFormatter)
Creates a tool tip generator using the supplied date formatter.

Parameters:
dateFormatter - the date formatter (null not permitted).
numberFormatter - the number formatter (null not permitted).
Method Detail

generateToolTip

public java.lang.String generateToolTip(org.jfree.data.xy.XYDataset dataset,
                                        int series,
                                        int item)
Generates a tooltip text item for a particular item within a series.

Specified by:
generateToolTip in interface org.jfree.chart.labels.XYToolTipGenerator
Parameters:
dataset - the dataset.
series - the series (zero-based index).
item - the item (zero-based index).
Returns:
The tooltip text.