Package org.jfree.chart.panel
Class 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:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddDomainCrosshair(Crosshair crosshair) Adds a crosshair against the domain axis and sends anOverlayChangeEventto all registered listeners.voidaddRangeCrosshair(Crosshair crosshair) Adds a crosshair against the range axis and sends anOverlayChangeEventto all registered listeners.voidClears all the domain crosshairs from the overlay and sends anOverlayChangeEventto all registered listeners.voidClears all the range crosshairs from the overlay and sends anOverlayChangeEventto all registered listeners.clone()Returns a clone of this instance.protected voiddrawHorizontalCrosshair(Graphics2D g2, Rectangle2D dataArea, double y, Crosshair crosshair) Draws a crosshair horizontally across the plot.protected voiddrawVerticalCrosshair(Graphics2D g2, Rectangle2D dataArea, double x, Crosshair crosshair) Draws a crosshair vertically on the plot.booleanTests this overlay for equality with an arbitrary object.Returns a new list containing the domain crosshairs for this overlay.Returns a new list containing the range crosshairs for this overlay.voidpaintOverlay(Graphics2D g2, ChartPanel chartPanel) Paints the crosshairs in the layer.voidReceives a property change event (typically a change in one of the crosshairs).voidremoveDomainCrosshair(Crosshair crosshair) Removes a domain axis crosshair and sends anOverlayChangeEventto all registered listeners.voidremoveRangeCrosshair(Crosshair crosshair) Removes a range axis crosshair and sends anOverlayChangeEventto all registered listeners.Methods inherited from class org.jfree.chart.panel.AbstractOverlay
addChangeListener, fireOverlayChanged, notifyListeners, removeChangeListenerMethods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.jfree.chart.panel.Overlay
addChangeListener, removeChangeListener
-
Constructor Details
-
CrosshairOverlay
public CrosshairOverlay()Default constructor.
-
-
Method Details
-
addDomainCrosshair
Adds a crosshair against the domain axis and sends anOverlayChangeEventto all registered listeners.- Parameters:
crosshair- the crosshair (nullnot permitted).- See Also:
-
removeDomainCrosshair
Removes a domain axis crosshair and sends anOverlayChangeEventto all registered listeners.- Parameters:
crosshair- the crosshair (nullnot permitted).- See Also:
-
clearDomainCrosshairs
Clears all the domain crosshairs from the overlay and sends anOverlayChangeEventto all registered listeners. -
getDomainCrosshairs
Returns a new list containing the domain crosshairs for this overlay.- Returns:
- A list of crosshairs.
-
addRangeCrosshair
Adds a crosshair against the range axis and sends anOverlayChangeEventto all registered listeners.- Parameters:
crosshair- the crosshair (nullnot permitted).
-
removeRangeCrosshair
Removes a range axis crosshair and sends anOverlayChangeEventto all registered listeners.- Parameters:
crosshair- the crosshair (nullnot permitted).- See Also:
-
clearRangeCrosshairs
Clears all the range crosshairs from the overlay and sends anOverlayChangeEventto all registered listeners. -
getRangeCrosshairs
Returns a new list containing the range crosshairs for this overlay.- Returns:
- A list of crosshairs.
-
propertyChange
Receives a property change event (typically a change in one of the crosshairs).- Specified by:
propertyChangein interfacePropertyChangeListener- Parameters:
e- the event.
-
paintOverlay
Paints the crosshairs in the layer.- Specified by:
paintOverlayin interfaceOverlay- Parameters:
g2- the graphics target.chartPanel- the chart panel.
-
drawHorizontalCrosshair
protected void drawHorizontalCrosshair(Graphics2D g2, Rectangle2D dataArea, double y, Crosshair crosshair) Draws a crosshair horizontally across the plot.- Parameters:
g2- the graphics target.dataArea- the data area.y- the y-value in Java2D space.crosshair- the crosshair.
-
drawVerticalCrosshair
protected void drawVerticalCrosshair(Graphics2D g2, Rectangle2D dataArea, double x, Crosshair crosshair) Draws a crosshair vertically on the plot.- Parameters:
g2- the graphics target.dataArea- the data area.x- the x-value in Java2D space.crosshair- the crosshair.
-
equals
Tests this overlay for equality with an arbitrary object. -
clone
Returns a clone of this instance.- Specified by:
clonein interfaceorg.jfree.util.PublicCloneable- Overrides:
clonein classObject- Returns:
- A clone of this instance.
- Throws:
CloneNotSupportedException- if there is some problem with the cloning.
-