public class

CategoryCrosshairState

extends CrosshairState
java.lang.Object
   ↳ org.jfree.chart.plot.CrosshairState
     ↳ org.jfree.chart.plot.CategoryCrosshairState

Class Overview

Represents state information for the crosshairs in a CategoryPlot. An instance of this class is created at the start of the rendering process, and updated as each data item is rendered. At the end of the rendering process, this class holds the row key, column key and value for the crosshair location.

Summary

Public Constructors
CategoryCrosshairState()
Creates a new instance.
Public Methods
Comparable getColumnKey()
Returns the column key.
Comparable getRowKey()
Returns the row key.
void setColumnKey(Comparable key)
Sets the column key.
void setRowKey(Comparable key)
Sets the row key.
void updateCrosshairPoint(Comparable rowKey, Comparable columnKey, double value, int datasetIndex, double transX, double transY, PlotOrientation orientation)
Evaluates a data point from a CategoryItemRenderer and if it is the closest to the anchor point it becomes the new crosshair point.
void updateCrosshairX(Comparable rowKey, Comparable columnKey, int datasetIndex, double transX, PlotOrientation orientation)
Updates only the crosshair row and column keys (this is for the case where the range crosshair does NOT lock onto the nearest data value).
[Expand]
Inherited Methods
From class org.jfree.chart.plot.CrosshairState
From class java.lang.Object

Public Constructors

public CategoryCrosshairState ()

Creates a new instance.

Public Methods

public Comparable getColumnKey ()

Returns the column key.

Returns
  • The column key.

public Comparable getRowKey ()

Returns the row key.

Returns
  • The row key.

public void setColumnKey (Comparable key)

Sets the column key.

Parameters
key the key.

public void setRowKey (Comparable key)

Sets the row key.

Parameters
key the row key.

public void updateCrosshairPoint (Comparable rowKey, Comparable columnKey, double value, int datasetIndex, double transX, double transY, PlotOrientation orientation)

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

Parameters
rowKey the row key.
columnKey the column key.
value y coordinate (measured against the range axis).
datasetIndex the dataset index for this point.
transX x translated into Java2D space.
transY y translated into Java2D space.
orientation the plot orientation.

public void updateCrosshairX (Comparable rowKey, Comparable columnKey, int datasetIndex, double transX, PlotOrientation orientation)

Updates only the crosshair row and column keys (this is for the case where the range crosshair does NOT lock onto the nearest data value).

Parameters
rowKey the row key.
columnKey the column key.
datasetIndex the dataset axis index.
transX the translated x-value.
orientation the plot orientation.