edu.ucla.stat.SOCR.motionchart
Class MotionToolTipGenerator

java.lang.Object
  extended by org.jfree.chart.labels.AbstractXYItemLabelGenerator
      extended by org.jfree.chart.labels.StandardXYToolTipGenerator
          extended by org.jfree.chart.labels.StandardXYZToolTipGenerator
              extended by edu.ucla.stat.SOCR.motionchart.MotionToolTipGenerator
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, org.jfree.chart.labels.XYToolTipGenerator, org.jfree.chart.labels.XYZToolTipGenerator, org.jfree.util.PublicCloneable

public class MotionToolTipGenerator
extends org.jfree.chart.labels.StandardXYZToolTipGenerator
implements org.jfree.chart.labels.XYZToolTipGenerator

Package: edu.ucla.stat.SOCR.motionchart User: Khashim Date: Dec 20, 2008 Time: 7:19:20 PM

Author:
Jameel
See Also:
Serialized Form

Field Summary
static java.lang.String DEFAULT_TOOL_TIP_FORMAT
          The default tooltip format.
 
Constructor Summary
MotionToolTipGenerator()
          Creates a new tool tip generator using default number formatters for the x, y and z-values.
MotionToolTipGenerator(java.lang.String formatString, java.text.DateFormat keyFormat, java.text.DateFormat xFormat, java.text.DateFormat yFormat, java.text.DateFormat zFormat, java.text.DateFormat colorFormat)
          Constructs a new tool tip generator using the specified date formatters.
MotionToolTipGenerator(java.lang.String formatString, java.text.NumberFormat keyFormat, java.text.NumberFormat xFormat, java.text.NumberFormat yFormat, java.text.NumberFormat zFormat, java.text.NumberFormat colorFormat)
          Constructs a new tool tip generator using the specified number formatters.
 
Method Summary
protected  java.lang.Object[] createItemArray(org.jfree.data.xy.XYZDataset dataset, int series, int item)
          Creates the array of items that can be passed to the MessageFormat class for creating labels.
 boolean equals(java.lang.Object obj)
          Tests this object for equality with an arbitrary object.
 java.text.DateFormat getColorDateFormat()
          Returns the date formatter for the color values.
 java.text.NumberFormat getColorFormat()
          Returns the number formatter for the color values.
 java.text.DateFormat getKeyDateFormat()
          Returns the date formatter for the key values.
 java.text.NumberFormat getKeyFormat()
          Returns the number formatter for the key values.
 
Methods inherited from class org.jfree.chart.labels.StandardXYZToolTipGenerator
generateLabelString, generateToolTip, getZDateFormat, getZFormat
 
Methods inherited from class org.jfree.chart.labels.StandardXYToolTipGenerator
clone, generateToolTip, getTimeSeriesInstance
 
Methods inherited from class org.jfree.chart.labels.AbstractXYItemLabelGenerator
createItemArray, getFormatString, getXDateFormat, getXFormat, getYDateFormat, getYFormat, hashCode
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.jfree.chart.labels.XYZToolTipGenerator
generateToolTip
 
Methods inherited from interface org.jfree.chart.labels.XYToolTipGenerator
generateToolTip
 

Field Detail

DEFAULT_TOOL_TIP_FORMAT

public static final java.lang.String DEFAULT_TOOL_TIP_FORMAT
The default tooltip format.

See Also:
Constant Field Values
Constructor Detail

MotionToolTipGenerator

public MotionToolTipGenerator()
Creates a new tool tip generator using default number formatters for the x, y and z-values.


MotionToolTipGenerator

public MotionToolTipGenerator(java.lang.String formatString,
                              java.text.NumberFormat keyFormat,
                              java.text.NumberFormat xFormat,
                              java.text.NumberFormat yFormat,
                              java.text.NumberFormat zFormat,
                              java.text.NumberFormat colorFormat)
Constructs a new tool tip generator using the specified number formatters.

Parameters:
formatString - the format string.
keyFormat - the format object for the key values (null not permitted).
xFormat - the format object for the x values (null not permitted).
yFormat - the format object for the y values (null not permitted).
zFormat - the format object for the size values (null not permitted).
colorFormat - the format object for the color values (null not permitted).

MotionToolTipGenerator

public MotionToolTipGenerator(java.lang.String formatString,
                              java.text.DateFormat keyFormat,
                              java.text.DateFormat xFormat,
                              java.text.DateFormat yFormat,
                              java.text.DateFormat zFormat,
                              java.text.DateFormat colorFormat)
Constructs a new tool tip generator using the specified date formatters.

Parameters:
formatString - the format string.
keyFormat - the format object for the key values (null not permitted).
xFormat - the format object for the x values (null not permitted).
yFormat - the format object for the y values (null not permitted).
zFormat - the format object for the size values (null not permitted).
colorFormat - the format object for the color values (null not permitted).
Method Detail

getKeyFormat

public java.text.NumberFormat getKeyFormat()
Returns the number formatter for the key values.

Returns:
The number formatter (possibly null).

getKeyDateFormat

public java.text.DateFormat getKeyDateFormat()
Returns the date formatter for the key values.

Returns:
The date formatter (possibly null).

getColorFormat

public java.text.NumberFormat getColorFormat()
Returns the number formatter for the color values.

Returns:
The number formatter (possibly null).

getColorDateFormat

public java.text.DateFormat getColorDateFormat()
Returns the date formatter for the color values.

Returns:
The date formatter (possibly null).

createItemArray

protected java.lang.Object[] createItemArray(org.jfree.data.xy.XYZDataset dataset,
                                             int series,
                                             int item)
Creates the array of items that can be passed to the MessageFormat class for creating labels.

Overrides:
createItemArray in class org.jfree.chart.labels.StandardXYZToolTipGenerator
Parameters:
dataset - the dataset (null not permitted).
series - the series (zero-based index).
item - the item (zero-based index).
Returns:
The items (never null).

equals

public boolean equals(java.lang.Object obj)
Tests this object for equality with an arbitrary object.

Overrides:
equals in class org.jfree.chart.labels.StandardXYZToolTipGenerator
Parameters:
obj - the other object (null permitted).
Returns:
A boolean.