org.metacsp.utility.UI

Class CurvedArrow

java.lang.Object

org.metacsp.utility.UI.CurvedArrow

public class CurvedArrow
extends java.lang.Object

This is a simple class for storing and drawing a curved line with possible arrow heads on it.

Author:

Thomas Finley

Field Summary

Fields

Modifier and Type	Field and Description
protected java.awt.geom.AffineTransform	affineToText The affine transform for getting us to the text space.
protected java.awt.geom.Rectangle2D	bounds The stored bounds.
protected java.awt.Point	control The start, end, and single control points.
protected java.awt.geom.QuadCurve2D.Float	curve The quad-curve that controls the shape of the long part of the arrow.
protected float	curvy The "curvy-ness" factor.
protected java.awt.Point	end The start, end, and single control points.
protected boolean	endArrow Arrow flags.
protected static java.awt.Graphics	GRAPHICS A graphics object.
static java.awt.Color	HIGHLIGHT_COLOR
protected java.lang.String	label The label for this arrow.
protected static java.awt.FontMetrics	METRICS A font metrics object.
protected boolean	needsRefresh true if the curve needs to be refreshed, false otherwise.
protected java.awt.Point	start The start, end, and single control points.
protected boolean	startArrow Arrow flags.

Constructor Summary

Constructors

Constructor and Description
CurvedArrow(int x1, int y1, int x2, int y2, float curvy) Instantiates a CurvedArrow object.
CurvedArrow(java.awt.Point start, java.awt.Point end, float curvy) Instantiates a CurvedArrow object.

Method Summary

Modifier and Type	Method and Description
void	draw(java.awt.Graphics2D g) Draws the arrow on the indicated graphics environment.
void	drawControlPoint(java.awt.Graphics2D g)
void	drawHighlight(java.awt.Graphics2D g) Draws a highlight of the curve.
void	drawText(java.awt.Graphics2D g) Draws the text on the high point of the arc.
java.awt.geom.Rectangle2D	getBounds() Returns the bounds.
java.awt.geom.QuadCurve2D	getCurve()
java.lang.String	getLabel() Returns the label for this arrow.
boolean	isNear(java.awt.Point point, int fudge) Determines if a point is on/near the curved arrow.
void	refreshCurve() Refreshes the curve object.
void	setCurvy(float curvy) Sets the "curvy-ness" factor.
void	setEnd(int x2, int y2) Sets the end point.
void	setEnd(java.awt.Point end) Sets the end point.
void	setLabel(java.lang.String label) Sets the label that will be drawn on the high arc point.
void	setStart(int x1, int y1) Sets the start point.
void	setStart(java.awt.Point start) Sets the start point.

Methods inherited from class java.lang.Object

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

Field Detail

start

protected java.awt.Point start

The start, end, and single control points.

end

protected java.awt.Point end

The start, end, and single control points.

control

protected java.awt.Point control

The start, end, and single control points.

curvy

protected float curvy

The "curvy-ness" factor.

curve

protected java.awt.geom.QuadCurve2D.Float curve

The quad-curve that controls the shape of the long part of the arrow.

needsRefresh

protected boolean needsRefresh

true if the curve needs to be refreshed, false otherwise.

startArrow

protected boolean startArrow

Arrow flags.

endArrow

protected boolean endArrow

Arrow flags.

label

protected java.lang.String label

The label for this arrow.

bounds

protected java.awt.geom.Rectangle2D bounds

The stored bounds.

affineToText

protected java.awt.geom.AffineTransform affineToText

The affine transform for getting us to the text space.

GRAPHICS

protected static java.awt.Graphics GRAPHICS

A graphics object.

METRICS

protected static java.awt.FontMetrics METRICS

A font metrics object.

HIGHLIGHT_COLOR

public static java.awt.Color HIGHLIGHT_COLOR

Constructor Detail

CurvedArrow

public CurvedArrow(int x1,
                   int y1,
                   int x2,
                   int y2,
                   float curvy)

Instantiates a CurvedArrow object.

Parameters:

x1 - the x coordinate of the start point

y1 - the y coordinate of the start point

x2 - the x coordinate of the end point

y2 - the y coordinate of the end point

curvy - the curvi-ness factor; 0 will create a straight line; 1 and -1 are rather curvy

CurvedArrow

public CurvedArrow(java.awt.Point start,
                   java.awt.Point end,
                   float curvy)

Instantiates a CurvedArrow object.

Parameters:

start - the start point

end - the end point

curvy - the curvi-ness factor; 0 will create a straight line; 1 and -1 are rather curvy

Method Detail

setStart

public void setStart(int x1,
                     int y1)

Sets the start point.

Parameters:

x1 - the x coordinate of the start point

y1 - the y coordinate of the start point

setStart

public void setStart(java.awt.Point start)

Sets the start point.

Parameters:

start - the new start point

setEnd

public void setEnd(int x2,
                   int y2)

Sets the end point.

Parameters:

x2 - the x coordinate of the end point

y2 - the y coordinate of the end point

setEnd

public void setEnd(java.awt.Point end)

Sets the end point.

Parameters:

end - the new end point

setCurvy

public void setCurvy(float curvy)

Sets the "curvy-ness" factor.

Parameters:

curvy - the new curvy factor

draw

public void draw(java.awt.Graphics2D g)

Draws the arrow on the indicated graphics environment.

Parameters:

g - the graphics to draw this arrow upon

drawControlPoint

public void drawControlPoint(java.awt.Graphics2D g)

drawHighlight

public void drawHighlight(java.awt.Graphics2D g)

Draws a highlight of the curve.

Parameters:

g - the graphics to draw the highlight of the curve upon

drawText

public void drawText(java.awt.Graphics2D g)

Draws the text on the high point of the arc. The text drawn is none other than the label for this object, as retrieved from getLabel.

Parameters:

g - the graphics object to draw the text upon

setLabel

public void setLabel(java.lang.String label)

Sets the label that will be drawn on the high arc point.

Parameters:

label - the new label for the arrow

getLabel

public java.lang.String getLabel()

Returns the label for this arrow.

Returns:

the label for this arrow

refreshCurve

public void refreshCurve()

Refreshes the curve object.

getBounds

public java.awt.geom.Rectangle2D getBounds()

Returns the bounds.

Returns:

the rectangular bounds for this curved arrow

isNear

public boolean isNear(java.awt.Point point,
                      int fudge)

Determines if a point is on/near the curved arrow.

Parameters:

point - the point to check

fudge - the radius around the point that should be checked for the presence of the curve

Returns:

true if the point is on the curve within a certain fudge factor, false otherwise

getCurve

public java.awt.geom.QuadCurve2D getCurve()