Class Crosshair

java.lang.Object
org.jfree.chart.plot.Crosshair
All Implemented Interfaces:
Serializable, Cloneable, PublicCloneable
public class Crosshair extends Object implements Cloneable, PublicCloneable, Serializable
A Crosshair represents a value on a chart and is usually displayed as a line perpendicular to the x or y-axis (and sometimes including a label that shows the crosshair value as text). Instances of this class are used to store the cross hair value plus the visual characteristics of the line that will be rendered once the instance is added to a CrosshairOverlay (or CrosshairOverlaydFX if you are using the JavaFX extensions for JFreeChart).

Crosshairs support a property change mechanism which is used by JFreeChart to automatically repaint the overlay whenever a crosshair attribute is updated.
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    Crosshair()
    Creates a new crosshair with value 0.0.
    Crosshair(double value)
    Creates a new crosshair with the specified value.
    Crosshair(double value, Paint paint, Stroke stroke)
    Creates a new crosshair value with the specified value and line style.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addPropertyChangeListener(PropertyChangeListener l)
    Adds a property change listener.
    Object
    clone()
    Returns an independent copy of this instance.
    boolean
    equals(Object obj)
    Tests this crosshair for equality with an arbitrary object.
    RectangleAnchor
    getLabelAnchor()
    Returns the label anchor point.
    Paint
    getLabelBackgroundPaint()
    Returns the label background paint.
    Font
    getLabelFont()
    Returns the label font.
    CrosshairLabelGenerator
    getLabelGenerator()
    Returns the crosshair label generator.
    Paint
    getLabelOutlinePaint()
    Returns the label outline paint.
    Stroke
    getLabelOutlineStroke()
    Returns the label outline stroke.
    RectangleInsets
    getLabelPadding()
    Returns the label padding.
    Paint
    getLabelPaint()
    Returns the label paint.
    double
    getLabelXOffset()
    Returns the x-offset for the label (in Java2D units).
    double
    getLabelYOffset()
    Returns the y-offset for the label (in Java2D units).
    Paint
    getPaint()
    Returns the paint for the crosshair line.
    Stroke
    getStroke()
    Returns the stroke for the crosshair line.
    double
    getValue()
    Returns the crosshair value.
    int
    hashCode()
    Returns a hash code for this instance.
    boolean
    isLabelOutlineVisible()
    Returns the flag that controls the visibility of the label outline.
    boolean
    isLabelVisible()
    Returns the flag that controls whether a label is drawn for this crosshair.
    boolean
    isVisible()
    Returns the flag that indicates whether the crosshair is currently visible.
    void
    removePropertyChangeListener(PropertyChangeListener l)
    Removes a property change listener.
    void
    setLabelAnchor(RectangleAnchor anchor)
    Sets the label anchor point and sends a property change event (with the name 'labelAnchor') to all registered listeners.
    void
    setLabelBackgroundPaint(Paint paint)
    Sets the label background paint and sends a property change event with the name 'labelBackgroundPaint') to all registered listeners.
    void
    setLabelFont(Font font)
    Sets the label font and sends a property change event (with the name 'labelFont') to all registered listeners.
    void
    setLabelGenerator(CrosshairLabelGenerator generator)
    Sets the crosshair label generator and sends a property change event (with the name 'labelGenerator') to all registered listeners.
    void
    setLabelOutlinePaint(Paint paint)
    Sets the label outline paint and sends a property change event (with the name "labelOutlinePaint") to all registered listeners.
    void
    setLabelOutlineStroke(Stroke stroke)
    Sets the label outline stroke and sends a property change event (with the name 'labelOutlineStroke') to all registered listeners.
    void
    setLabelOutlineVisible(boolean visible)
    Sets the flag that controls the visibility of the label outlines and sends a property change event (with the name "labelOutlineVisible") to all registered listeners.
    void
    setLabelPadding(RectangleInsets padding)
    Sets the label padding and sends a property change event (with the name 'labelPadding') to all registered listeners.
    void
    setLabelPaint(Paint paint)
    Sets the label paint and sends a property change event (with the name 'labelPaint') to all registered listeners.
    void
    setLabelVisible(boolean visible)
    Sets the flag that controls whether a label is drawn for the crosshair and sends a property change event (with the name 'labelVisible') to all registered listeners.
    void
    setLabelXOffset(double offset)
    Sets the x-offset and sends a property change event (with the name 'labelXOffset') to all registered listeners.
    void
    setLabelYOffset(double offset)
    Sets the y-offset and sends a property change event (with the name 'labelYOffset') to all registered listeners.
    void
    setPaint(Paint paint)
    Sets the paint for the crosshair line and sends a property change event with the name "paint" to all registered listeners.
    void
    setStroke(Stroke stroke)
    Sets the stroke for the crosshair line and sends a property change event with the name "stroke" to all registered listeners.
    void
    setValue(double value)
    Sets the crosshair value and sends a property change event with the name 'value' to all registered listeners.
    void
    setVisible(boolean visible)
    Sets the flag that controls the visibility of the crosshair and sends a proerty change event (with the name 'visible') to all registered listeners.

    Methods inherited from class java.lang.Object

    finalize, getClass, notify, notifyAll, toString, wait, wait, wait