org.jfree.chart.annotations

Class CategoryLineAnnotation

public class CategoryLineAnnotation extends Object implements CategoryAnnotation, Cloneable, PublicCloneable, Serializable

A line annotation that can be placed on a CategoryPlot.
Constructor Summary
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).
Method Summary
Objectclone()
Returns a clone of the annotation.
voiddraw(Graphics2D g2, CategoryPlot plot, Rectangle2D dataArea, CategoryAxis domainAxis, ValueAxis rangeAxis)
Draws the annotation.
booleanequals(Object obj)
Tests this object for equality with another.
ComparablegetCategory1()
Returns the category for the start of the line.
ComparablegetCategory2()
Returns the category for the end of the line.
PaintgetPaint()
Returns the paint used to draw the connecting line.
StrokegetStroke()
Returns the stroke used to draw the connecting line.
doublegetValue1()
Returns the y-value for the start of the line.
doublegetValue2()
Returns the y-value for the end of the line.
inthashCode()
Returns a hash code for this instance.
voidsetCategory1(Comparable category)
Sets the category for the start of the line.
voidsetCategory2(Comparable category)
Sets the category for the end of the line.
voidsetPaint(Paint paint)
Sets the paint used to draw the connecting line.
voidsetStroke(Stroke stroke)
Sets the stroke used to draw the connecting line.
voidsetValue1(double value)
Sets the y-value for the start of the line.
voidsetValue2(double value)
Sets the y-value for the end of the line.

Constructor Detail

CategoryLineAnnotation

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).

Method Detail

clone

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.

draw

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.

equals

public boolean equals(Object obj)
Tests this object for equality with another.

Parameters: obj the object (null permitted).

Returns: true or false.

getCategory1

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

getCategory2

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

getPaint

public Paint getPaint()
Returns the paint used to draw the connecting line.

Returns: The paint (never null).

See Also: setPaint

getStroke

public Stroke getStroke()
Returns the stroke used to draw the connecting line.

Returns: The stroke (never null).

See Also: setStroke

getValue1

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

getValue2

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

hashCode

public int hashCode()
Returns a hash code for this instance.

Returns: A hash code.

setCategory1

public void setCategory1(Comparable category)
Sets the category for the start of the line.

Parameters: category the category (null not permitted).

See Also: getCategory1

setCategory2

public void setCategory2(Comparable category)
Sets the category for the end of the line.

Parameters: category the category (null not permitted).

See Also: getCategory2

setPaint

public void setPaint(Paint paint)
Sets the paint used to draw the connecting line.

Parameters: paint the paint (null not permitted).

See Also: getPaint

setStroke

public void setStroke(Stroke stroke)
Sets the stroke used to draw the connecting line.

Parameters: stroke the stroke (null not permitted).

See Also: getStroke

setValue1

public void setValue1(double value)
Sets the y-value for the start of the line.

Parameters: value the value.

See Also: getValue1

setValue2

public void setValue2(double value)
Sets the y-value for the end of the line.

Parameters: value the value.

See Also: getValue2

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