ilog.views.chart.graphic

Class IlvLabelDecoration

java.lang.Object

ilog.views.chart.IlvChartOwnedDrawable

ilog.views.chart.IlvChartDecoration

ilog.views.chart.graphic.IlvPositionableDecoration

ilog.views.chart.graphic.IlvLabelDecoration

All Implemented Interfaces:

IlvChart3DSupport, IlvChartDrawable, Serializable, SwingConstants

public class IlvLabelDecoration
extends IlvPositionableDecoration

A class to display a label as a chart decoration. The label is positioned at an arbitrary fixed position in the chart.

Since:

JViews 8.5

See Also:

IlvChartDecoration, Serialized Form

Field Summary

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Constructor Summary

Constructors

Constructor and Description
IlvLabelDecoration(String text) Creates a new IlvLabelDecoration object displaying the specified string centered within the plot area.
IlvLabelDecoration(String text, IlvLabelRenderer labelRenderer, int anchor) Creates a new IlvLabelDecoration object displaying the specified string.

Method Summary

Modifier and Type	Method and Description
protected void	baseTextDirectionChanged() This method is invoked when the effective base text direction of the chart has changed.
protected void	chartConnected(IlvChart oldChart, IlvChart newChart) Called when the decoration is added to or removed from a chart.
protected void	componentOrientationChanged(ComponentOrientation oldOrientation, ComponentOrientation newOrientation) This method is invoked when the component orientation of the chart has changed.
void	draw(Graphics g) Draws the decoration into the specified Graphics context.
Rectangle2D	getBounds(Rectangle2D retBounds) Returns the bounds of this decoration.
IlvLabelRenderer	getLabelRenderer() Returns the renderer used to display the label.
String	getText() Returns the text of this decoration.
void	setLabelRenderer(IlvLabelRenderer labelRenderer) Sets the renderer that displays the label.
void	setText(String text) Sets the text of this decoration.
void	setVisible(boolean visible) Toggles the visibility of this decoration.
protected void	updateBoundsCache() Updates the bounds cache of this decoration.

Methods inherited from class ilog.views.chart.graphic.IlvPositionableDecoration

computeLocation, getAnchor, getLocation, getOffset, setAnchor, setOffset

Methods inherited from class ilog.views.chart.IlvChartDecoration

afterDraw, beforeDraw, getChart, getDrawOrder, has3DSupport, isVisible, repaint, setDrawOrder

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvLabelDecoration

public IlvLabelDecoration(String text)

Creates a new IlvLabelDecoration object displaying the specified string centered within the plot area.

Parameters:

text - The string to display.

IlvLabelDecoration

public IlvLabelDecoration(String text,
                          IlvLabelRenderer labelRenderer,
                          int anchor)

Creates a new IlvLabelDecoration object displaying the specified string.

Parameters:

text - The string to display.

labelRenderer - The appearance of the label.

anchor - The text position within the plot area. One of the SwingConstants.CENTER, SwingConstants.NORTH, SwingConstants.NORTH_WEST, SwingConstants.WEST, SwingConstants.SOUTH_WEST, SwingConstants.SOUTH, SwingConstants.SOUTH_EAST, SwingConstants.EAST, SwingConstants.NORTH_EAST constants.

Method Detail

chartConnected

protected void chartConnected(IlvChart oldChart,
                              IlvChart newChart)

Called when the decoration is added to or removed from a chart.

Overrides:

chartConnected in class IlvPositionableDecoration

Parameters:

oldChart - The chart with which the decoration was associated, or null if the decoration is added to a new chart.

newChart - The chart to which the decoration is added, or null if the decoration is removed from its current chart.

See Also:

IlvChartOwnedDrawable.getChart()

getText

public final String getText()

Returns the text of this decoration.

See Also:

setText(java.lang.String)

setText

public void setText(String text)

Sets the text of this decoration.

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.

draw

public void draw(Graphics g)

Draws the decoration into the specified Graphics context.

Specified by:

draw in interface IlvChartDrawable

Specified by:

draw in class IlvChartDecoration

getBounds

public Rectangle2D getBounds(Rectangle2D retBounds)

Returns the bounds of this decoration.

Specified by:

getBounds in interface IlvChartDrawable

Specified by:

getBounds in class IlvPositionableDecoration

Parameters:

retBounds - A rectangle used to store the result. If this parameter is null, a new Rectangle2D is allocated.

Returns:

The bounds of this decoration.

updateBoundsCache

protected void updateBoundsCache()

Updates the bounds cache of this decoration. This needs to be called whenever the bounds of this decoration change while getChart() && isVisible() is true, or when getChart() && isVisible() becomes true.

Overrides:

updateBoundsCache in class IlvChartDecoration

componentOrientationChanged

protected void componentOrientationChanged(ComponentOrientation oldOrientation,
                                           ComponentOrientation newOrientation)

This method is invoked when the component orientation of the chart has changed.

Overrides:

componentOrientationChanged in class IlvChartDecoration

Parameters:

oldOrientation - The component orientation before the change.

newOrientation - The component orientation after the change.

See Also:

Component.getComponentOrientation()

baseTextDirectionChanged

protected void baseTextDirectionChanged()

This method is invoked when the effective base text direction of the chart has changed. That is, it is invoked

1. when the value of chart.getResolvedBaseTextDirection() has changed, or
2. when the value of chart.getComponentOrientation() has changed and the value of chart.getResolvedBaseTextDirection() is IlvBidiUtil.CONTEXTUAL_DIRECTION.

Overrides:

baseTextDirectionChanged in class IlvChartDecoration

See Also:

IlvChart.getResolvedBaseTextDirection(), Component.getComponentOrientation()

setVisible

public void setVisible(boolean visible)

Toggles the visibility of this decoration.

Overrides:

setVisible in class IlvChartDecoration

See Also:

IlvChartDecoration.isVisible()