Package org.jfree.chart.plot
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 for display on a plot.
- See Also:
- Serialized Form
-
Constructor Summary
-
Method Summary
Modifier and Type Method Description voidaddPropertyChangeListener(PropertyChangeListener l)Adds a property change listener.Objectclone()Returns an independent copy of this instance.booleanequals(Object obj)Tests this crosshair for equality with an arbitrary object.RectangleAnchorgetLabelAnchor()Returns the label anchor point.PaintgetLabelBackgroundPaint()Returns the label background paint.FontgetLabelFont()Returns the label font.CrosshairLabelGeneratorgetLabelGenerator()Returns the crosshair label generator.PaintgetLabelOutlinePaint()Returns the label outline paint.StrokegetLabelOutlineStroke()Returns the label outline stroke.PaintgetLabelPaint()Returns the label paint.doublegetLabelXOffset()Returns the x-offset for the label (in Java2D units).doublegetLabelYOffset()Returns the y-offset for the label (in Java2D units).PaintgetPaint()Returns the paint for the crosshair line.StrokegetStroke()Returns the stroke for the crosshair line.doublegetValue()Returns the crosshair value.inthashCode()Returns a hash code for this instance.booleanisLabelOutlineVisible()Returns the flag that controls the visibility of the label outline.booleanisLabelVisible()Returns the flag that controls whether or not a label is drawn for this crosshair.booleanisVisible()Returns the flag that indicates whether or not the crosshair is currently visible.voidremovePropertyChangeListener(PropertyChangeListener l)Removes a property change listener.voidsetLabelAnchor(RectangleAnchor anchor)Sets the label anchor point and sends a property change event (with the name 'labelAnchor') to all registered listeners.voidsetLabelBackgroundPaint(Paint paint)Sets the label background paint and sends a property change event with the name 'labelBackgroundPaint') to all registered listeners.voidsetLabelFont(Font font)Sets the label font and sends a property change event (with the name 'labelFont') to all registered listeners.voidsetLabelGenerator(CrosshairLabelGenerator generator)Sets the crosshair label generator and sends a property change event (with the name 'labelGenerator') to all registered listeners.voidsetLabelOutlinePaint(Paint paint)Sets the label outline paint and sends a property change event (with the name "labelOutlinePaint") to all registered listeners.voidsetLabelOutlineStroke(Stroke stroke)Sets the label outline stroke and sends a property change event (with the name 'labelOutlineStroke') to all registered listeners.voidsetLabelOutlineVisible(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.voidsetLabelPaint(Paint paint)Sets the label paint and sends a property change event (with the name 'labelPaint') to all registered listeners.voidsetLabelVisible(boolean visible)Sets the flag that controls whether or not a label is drawn for the crosshair and sends a property change event (with the name 'labelVisible') to all registered listeners.voidsetLabelXOffset(double offset)Sets the x-offset and sends a property change event (with the name 'labelXOffset') to all registered listeners.voidsetLabelYOffset(double offset)Sets the y-offset and sends a property change event (with the name 'labelYOffset') to all registered listeners.voidsetPaint(Paint paint)Sets the paint for the crosshair line and sends a property change event with the name "paint" to all registered listeners.voidsetStroke(Stroke stroke)Sets the stroke for the crosshair line and sends a property change event with the name "stroke" to all registered listeners.voidsetValue(double value)Sets the crosshair value and sends a property change event with the name 'value' to all registered listeners.voidsetVisible(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.
-
Constructor Details
-
Crosshair
public Crosshair()Creates a new crosshair with value 0.0. -
Crosshair
Creates a new crosshair with the specified value.- Parameters:
value- the value.
-
Crosshair
Creates a new crosshair value with the specified value and line style.- Parameters:
value- the value.paint- the line paint (nullnot permitted).stroke- the line stroke (nullnot permitted).
-
-
Method Details
-
isVisible
Returns the flag that indicates whether or not the crosshair is currently visible.- Returns:
- A boolean.
- See Also:
setVisible(boolean)
-
setVisible
Sets the flag that controls the visibility of the crosshair and sends a proerty change event (with the name 'visible') to all registered listeners.- Parameters:
visible- the new flag value.- See Also:
isVisible()
-
getValue
Returns the crosshair value.- Returns:
- The crosshair value.
- See Also:
setValue(double)
-
setValue
Sets the crosshair value and sends a property change event with the name 'value' to all registered listeners.- Parameters:
value- the value.- See Also:
getValue()
-
getPaint
Returns the paint for the crosshair line.- Returns:
- The paint (never
null). - See Also:
setPaint(java.awt.Paint)
-
setPaint
Sets the paint for the crosshair line and sends a property change event with the name "paint" to all registered listeners.- Parameters:
paint- the paint (nullnot permitted).- See Also:
getPaint()
-
getStroke
Returns the stroke for the crosshair line.- Returns:
- The stroke (never
null). - See Also:
setStroke(java.awt.Stroke)
-
setStroke
Sets the stroke for the crosshair line and sends a property change event with the name "stroke" to all registered listeners.- Parameters:
stroke- the stroke (nullnot permitted).- See Also:
getStroke()
-
isLabelVisible
Returns the flag that controls whether or not a label is drawn for this crosshair.- Returns:
- A boolean.
- See Also:
setLabelVisible(boolean)
-
setLabelVisible
Sets the flag that controls whether or not a label is drawn for the crosshair and sends a property change event (with the name 'labelVisible') to all registered listeners.- Parameters:
visible- the new flag value.- See Also:
isLabelVisible()
-
getLabelGenerator
Returns the crosshair label generator.- Returns:
- The label crosshair generator (never
null). - See Also:
setLabelGenerator(org.jfree.chart.labels.CrosshairLabelGenerator)
-
setLabelGenerator
Sets the crosshair label generator and sends a property change event (with the name 'labelGenerator') to all registered listeners.- Parameters:
generator- the new generator (nullnot permitted).- See Also:
getLabelGenerator()
-
getLabelAnchor
Returns the label anchor point.- Returns:
- the label anchor point (never
null. - See Also:
setLabelAnchor(org.jfree.chart.ui.RectangleAnchor)
-
setLabelAnchor
Sets the label anchor point and sends a property change event (with the name 'labelAnchor') to all registered listeners.- Parameters:
anchor- the anchor (nullnot permitted).- See Also:
getLabelAnchor()
-
getLabelXOffset
Returns the x-offset for the label (in Java2D units).- Returns:
- The x-offset.
- See Also:
setLabelXOffset(double)
-
setLabelXOffset
Sets the x-offset and sends a property change event (with the name 'labelXOffset') to all registered listeners.- Parameters:
offset- the new offset.- See Also:
getLabelXOffset()
-
getLabelYOffset
Returns the y-offset for the label (in Java2D units).- Returns:
- The y-offset.
- See Also:
setLabelYOffset(double)
-
setLabelYOffset
Sets the y-offset and sends a property change event (with the name 'labelYOffset') to all registered listeners.- Parameters:
offset- the new offset.- See Also:
getLabelYOffset()
-
getLabelFont
Returns the label font.- Returns:
- The label font (never
null). - See Also:
setLabelFont(java.awt.Font)
-
setLabelFont
Sets the label font and sends a property change event (with the name 'labelFont') to all registered listeners.- Parameters:
font- the font (nullnot permitted).- See Also:
getLabelFont()
-
getLabelPaint
Returns the label paint. The default value isColor.BLACK.- Returns:
- The label paint (never
null). - See Also:
setLabelPaint(java.awt.Paint)
-
setLabelPaint
Sets the label paint and sends a property change event (with the name 'labelPaint') to all registered listeners.- Parameters:
paint- the paint (nullnot permitted).- See Also:
getLabelPaint()
-
getLabelBackgroundPaint
Returns the label background paint.- Returns:
- The label background paint (possibly
null). - See Also:
setLabelBackgroundPaint(java.awt.Paint)
-
setLabelBackgroundPaint
Sets the label background paint and sends a property change event with the name 'labelBackgroundPaint') to all registered listeners.- Parameters:
paint- the paint (nullpermitted).- See Also:
getLabelBackgroundPaint()
-
isLabelOutlineVisible
Returns the flag that controls the visibility of the label outline. The default value istrue.- Returns:
- A boolean.
- See Also:
setLabelOutlineVisible(boolean)
-
setLabelOutlineVisible
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.- Parameters:
visible- the new flag value.- See Also:
isLabelOutlineVisible()
-
getLabelOutlinePaint
Returns the label outline paint.- Returns:
- The label outline paint (never
null). - See Also:
setLabelOutlinePaint(java.awt.Paint)
-
setLabelOutlinePaint
Sets the label outline paint and sends a property change event (with the name "labelOutlinePaint") to all registered listeners.- Parameters:
paint- the paint (nullnot permitted).- See Also:
getLabelOutlinePaint()
-
getLabelOutlineStroke
Returns the label outline stroke. The default value isBasicStroke(0.5).- Returns:
- The label outline stroke (never
null). - See Also:
setLabelOutlineStroke(java.awt.Stroke)
-
setLabelOutlineStroke
Sets the label outline stroke and sends a property change event (with the name 'labelOutlineStroke') to all registered listeners.- Parameters:
stroke- the stroke (nullnot permitted).- See Also:
getLabelOutlineStroke()
-
equals
Tests this crosshair for equality with an arbitrary object. -
hashCode
Returns a hash code for this instance. -
clone
Returns an independent copy of this instance.- Specified by:
clonein interfacePublicCloneable- Overrides:
clonein classObject- Returns:
- An independent copy of this instance.
- Throws:
CloneNotSupportedException- if there is a problem with cloning.
-
addPropertyChangeListener
Adds a property change listener.- Parameters:
l- the listener.- See Also:
removePropertyChangeListener(java.beans.PropertyChangeListener)
-
removePropertyChangeListener
Removes a property change listener.- Parameters:
l- the listener.- See Also:
addPropertyChangeListener(java.beans.PropertyChangeListener)
-