Home » jcommon-1.0.13 » org.jfree » chart » annotations » [javadoc | source]

org.jfree.chart.annotations
public class: XYPointerAnnotation [javadoc | source]

java.lang.Object
   org.jfree.chart.annotations.AbstractXYAnnotation
      org.jfree.chart.annotations.XYTextAnnotation
         org.jfree.chart.annotations.XYPointerAnnotation

All Implemented Interfaces:
    PublicCloneable, Cloneable, Serializable, XYAnnotation

An arrow and label that can be placed on an org.jfree.chart.plot.XYPlot . The arrow is drawn at a user-definable angle so that it points towards the (x, y) location for the annotation.

The arrow length (and its offset from the (x, y) location) is controlled by the tip radius and the base radius attributes. Imagine two circles around the (x, y) coordinate: the inner circle defined by the tip radius, and the outer circle defined by the base radius. Now, draw the arrow starting at some point on the outer circle (the point is determined by the angle), with the arrow tip being drawn at a corresponding point on the inner circle.

Field Summary
public static final  double	DEFAULT_TIP_RADIUS	The default tip radius (in Java2D units).
public static final  double	DEFAULT_BASE_RADIUS	The default base radius (in Java2D units).
public static final  double	DEFAULT_LABEL_OFFSET	The default label offset (in Java2D units).
public static final  double	DEFAULT_ARROW_LENGTH	The default arrow length (in Java2D units).
public static final  double	DEFAULT_ARROW_WIDTH	The default arrow width (in Java2D units).

Fields inherited from org.jfree.chart.annotations.XYTextAnnotation:
DEFAULT_FONT,  DEFAULT_PAINT,  DEFAULT_TEXT_ANCHOR,  DEFAULT_ROTATION_ANCHOR,  DEFAULT_ROTATION_ANGLE

Constructor:

public XYPointerAnnotation(String label, double x, double y, double angle) { super(label, x, y); this.angle = angle; this.tipRadius = DEFAULT_TIP_RADIUS; this.baseRadius = DEFAULT_BASE_RADIUS; this.arrowLength = DEFAULT_ARROW_LENGTH; this.arrowWidth = DEFAULT_ARROW_WIDTH; this.labelOffset = DEFAULT_LABEL_OFFSET; this.arrowStroke = new BasicStroke(1.0f); this.arrowPaint = Color.black; } Creates a new label and arrow annotation. Parameters: label - the label (null permitted). x - the x-coordinate (measured against the chart's domain axis). y - the y-coordinate (measured against the chart's range axis). angle - the angle of the arrow's line (in radians).

Method from org.jfree.chart.annotations.XYPointerAnnotation Summary:
clone,   draw,   equals,   getAngle,   getArrowLength,   getArrowPaint,   getArrowStroke,   getArrowWidth,   getBaseRadius,   getLabelOffset,   getTipRadius,   hashCode,   setAngle,   setArrowLength,   setArrowPaint,   setArrowStroke,   setArrowWidth,   setBaseRadius,   setLabelOffset,   setTipRadius

Methods from org.jfree.chart.annotations.XYTextAnnotation:
clone,   draw,   equals,   getFont,   getPaint,   getRotationAnchor,   getRotationAngle,   getText,   getTextAnchor,   getX,   getY,   hashCode,   setFont,   setPaint,   setRotationAnchor,   setRotationAngle,   setText,   setTextAnchor,   setX,   setY

Methods from org.jfree.chart.annotations.AbstractXYAnnotation:
addEntity,   draw,   equals,   getToolTipText,   getURL,   hashCode,   setToolTipText,   setURL

Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait

