com.ijchart.xychart.annotation
Class XYImageAnnotation

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

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

Title: IJChart

A image 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

Constructor Summary
XYImageAnnotation(double x, double y, java.awt.Image image)
           Create a new annotation to be displayed at the given location.
XYImageAnnotation(double x, double y, java.awt.Image image, int imageWidth, int imageHeight)
           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.Image getImage()
           Returns the shape.
 int getImageHeight()
           Returns the image height.
 int getImageWidth()
           Returns the image width.
 double getX()
           Returns the x coordinate for image.
 double getY()
           Returns the y coordinate for image.
 int hashCode()
           Returns a hash code value for the object.
 void setImage(java.awt.Image image)
           Sets the shape and sends a AnnotationChangeEvent to all registered listeners.
 void setImageHeight(int height)
           Sets the image height and sends a AnnotationChangeEvent to all registered listeners.
 void setImageWidth(int width)
           Sets the image width and sends a AnnotationChangeEvent to all registered listeners.
 void setX(double x)
           Sets the x coordinate for image and sends a AnnotationChangeEvent to all registered listeners.
 void setY(double y)
           Sets the y coordinate for image 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
 

Constructor Detail

XYImageAnnotation

public XYImageAnnotation(double x,
                         double y,
                         java.awt.Image image)
Create a new annotation to be displayed at the given location.

Parameters:
x - double The x coordinate.
y - double The y coordinate.
image - Image The image.

XYImageAnnotation

public XYImageAnnotation(double x,
                         double y,
                         java.awt.Image image,
                         int imageWidth,
                         int imageHeight)
Create a new annotation to be displayed at the given location.

Parameters:
x - double The x coordinate.
y - double The y coordinate.
image - Image The image.
imageWidth - int The image width.
imageHeight - int The image height.
Method Detail

getX

public double getX()
Returns the x coordinate for image.

Returns:
double The x coordinate.

setX

public void setX(double x)
Sets the x coordinate for image and sends a AnnotationChangeEvent to all registered listeners.

Parameters:
x - double The x coordinate.

getY

public double getY()
Returns the y coordinate for image.

Returns:
double The y coordinate.

setY

public void setY(double y)
Sets the y coordinate for image and sends a AnnotationChangeEvent to all registered listeners.

Parameters:
y - double The y coordinate.

getImage

public java.awt.Image getImage()
Returns the shape.

Returns:
Shape The shape (never null).

setImage

public void setImage(java.awt.Image image)
Sets the shape and sends a AnnotationChangeEvent to all registered listeners.

Parameters:
image - Image The image (null not permitted).

getImageWidth

public int getImageWidth()
Returns the image width.

Returns:
int The width.

setImageWidth

public void setImageWidth(int width)
Sets the image width and sends a AnnotationChangeEvent to all registered listeners.

Parameters:
width - int The width.

getImageHeight

public int getImageHeight()
Returns the image height.

Returns:
int The height.

setImageHeight

public void setImageHeight(int height)
Sets the image height and sends a AnnotationChangeEvent to all registered listeners.

Parameters:
height - int The height.

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.