Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.jfree.chart.plot

Class CategoryMarker

Implemented Interfaces:
Cloneable, Serializable
public class CategoryMarker
extends Marker
implements Cloneable, Serializable
A marker for a category.

Note that for serialization to work correctly, the category key must be an instance of a serializable class.
See Also:
CategoryPlot.addDomainMarker(CategoryMarker)

Constructor Summary

CategoryMarker(Comparable key)
Creates a new category marker for the specified category.
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, and sends a MarkerChangeEvent to all registered listeners.
void
setKey(Comparable key)
Sets the key and sends a MarkerChangeEvent to all registered listeners.

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

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

Constructor Details

CategoryMarker

public CategoryMarker(Comparable key)
Creates a new category marker for the specified category.
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, and sends a MarkerChangeEvent to all registered listeners.
Parameters:
drawAsLine - the flag.

setKey

public void setKey(Comparable key)
Sets the key and sends a MarkerChangeEvent to all registered listeners.
Parameters:
key - the key (null not permitted).
Since:
1.0.3

Overview Package Class Use Source Tree Index Deprecated About