ilog.views.chart

Class IlvChartDecoration

java.lang.Object

ilog.views.chart.IlvChartOwnedDrawable

ilog.views.chart.IlvChartDecoration

All Implemented Interfaces:

IlvChart3DSupport, IlvChartDrawable, Serializable

Direct Known Subclasses:

IlvDataIndicator, IlvPositionableDecoration

public abstract class IlvChartDecoration
extends IlvChartOwnedDrawable
implements Serializable

Represents a graphical decoration that can be added to an IlvChart. You can control the drawing order of the decoration with the setDrawOrder(int) method, which lets you specify whether the decoration must be drawn above or below the chart representations.

Since:

JViews 5.0

See Also:

IlvChart.addDecoration(ilog.views.chart.IlvChartDecoration), Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IlvChartDecoration() Initializes a new chart decoration with a drawing order set to IlvChart.DRAW_BELOW.

Method Summary

Modifier and Type	Method and Description
void	afterDraw(Graphics g) Invoked after the draw method of all the drawables that have the same drawing order.
protected void	baseTextDirectionChanged() This method is invoked when the effective base text direction of the chart has changed.
void	beforeDraw(Graphics g) Invoked before the draw method of all the drawables that have the same drawing order.
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.
abstract void	draw(Graphics g) Draws the decoration into the specified Graphics context.
Rectangle2D	getBounds(Rectangle2D retBounds) Returns the bounds of this decoration.
IlvChart	getChart() Returns the chart that displays this decoration.
int	getDrawOrder() Returns the drawing order of this decoration.
boolean	has3DSupport() Indicates whether this decoration supports three-dimensional drawing.
boolean	isVisible() Indicates whether this decoration is visible.
void	repaint() Requests a repaint of the decoration.
void	setDrawOrder(int drawOrder) Sets the drawing order 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 java.lang.Object

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

Constructor Detail

IlvChartDecoration

protected IlvChartDecoration()

Initializes a new chart decoration with a drawing order set to IlvChart.DRAW_BELOW.

Method Detail

has3DSupport

public boolean has3DSupport()

Indicates whether this decoration supports three-dimensional drawing. The default implementation returns false.

Specified by:

has3DSupport in interface IlvChart3DSupport

Specified by:

has3DSupport in interface IlvChartDrawable

Since:

JViews 5.5

beforeDraw

public void beforeDraw(Graphics g)

Invoked before the draw method of all the drawables that have the same drawing order. This method can, for example, draw a filled background.

Since:

JViews 8.1

draw

public abstract void draw(Graphics g)

Draws the decoration into the specified Graphics context.

Specified by:

draw in interface IlvChartDrawable

afterDraw

public void afterDraw(Graphics g)

Invoked after the draw method of all the drawables that have the same drawing order. This method can, for example, draw a kind of cross cursor.

Since:

JViews 8.1

getBounds

public Rectangle2D getBounds(Rectangle2D retBounds)

Returns the bounds of this decoration. The default implementation returns the plotting rectangle of the chart displaying the decoration, or an empty rectangle if the decoration is not associated with any chart.

Specified by:

getBounds in interface IlvChartDrawable

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.

Since:

JViews 8.7

componentOrientationChanged

protected void componentOrientationChanged(ComponentOrientation oldOrientation,
                                           ComponentOrientation newOrientation)

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

Parameters:

oldOrientation - The component orientation before the change.

newOrientation - The component orientation after the change.

Since:

JViews 8.8

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.

Since:

JViews 8.8

See Also:

IlvChart.getResolvedBaseTextDirection(), Component.getComponentOrientation()

getChart

public IlvChart getChart()

Returns the chart that displays this decoration. This method returns null until the decoration has been added to a chart with the IlvChart.addDecoration(ilog.views.chart.IlvChartDecoration) method.

Specified by:

getChart in class IlvChartOwnedDrawable

chartConnected

protected void chartConnected(IlvChart oldChart,
                              IlvChart newChart)

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

Specified by:

chartConnected in class IlvChartOwnedDrawable

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.

Since:

JViews 5.5

See Also:

IlvChartOwnedDrawable.getChart()

repaint

public void repaint()

Requests a repaint of the decoration.

Since:

JViews 5.5

isVisible

public boolean isVisible()

Indicates whether this decoration is visible.

Specified by:

isVisible in interface IlvChartDrawable

See Also:

setVisible(boolean)

setVisible

public void setVisible(boolean visible)

Toggles the visibility of this decoration.

See Also:

isVisible()

getDrawOrder

public final int getDrawOrder()

Returns the drawing order of this decoration.

Specified by:

getDrawOrder in interface IlvChartDrawable

Returns:

An integer that represents the drawing order. The IlvChartDrawable objects are drawn in ascending drawing order. The drawing order also specifies whether the object is drawn above (positive values) or below (negative values) the graphical representations of the chart data.

See Also:

setDrawOrder(int)

setDrawOrder

public void setDrawOrder(int drawOrder)

Sets the drawing order of this decoration.

See Also:

IlvChart.DRAW_ABOVE, IlvChart.DRAW_BELOW, getDrawOrder()