com.imsl.chart
Class Annotation

java.lang.Object
  com.imsl.chart.AbstractChartNode
      com.imsl.chart.ChartNode
          com.imsl.chart.Data
              com.imsl.chart.Annotation

All Implemented Interfaces:

Serializable, Cloneable

public class Annotation
extends Data

Draws an annotation. Locations are defined in chart (user) coordinates. To convert between device and user coordinates see Axis.mapDeviceToUser(int, int, double[]) and Axis.mapUserToDevice(double, double, int[]).

See Also:

Example, Serialized Form

Field Summary

Fields inherited from class com.imsl.chart.ChartNode

AXIS_X_TOP, AXIS_Y_RIGHT, BAR_TYPE_HORIZONTAL, BAR_TYPE_VERTICAL, DASH_PATTERN_DASH, DASH_PATTERN_DASH_DOT, DASH_PATTERN_DOT, DASH_PATTERN_SOLID, DATA_TYPE_FILL, DATA_TYPE_LINE, DATA_TYPE_MARKER, DATA_TYPE_PICTURE, DATA_TYPE_TUBE, DENDROGRAM_TYPE_HORIZONTAL, DENDROGRAM_TYPE_VERTICAL, FILL_TYPE_GRADIENT, FILL_TYPE_NONE, FILL_TYPE_PAINT, FILL_TYPE_SOLID, LABEL_TYPE_PERCENT, MARKER_TYPE_ASTERISK, MARKER_TYPE_CIRCLE_CIRCLE, MARKER_TYPE_CIRCLE_PLUS, MARKER_TYPE_CIRCLE_X, MARKER_TYPE_DIAMOND_PLUS, MARKER_TYPE_FILLED_CIRCLE, MARKER_TYPE_FILLED_DIAMOND, MARKER_TYPE_FILLED_SQUARE, MARKER_TYPE_FILLED_TRIANGLE, MARKER_TYPE_HOLLOW_CIRCLE, MARKER_TYPE_HOLLOW_DIAMOND, MARKER_TYPE_HOLLOW_SQUARE, MARKER_TYPE_HOLLOW_TRIANGLE, MARKER_TYPE_OCTAGON_PLUS, MARKER_TYPE_OCTAGON_X, MARKER_TYPE_PLUS, MARKER_TYPE_SQUARE_PLUS, MARKER_TYPE_SQUARE_X, MARKER_TYPE_X, TEXT_X_CENTER, TEXT_X_LEFT, TEXT_X_RIGHT, TEXT_Y_BOTTOM, TEXT_Y_CENTER, TEXT_Y_TOP

Fields inherited from class com.imsl.chart.AbstractChartNode

AUTOSCALE_DATA, AUTOSCALE_DENSITY, AUTOSCALE_NUMBER, AUTOSCALE_OFF, AUTOSCALE_WINDOW, AXIS_X, AXIS_Y, AXIS_Z, LABEL_TYPE_NONE, LABEL_TYPE_TITLE, LABEL_TYPE_X, LABEL_TYPE_Y, LABEL_TYPE_Z, TRANSFORM_CUSTOM, TRANSFORM_LINEAR, TRANSFORM_LOG

Constructor Summary

Annotation(ChartNode parent, Image img, double x, double y)
Renders an Image object centered at an x,y location in chart coordinates.

Annotation(ChartNode parent, String string, double x, double y)
Draws a String at the specific x,y location in chart coordinates.

Annotation(ChartNode parent, Text text, double x, double y)
Creates a Text object at the specific x,y location in chart coordinates.

Method Summary

Text	getText() Gets the Text for this Annotation object.
void	paint(Draw draw) Paints this node and all of its children.
void	setLocation(double x, double y) Update the location of this Annotation instance.
void	setString(String string) Sets the String for the Text object to render.
void	setText(Text text) Sets the Text object to render.

Methods inherited from class com.imsl.chart.Data

dataRange, formatLabel

Methods inherited from class com.imsl.chart.ChartNode

