public class

StandardCrosshairLabelGenerator

extends Object
implements Serializable CrosshairLabelGenerator
java.lang.Object
   ↳ org.jfree.chart.labels.StandardCrosshairLabelGenerator

Class Overview

A default label generator.

Summary

Public Constructors
StandardCrosshairLabelGenerator()
Creates a new instance with default attributes.
StandardCrosshairLabelGenerator(String labelTemplate, NumberFormat numberFormat)
Creates a new instance with the specified attributes.
Public Methods
boolean equals(Object obj)
Tests this generator for equality with an arbitrary object.
String generateLabel(Crosshair crosshair)
Returns a string that can be used as the label for a crosshair.
String getLabelTemplate()
Returns the label template string.
NumberFormat getNumberFormat()
Returns the number formatter.
int hashCode()
Returns a hash code for this instance.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.jfree.chart.labels.CrosshairLabelGenerator

Public Constructors

public StandardCrosshairLabelGenerator ()

Creates a new instance with default attributes.

public StandardCrosshairLabelGenerator (String labelTemplate, NumberFormat numberFormat)

Creates a new instance with the specified attributes.

Parameters
labelTemplate the label template (null not permitted).
numberFormat the number formatter (null not permitted).

Public Methods

public boolean equals (Object obj)

Tests this generator for equality with an arbitrary object.

Parameters
obj the object (null permitted).
Returns
  • A boolean.

public String generateLabel (Crosshair crosshair)

Returns a string that can be used as the label for a crosshair.

Parameters
crosshair the crosshair (null not permitted).
Returns
  • The label (possibly null).

public String getLabelTemplate ()

Returns the label template string.

Returns
  • The label template string (never null).

public NumberFormat getNumberFormat ()

Returns the number formatter.

Returns
  • The formatter (never null).

public int hashCode ()

Returns a hash code for this instance.

Returns
  • A hash code for this instance.