org.jfree.chart.plot

Class CategoryMarker

Implemented Interfaces:
Cloneable, Serializable

public class CategoryMarker
extends Marker
implements Cloneable, Serializable

A marker for a category.
See Also:
CategoryPlot.addDomainMarker(CategoryMarker)

Constructor Summary

CategoryMarker(Comparable key)
Creates a new category marker.
CategoryMarker(Comparable key, Paint paint, Stroke stroke)
Creates a new category marker.
CategoryMarker(Comparable key, Paint paint, Stroke stroke, Paint outlinePaint, Stroke outlineStroke, float alpha)
Creates a new category marker.

Method Summary

boolean
equals(Object obj)
Tests the marker for equality with an arbitrary object.
boolean
getDrawAsLine()
Returns the flag that controls whether the marker is drawn as a region or a line.
Comparable
getKey()
Returns the key.
void
setDrawAsLine(boolean drawAsLine)
Sets the flag that controls whether the marker is drawn as a region or as a line.

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

clone, equals, getAlpha, getLabel, getLabelAnchor, getLabelFont, getLabelOffset, getLabelOffsetType, getLabelPaint, getLabelTextAnchor, getOutlinePaint, getOutlineStroke, getPaint, getStroke, setAlpha, setLabel, setLabelAnchor, setLabelFont, setLabelOffset, setLabelOffsetType, setLabelPaint, setLabelTextAnchor, setOutlinePaint, setOutlineStroke, setPaint, setStroke

Constructor Details

CategoryMarker

public CategoryMarker(Comparable key)
Creates a new category marker.
Parameters:
key - the category key.

CategoryMarker

public CategoryMarker(Comparable key,
                      Paint paint,
                      Stroke stroke)
Creates a new category marker.
Parameters:
key - the key.
paint - the paint (null not permitted).
stroke - the stroke (null not permitted).

CategoryMarker

public CategoryMarker(Comparable key,
                      Paint paint,
                      Stroke stroke,
                      Paint outlinePaint,
                      Stroke outlineStroke,
                      float alpha)
Creates a new category marker.
Parameters:
key - the key.
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.

Method Details

equals

public boolean equals(Object obj)
Tests the marker for equality with an arbitrary object.
Overrides:
equals in interface Marker
Parameters:
obj - the object (null permitted).
Returns:
A boolean.

getDrawAsLine

public boolean getDrawAsLine()
Returns the flag that controls whether the marker is drawn as a region or a line.
Returns:
A line.

getKey

public Comparable getKey()
Returns the key.
Returns:
The key.

setDrawAsLine

public void setDrawAsLine(boolean drawAsLine)
Sets the flag that controls whether the marker is drawn as a region or as a line.
Parameters:
drawAsLine - the flag.