com.ijchart.xychart.annotation
Class XYShapeAnnotation

java.lang.Object
  extended by com.ijchart.xychart.annotation.AbstractAnnotation
      extended by com.ijchart.xychart.annotation.XYShapeAnnotation
All Implemented Interfaces:
IAnnotation, IXYAnnotation, IAnnotationChangeListener, java.io.Serializable, java.lang.Cloneable, java.util.EventListener

public class XYShapeAnnotation
extends AbstractAnnotation
implements IXYAnnotation, java.lang.Cloneable, java.io.Serializable

Title: IJChart

A shape annotation that can be placed on a XYPlot.

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
static java.awt.Paint DEFAULT_BORDER_PAINT
           The default paint used to draw the shape's border.
static java.awt.Stroke DEFAULT_BORDER_STROKE
           The default stroke used to draw the shape's border.
 
Constructor Summary
XYShapeAnnotation(java.awt.Shape shape)
           Create a new annotation to be displayed at the given location.
XYShapeAnnotation(java.awt.Shape shape, java.awt.Paint borderPaint, java.awt.Stroke borderStroke)
           Create a new annotation to be displayed at the given location.
XYShapeAnnotation(java.awt.Shape shape, java.awt.Paint borderPaint, java.awt.Stroke borderStroke, java.awt.Paint fillPaint)
           Create 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(AbstractValueAxis xAxis, RectangleEdge xAxisEdge, AbstractValueAxis yAxis, RectangleEdge yAxisEdge, 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.awt.Paint getBorderPaint()
           Returns the paint used to draw the shape's border.
 java.awt.Stroke getBorderStroke()
           Returns the stroke used to draw the shape's border.
 java.awt.Paint getFillPaint()
           Returns the paint used to fill the shape.
 java.awt.Shape getShape()
           Returns the shape.
 int hashCode()
           Returns a hash code value for the object.
 void setBorderPaint(java.awt.Paint paint)
           Sets the paint used to draw the shape's border and sends a AnnotationChangeEvent to all registered listeners.
 void setBorderStroke(java.awt.Stroke stroke)
           Sets the stroke used to draw the shape's border and sends a AnnotationChangeEvent to all registered listeners.
 void setFillPaint(java.awt.Paint paint)
           The paint used to fill the shape and sends a AnnotationChangeEvent to all registered listeners.
 void setShape(java.awt.Shape shape)
           Sets the shape and sends a AnnotationChangeEvent to all registered listeners.
 java.lang.String toString()
           Returns a string representation of the object.
 
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
 

Field Detail

DEFAULT_BORDER_PAINT

public static final java.awt.Paint DEFAULT_BORDER_PAINT
The default paint used to draw the shape's border.


DEFAULT_BORDER_STROKE

public static final java.awt.Stroke DEFAULT_BORDER_STROKE
The default stroke used to draw the shape's border.

Constructor Detail

XYShapeAnnotation

public XYShapeAnnotation(java.awt.Shape shape)
Create a new annotation to be displayed at the given location.

Parameters:
shape - Shape The shape (null not permitted).

XYShapeAnnotation

public XYShapeAnnotation(java.awt.Shape shape,
                         java.awt.Paint borderPaint,
                         java.awt.Stroke borderStroke)
Create a new annotation to be displayed at the given location.

Parameters:
shape - Shape The shape (null not permitted).
borderPaint - Paint The paint used to draw the shape's border (null permitted).
borderStroke - Stroke The stroke used to draw the shape's border (null permitted).

XYShapeAnnotation

public XYShapeAnnotation(java.awt.Shape shape,
                         java.awt.Paint borderPaint,
                         java.awt.Stroke borderStroke,
                         java.awt.Paint fillPaint)
Create a new annotation to be displayed at the given location.

Parameters:
shape - Shape The shape (null not permitted).
borderPaint - Paint The paint used to draw the shape's border (null permitted).
borderStroke - Stroke The stroke used to draw the shape's border (null permitted).
fillPaint - Paint The paint used to fill the shape (null permitted).
Method Detail

getShape

public java.awt.Shape getShape()
Returns the shape.

Returns:
Shape The shape (never null).

setShape

public void setShape(java.awt.Shape shape)
Sets the shape and sends a AnnotationChangeEvent to all registered listeners.

Parameters:
shape - Shape The shape (null not permitted).

getBorderPaint

public java.awt.Paint getBorderPaint()
Returns the paint used to draw the shape's border.

Returns:
Paint The border paint (maybe null).

setBorderPaint

public void setBorderPaint(java.awt.Paint paint)
Sets the paint used to draw the shape's border and sends a AnnotationChangeEvent to all registered listeners.

Parameters:
paint - Paint The border paint (null permitted).

getBorderStroke

public java.awt.Stroke getBorderStroke()
Returns the stroke used to draw the shape's border.

Returns:
Stroke The border stroke (maybe null).

setBorderStroke

public void setBorderStroke(java.awt.Stroke stroke)
Sets the stroke used to draw the shape's border and sends a AnnotationChangeEvent to all registered listeners.

Parameters:
stroke - Stroke The border stroke (null permitted).

getFillPaint

public java.awt.Paint getFillPaint()
Returns the paint used to fill the shape.

Returns:
Paint The fill paint (maybe null).

setFillPaint

public void setFillPaint(java.awt.Paint paint)
The paint used to fill the shape and sends a AnnotationChangeEvent to all registered listeners.

Parameters:
paint - Paint The fill paint (null permitted).

drawAnnotation

public void drawAnnotation(AbstractValueAxis xAxis,
                           RectangleEdge xAxisEdge,
                           AbstractValueAxis yAxis,
                           RectangleEdge yAxisEdge,
                           java.awt.geom.Rectangle2D dataArea,
                           ChartOrientation orientation,
                           AnnotationShapeCollection annotationShapes)
Draws the annotation.

Specified by:
drawAnnotation in interface IXYAnnotation
Parameters:
xAxis - AbstractValueAxis The x-axis (null not permitted).
xAxisEdge - RectangleEdge The x-axis edge (null not permitted).
yAxis - AbstractValueAxis The y-axis (null not permitted).
yAxisEdge - RectangleEdge The y-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 AbstractAnnotation
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 AbstractAnnotation
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 AbstractAnnotation
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 java.lang.Object
Returns:
a string representation of the object.