kcl.waterloo.annotation

Class GJAnnotation

java.lang.Object

kcl.waterloo.annotation.GJAnnotation

All Implemented Interfaces:

GJAnnotationInterface<java.awt.geom.Path2D,GJGraphInterface,java.awt.Stroke,java.awt.Paint,java.awt.Font>

Direct Known Subclasses:

GJAnnotation.ArrowAnnotation, GJAnnotation.LineAnnotation, GJAnnotation.ShapeAnnotation, GJAnnotation.TextAnnotation

public abstract class GJAnnotation
extends java.lang.Object
implements GJAnnotationInterface<java.awt.geom.Path2D,GJGraphInterface,java.awt.Stroke,java.awt.Paint,java.awt.Font>

GJAnnotation is an abstract class that provides concrete internal classes to annotate parentGraph containers and static factory methods to construct them. Annotations can be added to parentGraph containers by calling the container's add method (in which case the position of the annotation will be set in the coordinate space of that container's View) or by calling the add method of a parentGraph layer in the View of a container (in which case the position of the annotation will be set in that layer's coordinate space).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GJAnnotation.ArrowAnnotation Internal class for arrow annotations
static class	GJAnnotation.LineAnnotation Internal class for line annotations
static class	GJAnnotation.ShapeAnnotation Internal class for shape annotations
static class	GJAnnotation.TextAnnotation Internal class for text annotations

Constructor Summary

Constructors

Constructor and Description
GJAnnotation() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static GJAnnotation.ArrowAnnotation	createArrow(double x1, double y1, double x2, double y2, double szx, double szy) Static method to create a line between {x1,y1} and {x2,y2}.
static GJAnnotation.ArrowAnnotation	createArrow(double x1, double y1, double x2, double y2, double x3, double y3, double szx, double szy)
static GJAnnotation.ShapeAnnotation	createBox(double x, double y, double w, double h) Static method to create a rectangle where {X,Y} is the top left corner and w and h are the width and height.
static GJAnnotation.ShapeAnnotation	createEllipse(double x, double y, double w, double h) Static method to create an ellipse where {X,Y} is the top left corner and w and h are the width and height of the bounding rectangle.
static GJAnnotation.LineAnnotation	createLine(double x1, double y1, double x2, double y2) Static method to create a line between {x1,y1} and {x2,y2}.
static GJAnnotation.LineAnnotation	createLine(double x1, double y1, double x2, double y2, double x3, double y3) Static method to create a line between {x1,y1} and {x2,y2}.
static GJAnnotation.ShapeAnnotation	createShape(java.awt.Shape s) Creates an annotation using the specified object which should implement the {code Shape} interface.
static GJAnnotation.TextAnnotation	createText(double x, double y, java.lang.String s)
GJMarker	getExtra() Returns the parentGraph reference for setting the coordinate system for this annotation.
java.awt.Paint	getFill()
java.awt.Font	getFont()
java.awt.Paint	getLineColor()
java.awt.Stroke	getLineStroke()
int	getLineTextPosition()
GJMarker	getMarker()
java.lang.String	getName()
GJGraphInterface	getParentGraph() Returns the parentGraph reference for setting the coordinate system for this annotation.
java.awt.geom.Path2D	getPath() Returns a clone of the Path2D object.
java.lang.String	getText()
java.awt.Paint	getTextBackground()
java.awt.Paint	getTextColor()
double	getXData()
double	getYData()
void	paintAnnotation(java.awt.Graphics2D g2, java.awt.geom.AffineTransform af) paintAnnotation method.
void	remove() Removes the annotation
void	remove(java.lang.String name) Removes annotation(s) named by the string
void	setExtra(GJMarker p) Sets the Path2D object.
void	setFill(java.awt.Paint Fill)
void	setFont(java.awt.Font Font)
void	setLineColor(java.awt.Paint LineColor)
void	setLineStroke(java.awt.Stroke LineStroke)
void	setLineTextPosition(int pos)
void	setMarker(GJMarker Marker)
void	setName(java.lang.String Name)
void	setParentGraph(GJGraphInterface gr) setParentGraph method.
void	setPath(java.awt.geom.Path2D p) Sets the Path2D object.
void	setText(java.lang.String Text)
void	setTextBackground(java.awt.Paint textBackground)
void	setTextColor(java.awt.Paint TextColor) Sets the textColor
void	setXData(double X)
void	setYData(double Y)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GJAnnotation

public GJAnnotation()

Constructor.

Method Detail

getPath

public java.awt.geom.Path2D getPath()

Returns a clone of the Path2D object.

Specified by:

getPath in interface GJAnnotationInterface<java.awt.geom.Path2D,GJGraphInterface,java.awt.Stroke,java.awt.Paint,java.awt.Font>

Returns:

the marker

setPath

public void setPath(java.awt.geom.Path2D p)

Sets the Path2D object.

Specified by:

setPath in interface GJAnnotationInterface<java.awt.geom.Path2D,GJGraphInterface,java.awt.Stroke,java.awt.Paint,java.awt.Font>

Parameters:

p -

getParentGraph

public GJGraphInterface getParentGraph()

Returns the parentGraph reference for setting the coordinate system for this annotation.

Specified by:

getParentGraph in interface GJAnnotationInterface<java.awt.geom.Path2D,GJGraphInterface,java.awt.Stroke,java.awt.Paint,java.awt.Font>

Returns:

the plot

setExtra

public void setExtra(GJMarker p)

Sets the Path2D object.

Specified by:

setExtra in interface GJAnnotationInterface<java.awt.geom.Path2D,GJGraphInterface,java.awt.Stroke,java.awt.Paint,java.awt.Font>

Parameters:

p -

getExtra

public GJMarker getExtra()

Returns the parentGraph reference for setting the coordinate system for this annotation.

Specified by:

getExtra in interface GJAnnotationInterface<java.awt.geom.Path2D,GJGraphInterface,java.awt.Stroke,java.awt.Paint,java.awt.Font>

Returns:

the plot

setParentGraph

public void setParentGraph(GJGraphInterface gr)

setParentGraph method. This is called when an annotation is added using the add method of a parentGraph - which is recommended - so need not be called directly by the user.

Specified by:

setParentGraph in interface GJAnnotationInterface<java.awt.geom.Path2D,GJGraphInterface,java.awt.Stroke,java.awt.Paint,java.awt.Font>

Parameters:

gr -

getLineStroke

public java.awt.Stroke getLineStroke()

Specified by:

getLineStroke in interface GJAnnotationInterface<java.awt.geom.Path2D,GJGraphInterface,java.awt.Stroke,java.awt.Paint,java.awt.Font>

Returns:

the lineStroke

setLineStroke

public void setLineStroke(java.awt.Stroke LineStroke)

Specified by:

setLineStroke in interface GJAnnotationInterface<java.awt.geom.Path2D,GJGraphInterface,java.awt.Stroke,java.awt.Paint,java.awt.Font>

Parameters:

LineStroke - the LineStroke to set

getLineColor

public java.awt.Paint getLineColor()

Specified by:

getLineColor in interface GJAnnotationInterface<java.awt.geom.Path2D,GJGraphInterface,java.awt.Stroke,java.awt.Paint,java.awt.Font>

Returns:

the lineColor

setLineColor

public void setLineColor(java.awt.Paint LineColor)

Specified by:

setLineColor in interface GJAnnotationInterface<java.awt.geom.Path2D,GJGraphInterface,java.awt.Stroke,java.awt.Paint,java.awt.Font>

Parameters:

LineColor - the LineColor to set

getFont

public java.awt.Font getFont()

Specified by:

getFont in interface GJAnnotationInterface<java.awt.geom.Path2D,GJGraphInterface,java.awt.Stroke,java.awt.Paint,java.awt.Font>

Returns:

the Font

setFont

public void setFont(java.awt.Font Font)

Specified by:

setFont in interface GJAnnotationInterface<java.awt.geom.Path2D,GJGraphInterface,java.awt.Stroke,java.awt.Paint,java.awt.Font>

Parameters:

Font - the Font to set

getFill

public java.awt.Paint getFill()

Specified by:

getFill in interface GJAnnotationInterface<java.awt.geom.Path2D,GJGraphInterface,java.awt.Stroke,java.awt.Paint,java.awt.Font>

Returns:

the fill

setFill

public void setFill(java.awt.Paint Fill)

Specified by:

setFill in interface GJAnnotationInterface<java.awt.geom.Path2D,GJGraphInterface,java.awt.Stroke,java.awt.Paint,java.awt.Font>

Parameters:

Fill - the Fill to set

getMarker

public GJMarker getMarker()

Specified by:

getMarker in interface GJAnnotationInterface<java.awt.geom.Path2D,GJGraphInterface,java.awt.Stroke,java.awt.Paint,java.awt.Font>

Returns:

the marker

setMarker

public void setMarker(GJMarker Marker)

Specified by:

setMarker in interface GJAnnotationInterface<java.awt.geom.Path2D,GJGraphInterface,java.awt.Stroke,java.awt.Paint,java.awt.Font>

Parameters:

Marker - the Marker to set

getName

public java.lang.String getName()

Specified by:

getName in interface GJAnnotationInterface<java.awt.geom.Path2D,GJGraphInterface,java.awt.Stroke,java.awt.Paint,java.awt.Font>

Returns:

the name

setName

public void setName(java.lang.String Name)

Specified by:

setName in interface GJAnnotationInterface<java.awt.geom.Path2D,GJGraphInterface,java.awt.Stroke,java.awt.Paint,java.awt.Font>

Parameters:

Name - the Name to set

getText

public java.lang.String getText()

Specified by:

getText in interface GJAnnotationInterface<java.awt.geom.Path2D,GJGraphInterface,java.awt.Stroke,java.awt.Paint,java.awt.Font>

Returns:

the text

setText

public void setText(java.lang.String Text)

Specified by:

setText in interface GJAnnotationInterface<java.awt.geom.Path2D,GJGraphInterface,java.awt.Stroke,java.awt.Paint,java.awt.Font>

Parameters:

Text - the Text to set

getXData

public double getXData()

Specified by:

getXData in interface GJAnnotationInterface<java.awt.geom.Path2D,GJGraphInterface,java.awt.Stroke,java.awt.Paint,java.awt.Font>

Returns:

the X

setXData

public void setXData(double X)

Specified by:

setXData in interface GJAnnotationInterface<java.awt.geom.Path2D,GJGraphInterface,java.awt.Stroke,java.awt.Paint,java.awt.Font>

Parameters:

X - the X to set

getYData

public double getYData()

Specified by:

getYData in interface GJAnnotationInterface<java.awt.geom.Path2D,GJGraphInterface,java.awt.Stroke,java.awt.Paint,java.awt.Font>

Returns:

the Y

setYData

public void setYData(double Y)

Specified by:

setYData in interface GJAnnotationInterface<java.awt.geom.Path2D,GJGraphInterface,java.awt.Stroke,java.awt.Paint,java.awt.Font>

Parameters:

Y - the Y to set

getTextColor

public java.awt.Paint getTextColor()

Specified by:

getTextColor in interface GJAnnotationInterface<java.awt.geom.Path2D,GJGraphInterface,java.awt.Stroke,java.awt.Paint,java.awt.Font>

Returns:

the textColor

setTextColor

public void setTextColor(java.awt.Paint TextColor)

Sets the textColor

Specified by:

setTextColor in interface GJAnnotationInterface<java.awt.geom.Path2D,GJGraphInterface,java.awt.Stroke,java.awt.Paint,java.awt.Font>

Parameters:

TextColor - the TextColor to set

getLineTextPosition

public int getLineTextPosition()

Returns:

the lineTextPosition

setLineTextPosition

public void setLineTextPosition(int pos)

Parameters:

pos - the lineTextPosition to set

remove

public void remove()

Description copied from interface: GJAnnotationInterface

Removes the annotation

Specified by:

remove in interface GJAnnotationInterface<java.awt.geom.Path2D,GJGraphInterface,java.awt.Stroke,java.awt.Paint,java.awt.Font>

remove

public void remove(java.lang.String name)

Description copied from interface: GJAnnotationInterface

Removes annotation(s) named by the string

Specified by:

remove in interface GJAnnotationInterface<java.awt.geom.Path2D,GJGraphInterface,java.awt.Stroke,java.awt.Paint,java.awt.Font>

Parameters:

name - the name of the annotation(s) to remove

paintAnnotation

public void paintAnnotation(java.awt.Graphics2D g2,
                   java.awt.geom.AffineTransform af)

paintAnnotation method. This has public scope to allow it to be called from the parentGraph container's paint methods. When using a standard Project Waterloo parentGraph container where annotations have been added using the add method, this is done automatically.

Specified by:

paintAnnotation in interface GJAnnotationInterface<java.awt.geom.Path2D,GJGraphInterface,java.awt.Stroke,java.awt.Paint,java.awt.Font>

Parameters:

g2 - the graphics object to render to

af - an AffineTransform instance with scale and translate set to position this annotation correctly in the container using the parentGraph's coordinate system.

createLine

public static GJAnnotation.LineAnnotation createLine(double x1,
                                     double y1,
                                     double x2,
                                     double y2)

Static method to create a line between {x1,y1} and {x2,y2}.

Parameters:

x1 -

y1 -

x2 -

y2 -

Returns:

the the annotation

createArrow

public static GJAnnotation.ArrowAnnotation createArrow(double x1,
                                       double y1,
                                       double x2,
                                       double y2,
                                       double szx,
                                       double szy)

Static method to create a line between {x1,y1} and {x2,y2}.

Parameters:

x1 -

y1 -

x2 -

y2 -

szx -

szy -

Returns:

the annotation

createArrow

public static GJAnnotation.ArrowAnnotation createArrow(double x1,
                                       double y1,
                                       double x2,
                                       double y2,
                                       double x3,
                                       double y3,
                                       double szx,
                                       double szy)

Parameters:

x1 -

y1 -

x2 -

y2 -

x3 -

y3 -

szx -

szy -

Returns:

the annotation

createLine

public static GJAnnotation.LineAnnotation createLine(double x1,
                                     double y1,
                                     double x2,
                                     double y2,
                                     double x3,
                                     double y3)

Static method to create a line between {x1,y1} and {x2,y2}.

Parameters:

x1 -

y1 -

x2 -

y2 -

x3 -

y3 -

Returns:

the LineAnnotation

createBox

public static GJAnnotation.ShapeAnnotation createBox(double x,
                                     double y,
                                     double w,
                                     double h)

Static method to create a rectangle where {X,Y} is the top left corner and w and h are the width and height.

Parameters:

x -

y -

w -

h -

Returns:

a GJAnnotation$ShapeAnnotation

createEllipse

public static GJAnnotation.ShapeAnnotation createEllipse(double x,
                                         double y,
                                         double w,
                                         double h)

Static method to create an ellipse where {X,Y} is the top left corner and w and h are the width and height of the bounding rectangle.

Parameters:

x -

y -

w -

h -

Returns:

a GJAnnotation$ShapeAnnotation

createShape

public static GJAnnotation.ShapeAnnotation createShape(java.awt.Shape s)

Creates an annotation using the specified object which should implement the {code Shape} interface.

Parameters:

s - a Shape.

Returns:

a GJAnnotation$ShapeAnnotation

createText

public static GJAnnotation.TextAnnotation createText(double x,
                                     double y,
                                     java.lang.String s)

getTextBackground

public java.awt.Paint getTextBackground()

Returns:

the textBackground

setTextBackground

public void setTextBackground(java.awt.Paint textBackground)

Parameters:

textBackground - the textBackground to set