quadbase.util

Interface IAnnotationSet

public interface IAnnotationSet

This class contains all annotations of the chart object. Note that annotations of other objects, such as TrendLine, HozVertLine and ControlLine, are not stored here. This class also has a method to create a new annotation for any referenced object

Method Summary

Modifier and Type	Method and Description
void	addAnnotation(IAnnotation anno) Adds an annotation to the chart.
java.util.Vector	getAnnotationList() Returns a list of IAnnotation objects using the whole chart as the referenced object.
IAnnotation	newAnnotation(java.lang.String text) Returns a new annotation object using the origin of the chart as the reference point.
IAnnotation	newAnnotation(java.lang.String[] text) Returns a new annotation object using the origin of the chart as the reference point.
IAnnotation	newAnnotation(java.lang.String[] text, int[] shape, java.awt.Color[] color) Returns a new annotation object using the origin of the chart as the reference point.
IAnnotation	newAnnotation(java.lang.String[] text, int[] shape, java.awt.Color[] color, IReferenceObj refObj) Returns a new annotation object with a specific referenced object.
IAnnotation	newAnnotation(java.lang.String[] text, IReferenceObj refObj) Returns a new annotation object with a specific referenced object.
IAnnotation	newAnnotation(java.lang.String text, IReferenceObj refObj) Returns a new annotation object with a specific referenced object If the value of refObj is null, the reference point is the lower-left corner of the panel
boolean	removeAnnotation(IAnnotation anno) Removes an annotation from the chart.

Method Detail

getAnnotationList

java.util.Vector getAnnotationList()

Returns a list of IAnnotation objects using the whole chart as the referenced object. Note that every data line, such as TrendLine, Horizontal line and Vertical line, keeps its own annotation list.

Returns:

Annotation Objects

See Also:

IAnnotation

newAnnotation

IAnnotation newAnnotation(java.lang.String text)

Returns a new annotation object using the origin of the chart as the reference point.

Parameters:

text - String that appears in the Annotation

Returns:

An annotation object

newAnnotation

IAnnotation newAnnotation(java.lang.String[] text)

Returns a new annotation object using the origin of the chart as the reference point.

Parameters:

text - String array that appears in the Annotation

Returns:

An annotation object

newAnnotation

IAnnotation newAnnotation(java.lang.String[] text,
                          int[] shape,
                          java.awt.Color[] color)

Returns a new annotation object using the origin of the chart as the reference point.

Parameters:

text - String array that appears in the Annotation

shape - The array containing the shapes for all the symbols. The number of points in this array should match the number of text and color

 Available shape values are:
   QbChart.NOSYMBOL
   QbChart.CROSS
   QbChart.CIRCLE
   QbChart.SQUARE
   QbChart.TRIANGLE
   QbChart.PLUS
   QbChart.STAR 
   QbChart.DASH
 

color - symbols color

Returns:

An annotation object

newAnnotation

IAnnotation newAnnotation(java.lang.String text,
                          IReferenceObj refObj)

Returns a new annotation object with a specific referenced object If the value of refObj is null, the reference point is the lower-left corner of the panel

Parameters:

text - String that appears in the Annotation

Returns:

An annotation object

newAnnotation

IAnnotation newAnnotation(java.lang.String[] text,
                          IReferenceObj refObj)

Returns a new annotation object with a specific referenced object. If the value of refObj is null, the reference point is the lower-left corner of the panel.

Parameters:

text - String array that appears in the Annotation

Returns:

An annotation object

newAnnotation

IAnnotation newAnnotation(java.lang.String[] text,
                          int[] shape,
                          java.awt.Color[] color,
                          IReferenceObj refObj)

Returns a new annotation object with a specific referenced object. If the value of refObj is null, the reference point is the lower-left corner of the panel.

Parameters:

text - String array that appears in the Annotation

shape - The array containing the shapes for all the symbols. The number of points in this array should match the number of text and color.

 Available shape values are:
   QbChart.CROSS
   QbChart.CIRCLE
   QbChart.SQUARE
   QbChart.TRIANGLE
   QbChart.PLUS
   QbChart.STAR 
   QbChart.DASH
 

color - symbols color

Returns:

An annotation object

addAnnotation

void addAnnotation(IAnnotation anno)

Adds an annotation to the chart.

Parameters:

anno - The annotation object

removeAnnotation

boolean removeAnnotation(IAnnotation anno)

Removes an annotation from the chart.

Parameters:

anno - The annotation object