org.jfree.chart.plot

Class CategoryMarker

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: addDomainMarker

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
booleanequals(Object obj)
Tests the marker for equality with an arbitrary object.
booleangetDrawAsLine()
Returns the flag that controls whether the marker is drawn as a region or a line.
ComparablegetKey()
Returns the key.
voidsetDrawAsLine(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.
voidsetKey(Comparable key)
Sets the key and sends a MarkerChangeEvent to all registered listeners.

Constructor Detail

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 Detail

equals

public boolean equals(Object obj)
Tests the marker for equality with an arbitrary object.

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

Copyright © 2000-2009 by Object Refinery Limited. All Rights Reserved.