Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| # Header And More
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.jfree.chart.plot
Class CategoryCrosshairState

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

    public class CategoryCrosshairState

extends CrosshairState

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.

Since:
  1.0.11

Constructor Summary
`CategoryCrosshairState()` Creates a new instance.

Method Summary
`java.lang.Comparable` | `getColumnKey()` Returns the column key.
`java.lang.Comparable` | `getRowKey()` Returns the row key.
`void` | `setColumnKey(java.lang.Comparable key)` Sets the column key.
`void` | `setRowKey(java.lang.Comparable key)` Sets the row key.
`void` | `updateCrosshairPoint(java.lang.Comparable rowKey, java.lang.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(java.lang.Comparable rowKey, java.lang.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).

Methods inherited from class org.jfree.chart.plot.CrosshairState
`getAnchor, getAnchorX, getAnchorY, getCrosshairDistance, getCrosshairX, getCrosshairY, getDatasetIndex, getDomainAxisIndex, getRangeAxisIndex, setAnchor, setAnchorX, setAnchorY, setCrosshairDistance, setCrosshairX, setCrosshairY, setDatasetIndex, updateCrosshairPoint, updateCrosshairPoint, updateCrosshairX, updateCrosshairX, updateCrosshairY, updateCrosshairY`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### CategoryCrosshairState

    public CategoryCrosshairState()

  Creates a new instance.

Method Detail

### getRowKey

    public java.lang.Comparable getRowKey()

  Returns the row key.

  Returns:
    The row key.

### setRowKey

    public void setRowKey(java.lang.Comparable key)

  Sets the row key.

  Parameters:
    `key` - the row key.

### getColumnKey

    public java.lang.Comparable getColumnKey()

  Returns the column key.

  Returns:
    The column key.

### setColumnKey

    public void setColumnKey(java.lang.Comparable key)

  Sets the column key.

  Parameters:
    `key` - the key.

### updateCrosshairPoint

    public void updateCrosshairPoint(java.lang.Comparable rowKey,
                                     java.lang.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.

### updateCrosshairX

    public void updateCrosshairX(java.lang.Comparable rowKey,
                                 java.lang.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.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| # Footer And More
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2000-2009 by Object Refinery Limited. All Rights Reserved.