org.jfree.chart
Class CrosshairInfo

java.lang.Object
  |
  +--org.jfree.chart.CrosshairInfo

public class CrosshairInfo

extends java.lang.Object

Maintains information about crosshairs on a plot.

Author:

David Gilbert

Constructor Summary

CrosshairInfo()
Default constructor.

Method Summary

double	getCrosshairX() Get the x-value for the crosshair point.
double	getCrosshairY() Get the y-value for the crosshair point.
void	setAnchorX(double x) Set the x-value for the anchor point.
void	setAnchorY(double y) Set the y-value for the anchor point.
void	setCrosshairDistance(double distance) Sets the distance.
void	updateCrosshairPoint(double candidateX, double candidateY) Evaluates a data point and if it is the closest to the anchor point it becomes the new crosshair point.
void	updateCrosshairX(double candidateX) Evaluates an x-value and if it is the closest to the anchor point it becomes the new crosshair point.
void	updateCrosshairY(double candidateY) Evaluates a y-value and if it is the closest to the anchor point it becomes the new crosshair point.

Methods inherited from class java.lang.Object

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

Constructor Detail

CrosshairInfo

public CrosshairInfo()

Default constructor.

Method Detail

setCrosshairDistance

public void setCrosshairDistance(double distance)

Sets the distance.

Parameters:

distance - the distance.

updateCrosshairPoint

public void updateCrosshairPoint(double candidateX,
                                 double candidateY)

Evaluates a data point and if it is the closest to the anchor point it becomes the new crosshair point.

To understand this method, you need to know the context in which it will be called. An instance of this class is passed to an XYItemRenderer as each data point is plotted. As the point is plotted, it is passed to this method to see if it should be the new crosshair point.

Parameters:

candidateX - x position of candidate for the new crosshair point.

candidateY - y position of candidate for the new crosshair point.

updateCrosshairX

public void updateCrosshairX(double candidateX)

Evaluates an x-value and if it is the closest to the anchor point it becomes the new crosshair point.

Used in cases where only the x-axis is numerical.

Parameters:

candidateX - x position of the candidate for the new crosshair point.

updateCrosshairY

public void updateCrosshairY(double candidateY)

Evaluates a y-value and if it is the closest to the anchor point it becomes the new crosshair point.

Used in cases where only the y-axis is numerical.

Parameters:

candidateY - y position of the candidate for the new crosshair point.

setAnchorX

public void setAnchorX(double x)

Set the x-value for the anchor point.

Parameters:

x - the x position.

setAnchorY

public void setAnchorY(double y)

Set the y-value for the anchor point.

Parameters:

y - the y position.

getCrosshairX

public double getCrosshairX()

Get the x-value for the crosshair point.

Returns:

the x position of the crosshair point.

getCrosshairY

public double getCrosshairY()

Get the y-value for the crosshair point.

Returns:

the y position of the crosshair point.