ilog.views.chart

Class IlvScaleAnnotation

java.lang.Object

ilog.views.chart.IlvScaleAnnotation

All Implemented Interfaces:

Serializable

public class IlvScaleAnnotation
extends Object
implements Serializable

Draws an annotation on a scale. A scale annotation lets you indicate a data value on a scale. It displays the annotation label if it is defined, or the data value. In the latter case, the IlvScale.computeLabel(double) method is used to format the value into a string.

Since:

JViews 5.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvScaleAnnotation(double value) Creates a new IlvScaleAnnotation for the specified value.
IlvScaleAnnotation(double value, String text) Creates a new IlvScaleAnnotation for the specified value with the specified text.
IlvScaleAnnotation(double value, String text, IlvLabelRenderer renderer) Creates a new IlvScaleAnnotation for the specified value with the specified text and the specified label rendering style.

Method Summary

Modifier and Type	Method and Description
protected void	draw(Graphics g) Draws the annotation.
Rectangle2D	getBounds(Rectangle2D bounds) Returns the annotation bounds.
String	getLabel() Returns the label displayed by this annotation.
IlvLabelRenderer	getLabelRenderer() Returns the label renderer used to draw the annotation text.
IlvScale	getScale() Returns the scale displaying this annotation.
double	getValue() Returns the value of the annotation.
void	setLabel(String label) Sets the label displayed by this annotation.
void	setValue(double value) Sets the value of the annotation.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvScaleAnnotation

public IlvScaleAnnotation(double value)

Creates a new IlvScaleAnnotation for the specified value.

IlvScaleAnnotation

public IlvScaleAnnotation(double value,
                          String text)

Creates a new IlvScaleAnnotation for the specified value with the specified text.

IlvScaleAnnotation

public IlvScaleAnnotation(double value,
                          String text,
                          IlvLabelRenderer renderer)

Creates a new IlvScaleAnnotation for the specified value with the specified text and the specified label rendering style.

Since:

JViews 8.0

Method Detail

getScale

public final IlvScale getScale()

Returns the scale displaying this annotation. This method returns null until the annotation is added to a scale with the IlvScale.addAnnotation(ilog.views.chart.IlvScaleAnnotation) method.

getLabel

public String getLabel()

Returns the label displayed by this annotation.

setLabel

public void setLabel(String label)

Sets the label displayed by this annotation. If the label is set to null, the annotation displays its value.

getValue

public final double getValue()

Returns the value of the annotation.

See Also:

setValue(double)

setValue

public void setValue(double value)

Sets the value of the annotation.

See Also:

getValue()

getLabelRenderer

public IlvLabelRenderer getLabelRenderer()

Returns the label renderer used to draw the annotation text.

draw

protected void draw(Graphics g)

Draws the annotation.

Parameters:

g - The destination graphics.

Since:

JViews 5.5

getBounds

public Rectangle2D getBounds(Rectangle2D bounds)

Returns the annotation bounds.

Parameters:

bounds - A rectangle optionally used to store the result.

Returns:

The annotation bounds.

Since:

JViews 5.5