Method from org.jfree.chart.annotations.XYPointerAnnotation Detail:
public Object clone() throws CloneNotSupportedException { return super.clone(); } Returns a clone of the annotation.
public void draw(Graphics2D g2, XYPlot plot, Rectangle2D dataArea, ValueAxis domainAxis, ValueAxis rangeAxis, int rendererIndex, PlotRenderingInfo info) { PlotOrientation orientation = plot.getOrientation(); RectangleEdge domainEdge = Plot.resolveDomainAxisLocation( plot.getDomainAxisLocation(), orientation); RectangleEdge rangeEdge = Plot.resolveRangeAxisLocation( plot.getRangeAxisLocation(), orientation); double j2DX = domainAxis.valueToJava2D(getX(), dataArea, domainEdge); double j2DY = rangeAxis.valueToJava2D(getY(), dataArea, rangeEdge); if (orientation == PlotOrientation.HORIZONTAL) { double temp = j2DX; j2DX = j2DY; j2DY = temp; } double startX = j2DX + Math.cos(this.angle) * this.baseRadius; double startY = j2DY + Math.sin(this.angle) * this.baseRadius; double endX = j2DX + Math.cos(this.angle) * this.tipRadius; double endY = j2DY + Math.sin(this.angle) * this.tipRadius; double arrowBaseX = endX + Math.cos(this.angle) * this.arrowLength; double arrowBaseY = endY + Math.sin(this.angle) * this.arrowLength; double arrowLeftX = arrowBaseX + Math.cos(this.angle + Math.PI / 2.0) * this.arrowWidth; double arrowLeftY = arrowBaseY + Math.sin(this.angle + Math.PI / 2.0) * this.arrowWidth; double arrowRightX = arrowBaseX - Math.cos(this.angle + Math.PI / 2.0) * this.arrowWidth; double arrowRightY = arrowBaseY - Math.sin(this.angle + Math.PI / 2.0) * this.arrowWidth; GeneralPath arrow = new GeneralPath(); arrow.moveTo((float) endX, (float) endY); arrow.lineTo((float) arrowLeftX, (float) arrowLeftY); arrow.lineTo((float) arrowRightX, (float) arrowRightY); arrow.closePath(); g2.setStroke(this.arrowStroke); g2.setPaint(this.arrowPaint); Line2D line = new Line2D.Double(startX, startY, endX, endY); g2.draw(line); g2.fill(arrow); // draw the label g2.setFont(getFont()); g2.setPaint(getPaint()); double labelX = j2DX + Math.cos(this.angle) * (this.baseRadius + this.labelOffset); double labelY = j2DY + Math.sin(this.angle) * (this.baseRadius + this.labelOffset); Rectangle2D hotspot = TextUtilities.drawAlignedString(getText(), g2, (float) labelX, (float) labelY, getTextAnchor()); String toolTip = getToolTipText(); String url = getURL(); if (toolTip != null || url != null) { addEntity(info, hotspot, rendererIndex, toolTip, url); } } Draws the annotation.
public boolean equals(Object obj) { if (obj == this) { return true; } if (!(obj instanceof XYPointerAnnotation)) { return false; } if (!super.equals(obj)) { return false; } XYPointerAnnotation that = (XYPointerAnnotation) obj; if (this.angle != that.angle) { return false; } if (this.tipRadius != that.tipRadius) { return false; } if (this.baseRadius != that.baseRadius) { return false; } if (this.arrowLength != that.arrowLength) { return false; } if (this.arrowWidth != that.arrowWidth) { return false; } if (!this.arrowPaint.equals(that.arrowPaint)) { return false; } if (!ObjectUtilities.equal(this.arrowStroke, that.arrowStroke)) { return false; } if (this.labelOffset != that.labelOffset) { return false; } return true; } Tests this annotation for equality with an arbitrary object.
public double getAngle() { return this.angle; } Returns the angle of the arrow.
public double getArrowLength() { return this.arrowLength; } Returns the arrow length.
public Paint getArrowPaint() { return this.arrowPaint; } Returns the paint used for the arrow.
public Stroke getArrowStroke() { return this.arrowStroke; } Returns the stroke used to draw the arrow line.
public double getArrowWidth() { return this.arrowWidth; } Returns the arrow width.
public double getBaseRadius() { return this.baseRadius; } Returns the base radius.
public double getLabelOffset() { return this.labelOffset; } Returns the label offset.
public double getTipRadius() { return this.tipRadius; } Returns the tip radius.
public int hashCode() { int result = super.hashCode(); long temp = Double.doubleToLongBits(this.angle); result = 37 * result + (int) (temp ^ (temp > > > 32)); temp = Double.doubleToLongBits(this.tipRadius); result = 37 * result + (int) (temp ^ (temp > > > 32)); temp = Double.doubleToLongBits(this.baseRadius); result = 37 * result + (int) (temp ^ (temp > > > 32)); temp = Double.doubleToLongBits(this.arrowLength); result = 37 * result + (int) (temp ^ (temp > > > 32)); temp = Double.doubleToLongBits(this.arrowWidth); result = 37 * result + (int) (temp ^ (temp > > > 32)); result = result * 37 + HashUtilities.hashCodeForPaint(this.arrowPaint); result = result * 37 + this.arrowStroke.hashCode(); temp = Double.doubleToLongBits(this.labelOffset); result = 37 * result + (int) (temp ^ (temp > > > 32)); return super.hashCode(); } Returns a hash code for this instance.
public void setAngle(double angle) { this.angle = angle; } Sets the angle of the arrow.
public void setArrowLength(double length) { this.arrowLength = length; } Sets the arrow length.
public void setArrowPaint(Paint paint) { if (paint == null) { throw new IllegalArgumentException("Null 'paint' argument."); } this.arrowPaint = paint; } Sets the paint used for the arrow.
public void setArrowStroke(Stroke stroke) { if (stroke == null) { throw new IllegalArgumentException("Null 'stroke' not permitted."); } this.arrowStroke = stroke; } Sets the stroke used to draw the arrow line.
public void setArrowWidth(double width) { this.arrowWidth = width; } Sets the arrow width.
public void setBaseRadius(double radius) { this.baseRadius = radius; } Sets the base radius.
public void setLabelOffset(double offset) { this.labelOffset = offset; } Sets the label offset (from the arrow base, continuing in a straight line, in Java2D units).
public void setTipRadius(double radius) { this.tipRadius = radius; } Sets the tip radius.