public class

CategoryLineAnnotation

extends Object
implements Serializable Cloneable CategoryAnnotation
java.lang.Object
   ↳ org.jfree.chart.annotations.CategoryLineAnnotation

Class Overview

A line annotation that can be placed on a CategoryPlot.

Summary

Public Constructors
CategoryLineAnnotation(Comparable category1, double value1, Comparable category2, double value2, Paint paint, Stroke stroke)
Creates a new annotation that draws a line between (category1, value1) and (category2, value2).
Public Methods
Object clone()
Returns a clone of the annotation.
void draw(Graphics2D g2, CategoryPlot plot, Rectangle2D dataArea, CategoryAxis domainAxis, ValueAxis rangeAxis)
Draws the annotation.
boolean equals(Object obj)
Tests this object for equality with another.
Comparable getCategory1()
Returns the category for the start of the line.
Comparable getCategory2()
Returns the category for the end of the line.
Paint getPaint()
Returns the paint used to draw the connecting line.
Stroke getStroke()
Returns the stroke used to draw the connecting line.
double getValue1()
Returns the y-value for the start of the line.
double getValue2()
Returns the y-value for the end of the line.
int hashCode()
Returns a hash code for this instance.
void setCategory1(Comparable category)
Sets the category for the start of the line.
void setCategory2(Comparable category)
Sets the category for the end of the line.
void setPaint(Paint paint)
Sets the paint used to draw the connecting line.
void setStroke(Stroke stroke)
Sets the stroke used to draw the connecting line.
void setValue1(double value)
Sets the y-value for the start of the line.
void setValue2(double value)
Sets the y-value for the end of the line.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.jfree.chart.annotations.CategoryAnnotation

Public Constructors

public CategoryLineAnnotation (Comparable category1, double value1, Comparable category2, double value2, Paint paint, Stroke stroke)

Creates a new annotation that draws a line between (category1, value1) and (category2, value2).

Parameters
category1 the category (null not permitted).
value1 the value.
category2 the category (null not permitted).
value2 the value.
paint the line color (null not permitted).
stroke the line stroke (null not permitted).

Public Methods

public Object clone ()

Returns a clone of the annotation.

Returns
  • A clone.
Throws
CloneNotSupportedException this class will not throw this exception, but subclasses (if any) might.

public void draw (Graphics2D g2, CategoryPlot plot, Rectangle2D dataArea, CategoryAxis domainAxis, ValueAxis rangeAxis)

Draws the annotation.

Parameters
g2 the graphics device.
plot the plot.
dataArea the data area.
domainAxis the domain axis.
rangeAxis the range axis.

public boolean equals (Object obj)

Tests this object for equality with another.

Parameters
obj the object (null permitted).
Returns
  • true or false.

public Comparable getCategory1 ()

Returns the category for the start of the line.

Returns
  • The category for the start of the line (never null).
See Also

public Comparable getCategory2 ()

Returns the category for the end of the line.

Returns
  • The category for the end of the line (never null).
See Also

public Paint getPaint ()

Returns the paint used to draw the connecting line.

Returns
  • The paint (never null).
See Also

public Stroke getStroke ()

Returns the stroke used to draw the connecting line.

Returns
  • The stroke (never null).
See Also

public double getValue1 ()

Returns the y-value for the start of the line.

Returns
  • The y-value for the start of the line.
See Also

public double getValue2 ()

Returns the y-value for the end of the line.

Returns
  • The y-value for the end of the line.
See Also

public int hashCode ()

Returns a hash code for this instance.

Returns
  • A hash code.

public void setCategory1 (Comparable category)

Sets the category for the start of the line.

Parameters
category the category (null not permitted).
See Also

public void setCategory2 (Comparable category)

Sets the category for the end of the line.

Parameters
category the category (null not permitted).
See Also

public void setPaint (Paint paint)

Sets the paint used to draw the connecting line.

Parameters
paint the paint (null not permitted).
See Also

public void setStroke (Stroke stroke)

Sets the stroke used to draw the connecting line.

Parameters
stroke the stroke (null not permitted).
See Also

public void setValue1 (double value)

Sets the y-value for the start of the line.

Parameters
value the value.
See Also

public void setValue2 (double value)

Sets the y-value for the end of the line.

Parameters
value the value.
See Also