CrosshairOverlay

java.lang.Object
- org.jfree.chart.panel.AbstractOverlay
- - org.jfree.chart.panel.CrosshairOverlay

All Implemented Interfaces:

PropertyChangeListener, Serializable, Cloneable, EventListener, Overlay, org.jfree.util.PublicCloneable
```
public class CrosshairOverlay
extends AbstractOverlay
implements Overlay, PropertyChangeListener, org.jfree.util.PublicCloneable, Cloneable, Serializable
```
An overlay for a ChartPanel that draws crosshairs on a plot.

Since:

1.0.13

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

CrosshairOverlay()
Default constructor.

Constructors
Constructor and Description
`CrosshairOverlay()` Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDomainCrosshair(Crosshair crosshair)` Adds a crosshair against the domain axis and sends an `OverlayChangeEvent` to all registered listeners.
`void`	`addRangeCrosshair(Crosshair crosshair)` Adds a crosshair against the range axis and sends an `OverlayChangeEvent` to all registered listeners.
`void`	`clearDomainCrosshairs()` Clears all the domain crosshairs from the overlay and sends an `OverlayChangeEvent` to all registered listeners.
`void`	`clearRangeCrosshairs()` Clears all the range crosshairs from the overlay and sends an `OverlayChangeEvent` to all registered listeners.
`Object`	`clone()` Returns a clone of this instance.
`boolean`	`equals(Object obj)` Tests this overlay for equality with an arbitrary object.
`List`	`getDomainCrosshairs()` Returns a new list containing the domain crosshairs for this overlay.
`List`	`getRangeCrosshairs()` Returns a new list containing the range crosshairs for this overlay.
`void`	`paintOverlay(Graphics2D g2, ChartPanel chartPanel)` Paints the crosshairs in the layer.
`void`	`propertyChange(PropertyChangeEvent e)` Receives a property change event (typically a change in one of the crosshairs).
`void`	`removeDomainCrosshair(Crosshair crosshair)` Removes a domain axis crosshair and sends an `OverlayChangeEvent` to all registered listeners.
`void`	`removeRangeCrosshair(Crosshair crosshair)` Removes a range axis crosshair and sends an `OverlayChangeEvent` to all registered listeners.

Methods inherited from class org.jfree.chart.panel.AbstractOverlay
addChangeListener, fireOverlayChanged, removeChangeListener

Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jfree.chart.panel.Overlay
addChangeListener, removeChangeListener

- Constructor Detail
  - CrosshairOverlay
```
public CrosshairOverlay()
```
    Default constructor.
- Method Detail
  - addDomainCrosshair
```
public void addDomainCrosshair(Crosshair crosshair)
```
    Adds a crosshair against the domain axis and sends an OverlayChangeEvent to all registered listeners.
    
    Parameters:
    
    crosshair - the crosshair (null not permitted).
    
    See Also:
    
    removeDomainCrosshair(org.jfree.chart.plot.Crosshair), addRangeCrosshair(org.jfree.chart.plot.Crosshair)
  - removeDomainCrosshair
```
public void removeDomainCrosshair(Crosshair crosshair)
```
    Removes a domain axis crosshair and sends an OverlayChangeEvent to all registered listeners.
    
    Parameters:
    
    crosshair - the crosshair (null not permitted).
    
    See Also:
    
    addDomainCrosshair(org.jfree.chart.plot.Crosshair)
  - clearDomainCrosshairs
```
public void clearDomainCrosshairs()
```
    Clears all the domain crosshairs from the overlay and sends an OverlayChangeEvent to all registered listeners.
  - getDomainCrosshairs
```
public List getDomainCrosshairs()
```
    Returns a new list containing the domain crosshairs for this overlay.
    
    Returns:
    
    A list of crosshairs.
  - addRangeCrosshair
```
public void addRangeCrosshair(Crosshair crosshair)
```
    Adds a crosshair against the range axis and sends an OverlayChangeEvent to all registered listeners.
    
    Parameters:
    
    crosshair - the crosshair (null not permitted).
  - removeRangeCrosshair
```
public void removeRangeCrosshair(Crosshair crosshair)
```
    Removes a range axis crosshair and sends an OverlayChangeEvent to all registered listeners.
    
    Parameters:
    
    crosshair - the crosshair (null not permitted).
    
    See Also:
    
    addRangeCrosshair(org.jfree.chart.plot.Crosshair)
  - clearRangeCrosshairs
```
public void clearRangeCrosshairs()
```
    Clears all the range crosshairs from the overlay and sends an OverlayChangeEvent to all registered listeners.
  - getRangeCrosshairs
```
public List getRangeCrosshairs()
```
    Returns a new list containing the range crosshairs for this overlay.
    
    Returns:
    
    A list of crosshairs.
  - propertyChange
```
public void propertyChange(PropertyChangeEvent e)
```
    Receives a property change event (typically a change in one of the crosshairs).
    
    Specified by:
    
    propertyChange in interface PropertyChangeListener
    
    Parameters:
    
    e - the event.
  - paintOverlay
```
public void paintOverlay(Graphics2D g2,
                         ChartPanel chartPanel)
```
    Paints the crosshairs in the layer.
    
    Specified by:
    
    paintOverlay in interface Overlay
    
    Parameters:
    
    g2 - the graphics target.
    
    chartPanel - the chart panel.
  - equals
```
public boolean equals(Object obj)
```
    Tests this overlay for equality with an arbitrary object.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - the object (null permitted).
    
    Returns:
    
    A boolean.
  - clone
```
public Object clone()
             throws CloneNotSupportedException
```
    Returns a clone of this instance.
    
    Specified by:
    
    clone in interface org.jfree.util.PublicCloneable
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    A clone of this instance.
    
    Throws:
    
    CloneNotSupportedException - if there is some problem with the cloning.

Class CrosshairOverlay

Constructor Summary

Method Summary

Methods inherited from class org.jfree.chart.panel.AbstractOverlay

Methods inherited from class java.lang.Object

Methods inherited from interface org.jfree.chart.panel.Overlay

Constructor Detail

CrosshairOverlay

Method Detail

addDomainCrosshair

removeDomainCrosshair

clearDomainCrosshairs

getDomainCrosshairs

addRangeCrosshair

removeRangeCrosshair

clearRangeCrosshairs

getRangeCrosshairs

propertyChange

paintOverlay

equals

clone