ilog.views.chart.graphic

Class IlvPositionableDecoration

java.lang.Object

ilog.views.chart.IlvChartOwnedDrawable

ilog.views.chart.IlvChartDecoration

ilog.views.chart.graphic.IlvPositionableDecoration

All Implemented Interfaces:

IlvChart3DSupport, IlvChartDrawable, Serializable, SwingConstants

Direct Known Subclasses:

IlvGraphicDecoration, IlvImageDecoration, IlvLabelDecoration

public abstract class IlvPositionableDecoration
extends IlvChartDecoration
implements SwingConstants

A chart decoration that can be freely positioned at any place in the chart area.

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
IlvPositionableDecoration(int anchor) Creates a new IlvPositionableDecoration object.

Method Summary

Modifier and Type	Method and Description
protected void	chartConnected(IlvChart oldChart, IlvChart newChart) Called when the decoration is added to or removed from a chart.
protected void	computeLocation() Computes the current location of the decoration, and stores the result in the object returned by getLocation().
int	getAnchor() Returns the decoration's anchor within the plot area.
abstract Rectangle2D	getBounds(Rectangle2D retBounds) Returns the bounds of this decoration.
protected Point	getLocation() Returns the current location of the decoration, as an offset from the chart area's coordinate system and this decoration's coordinate system.
Point	getOffset() Returns the decoration's position, relative to the anchor.
void	setAnchor(int anchor) Sets the decoration's anchor within the plot area.
void	setOffset(Point offset) Sets the decoration's position, relative to the anchor.

Methods inherited from class ilog.views.chart.IlvChartDecoration

afterDraw, baseTextDirectionChanged, beforeDraw, componentOrientationChanged, draw, getChart, getDrawOrder, has3DSupport, isVisible, repaint, setDrawOrder, setVisible, updateBoundsCache

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvPositionableDecoration

public IlvPositionableDecoration(int anchor)

Creates a new IlvPositionableDecoration object.

Parameters:

anchor - The 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 IlvChartDecoration

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()

getAnchor

public int getAnchor()

Returns the decoration's anchor within the plot area.

See Also:

setAnchor(int)

setAnchor

public void setAnchor(int anchor)

Sets the decoration's anchor within the plot area.

Parameters:

anchor - 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.

getOffset

public Point getOffset()

Returns the decoration's position, relative to the anchor.

See Also:

setOffset(java.awt.Point)

setOffset

public void setOffset(Point offset)

Sets the decoration's position, relative to the anchor.

getLocation

protected final Point getLocation()

Returns the current location of the decoration, as an offset from the chart area's coordinate system and this decoration's coordinate system.

computeLocation

protected void computeLocation()

Computes the current location of the decoration, and stores the result in the object returned by getLocation().

getBounds

public abstract Rectangle2D getBounds(Rectangle2D retBounds)

Returns the bounds of this decoration.

The result must consider getLocation() for the x and y values of the result, and must ignore getLocation() for the width and height of the result.

The result must not use getAnchor() or getOffset() directly; these parameters are already taken into account by the computation of getLocation.

Specified by:

getBounds in interface IlvChartDrawable

Overrides:

getBounds in class IlvChartDecoration

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.