ilog.views.chart.graphic

Class IlvDataLabelAnnotation

java.lang.Object

ilog.views.chart.graphic.IlvDataLabelAnnotation

All Implemented Interfaces:

IlvDataAnnotation, Serializable

public class IlvDataLabelAnnotation
extends Object
implements IlvDataAnnotation, Serializable

An annotation used for data point labeling. This annotation lets you display the data value, or data label associated with a display point. This annotation uses the IlvChartRenderer.computeDataLabel(ilog.views.chart.data.IlvDataSetPoint) method to compute the displayed string if no explicit text has been set, and the IlvChartRenderer.computeDataLabelLocation(ilog.views.chart.IlvDisplayPoint, java.awt.Dimension) to compute the label location.

Here is a picture showing a data label annotation set individually on a data point of a Pie chart:

Since:

JViews 5.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvDataLabelAnnotation() Creates a new label information using a default label renderer.
IlvDataLabelAnnotation(IlvLabelRenderer labelRenderer) Creates a new label information using the specified label renderer.

Method Summary

Modifier and Type	Method and Description
protected Point	computeLabelLocation(String label, IlvDisplayPoint dp) Returns the center of the label annotation.
protected String	computeText(IlvDisplayPoint dp) Computes the text displayed by the data annotation.
void	draw(Graphics g, IlvDisplayPoint dp) Draws the annotation according to the specified display point.
Rectangle2D	getBounds(IlvDisplayPoint dp, Rectangle2D bounds) Returns the bounding rectangle of this annotation, when displayed according to the specified display point.
IlvLabelRenderer	getLabelRenderer() Returns the renderer used to display the label.
String	getText() Returns the text of this annotation.
void	setLabelRenderer(IlvLabelRenderer labelRenderer) Sets the renderer that displays the label.
void	setText(String text) Sets the text of this annotation.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvDataLabelAnnotation

public IlvDataLabelAnnotation()

Creates a new label information using a default label renderer.

IlvDataLabelAnnotation

public IlvDataLabelAnnotation(IlvLabelRenderer labelRenderer)

Creates a new label information using the specified label renderer.

Method Detail

getText

public String getText()

Returns the text of this annotation. This method returns null if no text has been set.

Since:

JViews 5.5

See Also:

setText(java.lang.String)

setText

public void setText(String text)

Sets the text of this annotation. By calling this method, you disable the label dynamic computation.

Since:

JViews 5.5

See Also:

computeText(ilog.views.chart.IlvDisplayPoint)

getLabelRenderer

public final IlvLabelRenderer getLabelRenderer()

Returns the renderer used to display the label.

setLabelRenderer

public void setLabelRenderer(IlvLabelRenderer labelRenderer)

Sets the renderer that displays the label.

Since:

JViews 8.0

draw

public void draw(Graphics g,
                 IlvDisplayPoint dp)

Draws the annotation according to the specified display point.

Specified by:

draw in interface IlvDataAnnotation

getBounds

public Rectangle2D getBounds(IlvDisplayPoint dp,
                             Rectangle2D bounds)

Returns the bounding rectangle of this annotation, when displayed according to the specified display point.

Specified by:

getBounds in interface IlvDataAnnotation

Parameters:

dp - The considered display point.

bounds - A rectangle optionally used to store the result. If null, a new Rectangle2D is allocated.

Returns:

The bounds of the annotation.

computeText

protected String computeText(IlvDisplayPoint dp)

Computes the text displayed by the data annotation. The default implementation returns the text set by setText(java.lang.String), or if null, calls the IlvChartRenderer.computeDataLabel(ilog.views.chart.data.IlvDataSetPoint) method of the renderer displaying the specified display point.

See Also:

setText(java.lang.String)

computeLabelLocation

protected Point computeLabelLocation(String label,
                                     IlvDisplayPoint dp)

Returns the center of the label annotation. The default implementation calls the IlvChartRenderer.computeDataLabelLocation(ilog.views.chart.IlvDisplayPoint, java.awt.Dimension) method of the renderer displaying the specified display point.