com.ijchart.xychart.annotation
Class CategoryTextAnnotation

java.lang.Object
  extended by com.ijchart.xychart.annotation.AbstractAnnotation
      extended by com.ijchart.xychart.annotation.AbstractTextAnnotation
          extended by com.ijchart.xychart.annotation.CategoryTextAnnotation
All Implemented Interfaces:
IAnnotation, ICategoryAnnotation, IAnnotationChangeListener, java.io.Serializable, java.lang.Cloneable, java.util.EventListener
Direct Known Subclasses:
CategoryTextAndPointerAnnotation

public class CategoryTextAnnotation
extends AbstractTextAnnotation
implements ICategoryAnnotation, java.lang.Cloneable, java.io.Serializable

Title: IJChart

A text annotation that can be placed on a CategoryPlot.

Description: a chart library for the Java(tm) platform.

Copyright: Copyright (c) 2013

Company:

Version:
1.0
Author:
zhang feng min,shanghai china. Contract me by email.
See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.ijchart.xychart.annotation.AbstractTextAnnotation
DEFAULT_FONT, DEFAULT_PAINT, DEFAULT_ROTATION_ANGLE, DEFAULT_TEXT_DIRECTION, DEFAULT_TEXT_HORIZONTAL_ALIGNMENT, DEFAULT_TEXT_POSITION, DEFAULT_TEXT_VERTICAL_ALIGNMENT
 
Constructor Summary
CategoryTextAnnotation(java.lang.String text, java.lang.Object category, double value)
           Creates a new annotation to be displayed at the given location.
 
Method Summary
 java.lang.Object clone()
           Creates and returns a copy of this object.
 void drawAnnotation(CategoryAxis categoryAxis, AbstractValueAxis valueAxis, RectangleEdge valueAxisEdge, java.awt.geom.Rectangle2D dataArea, ChartOrientation orientation, AnnotationShapeCollection annotationShapes)
           Draws the annotation.
 boolean equals(java.lang.Object obj)
           Tests this instance for equality with an arbitrary object.
 java.lang.Object getCategory()
           Returns the category.
 double getValue()
           Returns the value.
 int hashCode()
           Returns a hash code value for the object.
 void setCategory(java.lang.Object category)
           Sets the category and sends an AnnotationChangeEvent to all registered listeners.
 void setValue(double value)
           Sets the value and sends an AnnotationChangeEvent to all registered listeners.
 java.lang.String toString()
           Returns a string representation of the object.
 
Methods inherited from class com.ijchart.xychart.annotation.AbstractTextAnnotation
getRotationAngle, getText, getTextDirection, getTextFont, getTextHorizontalAlign, getTextPaint, getTextPosition, getTextVerticalAlign, horizontalAlignToAnchor, setRotationAngle, setText, setTextDirection, setTextFont, setTextHorizontalAlign, setTextPaint, setTextPosition, setTextVerticalAlign
 
Methods inherited from class com.ijchart.xychart.annotation.AbstractAnnotation
addChangeListener, annotationChanged, fireAnnotationChanged, getTooltipText, hasListener, notifyListeners, removeAllChangeListener, removeChangeListener, setTooltipText
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CategoryTextAnnotation

public CategoryTextAnnotation(java.lang.String text,
                              java.lang.Object category,
                              double value)
Creates a new annotation to be displayed at the given location.

Parameters:
text - String The text (null not permitted).
category - Object The category (null not permitted).
value - double The value.
Method Detail

getCategory

public java.lang.Object getCategory()
Returns the category.

Returns:
The category (never null).

setCategory

public void setCategory(java.lang.Object category)
Sets the category and sends an AnnotationChangeEvent to all registered listeners.

Parameters:
category - Object The category (null not permitted).

getValue

public double getValue()
Returns the value.

Returns:
double The value.

setValue

public void setValue(double value)
Sets the value and sends an AnnotationChangeEvent to all registered listeners.

Parameters:
value - The value.

drawAnnotation

public void drawAnnotation(CategoryAxis categoryAxis,
                           AbstractValueAxis valueAxis,
                           RectangleEdge valueAxisEdge,
                           java.awt.geom.Rectangle2D dataArea,
                           ChartOrientation orientation,
                           AnnotationShapeCollection annotationShapes)
Draws the annotation.

Specified by:
drawAnnotation in interface ICategoryAnnotation
Parameters:
categoryAxis - CategoryAxis The category axis (null not permitted).
valueAxis - AbstractValueAxis The value axis (null not permitted).
valueAxisEdge - RectangleEdge The value axis edge (null not permitted).
dataArea - Rectangle2D The chart data area (null not permitted).
orientation - ChartOrientation The chart orientation (null not permitted).
annotationShapes - AnnotationShapeCollection Collects information about the annotation (null not permitted).

equals

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

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

hashCode

public int hashCode()
Returns a hash code value for the object.

Overrides:
hashCode in class AbstractTextAnnotation
Returns:
int A hash code value for this object.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Creates and returns a copy of this object.

Overrides:
clone in class AbstractTextAnnotation
Returns:
object a clone of this instance.
Throws:
java.lang.CloneNotSupportedException - if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned.

toString

public java.lang.String toString()
Returns a string representation of the object.

Overrides:
toString in class AbstractTextAnnotation
Returns:
a string representation of the object.