Save This Page
Home » jcommon-1.0.13 » org.jfree » chart » plot » [javadoc | source]
org.jfree.chart.plot
public class: CrosshairState [javadoc | source]
java.lang.Object
   org.jfree.chart.plot.CrosshairState
Maintains state information about crosshairs on a plot between successive calls to the renderer's draw method. This class is used internally by JFreeChart - it is not intended for external use.
Constructor:
 public CrosshairState() 
 public CrosshairState(boolean calculateDistanceInDataSpace) 
Method from org.jfree.chart.plot.CrosshairState Summary:
getAnchor,   getAnchorX,   getAnchorY,   getCrosshairDistance,   getCrosshairX,   getCrosshairY,   getDomainAxisIndex,   getRangeAxisIndex,   setAnchor,   setAnchorX,   setAnchorY,   setCrosshairDistance,   setCrosshairX,   setCrosshairY,   updateCrosshairPoint,   updateCrosshairPoint,   updateCrosshairX,   updateCrosshairX,   updateCrosshairY,   updateCrosshairY
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.jfree.chart.plot.CrosshairState Detail:
 public Point2D getAnchor() 
    Returns the anchor point.
 public double getAnchorX() 
    Returns the x-coordinate (in data space) for the anchor point.
 public double getAnchorY() 
    Returns the y-coordinate (in data space) for the anchor point.
 public double getCrosshairDistance() 
    Returns the distance between the anchor point and the current crosshair point.
 public double getCrosshairX() 
    Get the x-value for the crosshair point.
 public double getCrosshairY() 
    Get the y-value for the crosshair point. This is the coordinate in data space measured against the range axis.
 public int getDomainAxisIndex() 
    Returns the domain axis index for the crosshair x-value.
 public int getRangeAxisIndex() 
    Returns the range axis index for the crosshair y-value.
 public  void setAnchor(Point2D anchor) 
    Sets the anchor point. This is usually the mouse click point in a chart panel, and the crosshair point will often be the data item that is closest to the anchor point.

    Note that the x and y coordinates (in data space) are not updated by this method - the caller is responsible for ensuring that this happens in sync.
 public  void setAnchorX(double x) 
    Sets the x-coordinate (in data space) for the anchor point. Note that this does NOT update the anchor itself - the caller is responsible for ensuring this is done in sync.
 public  void setAnchorY(double y) 
    Sets the y-coordinate (in data space) for the anchor point. Note that this does NOT update the anchor itself - the caller is responsible for ensuring this is done in sync.
 public  void setCrosshairDistance(double distance) 
    Sets the distance between the anchor point and the current crosshair point. As each data point is processed, its distance to the anchor point is compared with this value and, if it is closer, the data point becomes the new crosshair point.
 public  void setCrosshairX(double x) 
    Sets the x coordinate for the crosshair. This is the coordinate in data space measured against the domain axis.
 public  void setCrosshairY(double y) 
    Sets the y coordinate for the crosshair.
 public  void updateCrosshairPoint(double x,
    double y,
    double transX,
    double transY,
    PlotOrientation orientation) 
Deprecated! Use - #updateCrosshairPoint(double, double, int, int, double, double, PlotOrientation) . See bug report 1086307.

    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 org.jfree.chart.renderer.xy.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.

 public  void updateCrosshairPoint(double x,
    double y,
    int domainAxisIndex,
    int rangeAxisIndex,
    double transX,
    double transY,
    PlotOrientation orientation) 
    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 org.jfree.chart.renderer.xy.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.

 public  void updateCrosshairX(double candidateX) 
Deprecated! Use - #updateCrosshairX(double, int) . See bug report 1086307.

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

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

 public  void updateCrosshairX(double candidateX,
    int domainAxisIndex) 
    Evaluates an x-value and if it is the closest to the anchor x-value it becomes the new crosshair value.

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

 public  void updateCrosshairY(double candidateY) 
Deprecated! Use - #updateCrosshairY(double, int) . See bug report 1086307.

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

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

 public  void updateCrosshairY(double candidateY,
    int rangeAxisIndex) 
    Evaluates a y-value and if it is the closest to the anchor y-value it becomes the new crosshair value.

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