Package org.jfree.chart.plot
Class Crosshair
java.lang.Object
org.jfree.chart.plot.Crosshair
- All Implemented Interfaces:
Serializable
,Cloneable
,PublicCloneable
A crosshair for display on a plot.
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds a property change listener.clone()
Returns an independent copy of this instance.boolean
Tests this crosshair for equality with an arbitrary object.Returns the label anchor point.Returns the label background paint.Returns the label font.Returns the crosshair label generator.Returns the label outline paint.Returns the label outline stroke.Returns the label paint.double
Returns the x-offset for the label (in Java2D units).double
Returns the y-offset for the label (in Java2D units).getPaint()
Returns the paint for the crosshair line.Returns the stroke for the crosshair line.double
getValue()
Returns the crosshair value.int
hashCode()
Returns a hash code for this instance.boolean
Returns the flag that controls the visibility of the label outline.boolean
Returns the flag that controls whether or not a label is drawn for this crosshair.boolean
Returns the flag that indicates whether or not the crosshair is currently visible.void
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
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 or not 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
Sets the paint for the crosshair line and sends a property change event with the name "paint" to all registered listeners.void
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.
-
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 (null
not permitted).stroke
- the line stroke (null
not permitted).
-
-
Method Details
-
isVisible
Returns the flag that indicates whether or not the crosshair is currently visible.- Returns:
- A boolean.
- See Also:
-
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:
-
getValue
Returns the crosshair value.- Returns:
- The crosshair value.
- See Also:
-
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:
-
getPaint
Returns the paint for the crosshair line.- Returns:
- The paint (never
null
). - See Also:
-
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 (null
not permitted).- See Also:
-
getStroke
Returns the stroke for the crosshair line.- Returns:
- The stroke (never
null
). - See Also:
-
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 (null
not permitted).- See Also:
-
isLabelVisible
Returns the flag that controls whether or not a label is drawn for this crosshair.- Returns:
- A boolean.
- See Also:
-
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:
-
getLabelGenerator
Returns the crosshair label generator.- Returns:
- The label crosshair generator (never
null
). - See Also:
-
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 (null
not permitted).- See Also:
-
getLabelAnchor
Returns the label anchor point.- Returns:
- the label anchor point (never
null
. - See Also:
-
setLabelAnchor
Sets the label anchor point and sends a property change event (with the name 'labelAnchor') to all registered listeners.- Parameters:
anchor
- the anchor (null
not permitted).- See Also:
-
getLabelXOffset
Returns the x-offset for the label (in Java2D units).- Returns:
- The x-offset.
- See Also:
-
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:
-
getLabelYOffset
Returns the y-offset for the label (in Java2D units).- Returns:
- The y-offset.
- See Also:
-
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:
-
getLabelFont
Returns the label font.- Returns:
- The label font (never
null
). - See Also:
-
setLabelFont
Sets the label font and sends a property change event (with the name 'labelFont') to all registered listeners.- Parameters:
font
- the font (null
not permitted).- See Also:
-
getLabelPaint
Returns the label paint. The default value isColor.BLACK
.- Returns:
- The label paint (never
null
). - See Also:
-
setLabelPaint
Sets the label paint and sends a property change event (with the name 'labelPaint') to all registered listeners.- Parameters:
paint
- the paint (null
not permitted).- See Also:
-
getLabelBackgroundPaint
Returns the label background paint.- Returns:
- The label background paint (possibly
null
). - See Also:
-
setLabelBackgroundPaint
Sets the label background paint and sends a property change event with the name 'labelBackgroundPaint') to all registered listeners.- Parameters:
paint
- the paint (null
permitted).- See Also:
-
isLabelOutlineVisible
Returns the flag that controls the visibility of the label outline. The default value istrue
.- Returns:
- A boolean.
- See Also:
-
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:
-
getLabelOutlinePaint
Returns the label outline paint.- Returns:
- The label outline paint (never
null
). - See Also:
-
setLabelOutlinePaint
Sets the label outline paint and sends a property change event (with the name "labelOutlinePaint") to all registered listeners.- Parameters:
paint
- the paint (null
not permitted).- See Also:
-
getLabelOutlineStroke
Returns the label outline stroke. The default value isBasicStroke(0.5)
.- Returns:
- The label outline stroke (never
null
). - See Also:
-
setLabelOutlineStroke
Sets the label outline stroke and sends a property change event (with the name 'labelOutlineStroke') to all registered listeners.- Parameters:
stroke
- the stroke (null
not permitted).- See Also:
-
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:
clone
in interfacePublicCloneable
- Overrides:
clone
in 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
Removes a property change listener.- Parameters:
l
- the listener.- See Also:
-