Module org.jfree.chart

Package org.jfree.chart.plot

Class ValueMarker

java.lang.Object

org.jfree.chart.plot.Marker

org.jfree.chart.plot.ValueMarker

All Implemented Interfaces:

Serializable, Cloneable

public class ValueMarker
extends Marker

A marker that represents a single value. Markers can be added to plots to highlight specific values.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ValueMarker(double value)	Creates a new marker.
ValueMarker(double value, Paint paint, Stroke stroke)	Creates a new marker.
ValueMarker(double value, Paint paint, Stroke stroke, Paint outlinePaint, Stroke outlineStroke, float alpha)	Creates a new value marker.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Tests this marker for equality with an arbitrary object.
double	getValue()	Returns the value.
void	setValue(double value)	Sets the value for the marker and sends a MarkerChangeEvent to all registered listeners.

Methods inherited from class org.jfree.chart.plot.Marker

addChangeListener, clone, getAlpha, getLabel, getLabelAnchor, getLabelBackgroundColor, getLabelFont, getLabelOffset, getLabelOffsetType, getLabelPaint, getLabelTextAnchor, getListeners, getOutlinePaint, getOutlineStroke, getPaint, getStroke, hashCode, notifyListeners, removeChangeListener, setAlpha, setLabel, setLabelAnchor, setLabelBackgroundColor, setLabelFont, setLabelOffset, setLabelOffsetType, setLabelPaint, setLabelTextAnchor, setOutlinePaint, setOutlineStroke, setPaint, setStroke

Methods inherited from class java.lang.Object

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

Constructor Detail

ValueMarker

public ValueMarker(double value)

Creates a new marker.

Parameters:

value - the value.

ValueMarker

public ValueMarker(double value,
                   Paint paint,
                   Stroke stroke)

Creates a new marker.

Parameters:

value - the value.

paint - the paint (null not permitted).

stroke - the stroke (null not permitted).

ValueMarker

public ValueMarker(double value,
                   Paint paint,
                   Stroke stroke,
                   Paint outlinePaint,
                   Stroke outlineStroke,
                   float alpha)

Creates a new value marker.

Parameters:

value - the value.

paint - the paint (null not permitted).

stroke - the stroke (null not permitted).

outlinePaint - the outline paint (null permitted).

outlineStroke - the outline stroke (null permitted).

alpha - the alpha transparency (in the range 0.0f to 1.0f).

Method Detail

getValue

public double getValue()

Returns the value.

Returns:

The value.

See Also:

setValue(double)

setValue

public void setValue(double value)

Sets the value for the marker and sends a MarkerChangeEvent to all registered listeners.

Parameters:

value - the value.

See Also:

getValue()

equals

public boolean equals(Object obj)

Tests this marker for equality with an arbitrary object. This method returns true if:

• obj is not null;
• obj is an instance of ValueMarker;
• obj has the same value as this marker;
• super.equals(obj) returns true.

Overrides:

equals in class Marker

Parameters:

obj - the object (null permitted).

Returns:

A boolean.