addPickListener, firePickListeners, getALT, getAxis, getBackground, getBarGap, getBarType, getBarWidth, getChart, getChartTitle, getChildren, getClipData, getComponent, getConcatenatedViewport, getDataType, getDoubleBuffering, getExplode, getFillOutlineColor, getFillOutlineType, getFillPaint, getFillType, getGradient, getHREF, getLegend, getLineDashPattern, getMarkerDashPattern, getMarkerThickness, getMarkerType, getParent, getReference, getScreenAxis, getScreenSize, getScreenViewport, getSize, getSkipWeekends, getTextAngle, getTextColor, getTitle, getToolTip, getViewport, isBitSet, prePaint, removePickListener, setALT, setBarGap, setBarType, setBarWidth, setChartTitle, setClipData, setCustomTransform, setDataType, setDoubleBuffering, setExplode, setFillOutlineColor, setFillOutlineColor, setFillOutlineType, setFillPaint, setFillPaint, setFillPaint, setFillType, setGradient, setGradient, setGradient, setHREF, setImage, setLineDashPattern, setMarkerDashPattern, setMarkerThickness, setMarkerType, setReference, setScreenSize, setSize, setSkipWeekends, setTextAngle, setTextColor, setTextColor, setTitle, setTitle, setToolTip, setViewport, setViewport

Methods inherited from class com.imsl.chart.AbstractChartNode

clone, clone, clone, clone, getAbstractParent, getAttribute, getAutoscaleInput, getAutoscaleMinimumTimeInterval, getAutoscaleOutput, getBooleanAttribute, getChildList, getColorAttribute, getCustomTransform, getDensity, getDoubleAttribute, getFillColor, getFont, getFontName, getFontSize, getFontStyle, getImage, getIntegerAttribute, getLabelType, getLightColor, getLineColor, getLineWidth, getLocale, getMarkerColor, getMarkerSize, getName, getNumber, getPaint, getStringAttribute, getTextFormat, getTickLength, getTransform, getX, getY, isAncestorOf, isAttributeSet, isAttributeSetAtThisNode, parseColor, remove, setAttribute, setAutoscaleInput, setAutoscaleMinimumTimeInterval, setAutoscaleOutput, setDensity, setFillColor, setFillColor, setFont, setFontName, setFontSize, setFontStyle, setImage, setLabelType, setLightColor, setLightColor, setLineColor, setLineColor, setLineWidth, setLocale, setMarkerColor, setMarkerColor, setMarkerSize, setName, setNumber, setPaint, setTextFormat, setTextFormat, setTickLength, setTransform, setX, setY, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Annotation

public Annotation(ChartNode parent,
                  Image img,
                  double x,
                  double y)

Renders an Image object centered at an x,y location in chart coordinates.

Parameters:

parent - the ChartNode parent of this data node, usually an Axis object

img - the Image object to draw

x - the x location in user coordinates

y - the y location in user coordinates

Annotation

public Annotation(ChartNode parent,
                  String string,
                  double x,
                  double y)

Draws a String at the specific x,y location in chart coordinates.

Parameters:

parent - the ChartNode parent of this data node, usually an Axis object

string - the String to draw

x - the x location in user coordinates

y - the y location in user coordinates

Annotation

public Annotation(ChartNode parent,
                  Text text,
                  double x,
                  double y)

Creates a Text object at the specific x,y location in chart coordinates.

Parameters:

parent - the ChartNode parent of this data node, usually an Axis object

text - the Text object to draw

x - the x location in user coordinates

y - the y location in user coordinates

Method Detail

getText

public Text getText()

Gets the Text for this Annotation object.

paint

public void paint(Draw draw)

Paints this node and all of its children. This is normally called only by the paint method in this node's parent.

Overrides:

paint in class Data

Parameters:

draw - the Draw object to be painted

setLocation

public void setLocation(double x,
                        double y)

Update the location of this Annotation instance.

Parameters:

x - a double specifying the new x location in chart coordinates.

y - a double specifying the new y location in chart coordinates.

setString

public void setString(String string)

Sets the String for the Text object to render.

Parameters:

string - the new String value

setText

public void setText(Text text)

Sets the Text object to render.

Parameters:

text - the new Text object