org.jfree.chart.plot
Class CategoryMarker

java.lang.Object
  extended byorg.jfree.chart.plot.Marker
      extended byorg.jfree.chart.plot.CategoryMarker
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable

public class CategoryMarker
extends Marker
implements java.lang.Cloneable, java.io.Serializable

A marker for a category.

See Also:
CategoryPlot.addDomainMarker(CategoryMarker), Serialized Form

Constructor Summary
CategoryMarker(java.lang.Comparable key)
          Creates a new category marker.
CategoryMarker(java.lang.Comparable key, java.awt.Paint paint, java.awt.Stroke stroke)
          Creates a new category marker.
CategoryMarker(java.lang.Comparable key, java.awt.Paint paint, java.awt.Stroke stroke, java.awt.Paint outlinePaint, java.awt.Stroke outlineStroke, float alpha)
          Creates a new category marker.
 
Method Summary
 boolean equals(java.lang.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.
 java.lang.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, getAlpha, getLabel, getLabelAnchor, getLabelFont, getLabelOffset, getLabelOffsetType, getLabelPaint, getLabelTextAnchor, getOutlinePaint, getOutlineStroke, getPaint, getStroke, setAlpha, setLabel, setLabelAnchor, setLabelFont, setLabelOffset, setLabelOffsetType, setLabelPaint, setLabelTextAnchor, setOutlinePaint, setOutlineStroke, setPaint, setStroke
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CategoryMarker

public CategoryMarker(java.lang.Comparable key)
Creates a new category marker.

Parameters:
key - the category key.

CategoryMarker

public CategoryMarker(java.lang.Comparable key,
                      java.awt.Paint paint,
                      java.awt.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(java.lang.Comparable key,
                      java.awt.Paint paint,
                      java.awt.Stroke stroke,
                      java.awt.Paint outlinePaint,
                      java.awt.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

getKey

public java.lang.Comparable getKey()
Returns the key.

Returns:
The key.

getDrawAsLine

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

Returns:
A line.

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.

equals

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

Overrides:
equals in class Marker
Parameters:
obj - the object (null permitted).
Returns:
A boolean.