ilog.views.chart.graphic

Class IlvImageDecoration

java.lang.Object

ilog.views.chart.IlvChartOwnedDrawable

ilog.views.chart.IlvChartDecoration

ilog.views.chart.graphic.IlvPositionableDecoration

ilog.views.chart.graphic.IlvImageDecoration

All Implemented Interfaces:

IlvChart3DSupport, IlvChartDrawable, Serializable, SwingConstants

public class IlvImageDecoration
extends IlvPositionableDecoration

A class to display images as chart decorations. The IlvImageDecoration class defines three modes of drawing:

• ANCHORED, to draw the image at a predefined fixed position. In this mode, the position is expressed as one of the SwingConstants compass-direction.
• TILED, to draw the image as a replicated pattern.
• SCALED, to draw the image so that it fills the plot area.

The following picture shows samples of the different modes:

Since:

JViews 5.5

See Also:

IlvChartDecoration, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	ANCHORED The ANCHORED mode constant.
static int	SCALED The SCALED mode constant.
static int	TILED The TILED mode constant.

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
IlvImageDecoration(Image image) Creates a new IlvImageDecoration object in ANCHORED mode displaying the specified image centered within the plot area.
IlvImageDecoration(Image image, int mode, int anchor) Creates a new IlvImageDecoration object in the specified mode displaying the specified image.
IlvImageDecoration(URL imageURL, int mode, int anchor) Creates a new IlvImageDecoration object in the specified mode displaying the image loaded from the specified URL.

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().
void	draw(Graphics g) Draws the decoration into the specified Graphics context.
int	getAnchor() Returns the image anchor within the plot area.
Rectangle2D	getBounds(Rectangle2D retBounds) Returns the bounds of this decoration.
URL	getImageURL() Returns the URL of the image or null if not specified.
int	getMode() Returns the drawing mode.
Point	getOffset() Returns the decoration's position, relative to the anchor.
void	setAnchor(int anchor) Sets the image anchor within the plot area.
void	setMode(int mode) Sets the drawing mode.
void	setOffset(Point offset) Sets the decoration's position, relative to the anchor.

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

getLocation

Methods inherited from class ilog.views.chart.IlvChartDecoration

afterDraw, baseTextDirectionChanged, beforeDraw, componentOrientationChanged, 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

Field Detail

ANCHORED

public static final int ANCHORED

The ANCHORED mode constant.

See Also:

Constant Field Values

TILED

public static final int TILED

The TILED mode constant.

See Also:

Constant Field Values

SCALED

public static final int SCALED

The SCALED mode constant.

See Also:

Constant Field Values

Constructor Detail

IlvImageDecoration

public IlvImageDecoration(Image image)

Creates a new IlvImageDecoration object in ANCHORED mode displaying the specified image centered within the plot area. Note that serialization of an IlvImageDecoration instance created with this constructor will not preserve the image.

See Also:

ANCHORED

IlvImageDecoration

public IlvImageDecoration(Image image,
                          int mode,
                          int anchor)

Creates a new IlvImageDecoration object in the specified mode displaying the specified image.

Parameters:

image - The image to display.

mode - The positioning mode. One of the ANCHORED, TILED, or SCALED constants.

anchor - The image position within the plot area. This parameter is meaningful only if the mode is set to ANCHORED. 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. Note that serialization of an IlvImageDecoration instance created with this constructor will not preserve the image.

IlvImageDecoration

public IlvImageDecoration(URL imageURL,
                          int mode,
                          int anchor)

Creates a new IlvImageDecoration object in the specified mode displaying the image loaded from the specified URL.

Parameters:

imageURL - The image to display.

mode - The positioning mode. One of the ANCHORED, TILED or SCALED constants.

anchor - The image position within the plot area. This parameter is meaningful only if the mode is set to ANCHORED. 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. Note that serialization of an IlvImageDecoration instance created with this constructor preserve the image.

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

getImageURL

public final URL getImageURL()

Returns the URL of the image or null if not specified.

Since:

JViews 6.0

getMode

public int getMode()

Returns the drawing mode. One of the ANCHORED, TILED or SCALED constants.

setMode

public void setMode(int mode)

Sets the drawing mode.

Parameters:

mode - One of the ANCHORED, TILED or SCALED constants.

Since:

JViews 6.0

getAnchor

public int getAnchor()

Returns the image anchor within the plot area. This method is meaningful only when the mode of this decoration is set to ANCHORED.

Overrides:

getAnchor in class IlvPositionableDecoration

See Also:

setAnchor(int)

setAnchor

public void setAnchor(int anchor)

Sets the image anchor within the plot area. This method is meaningful only when the mode of this decoration is set to ANCHORED.

Overrides:

setAnchor in class IlvPositionableDecoration

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. This method is meaningful only when the mode of this decoration is set to ANCHORED.

Overrides:

getOffset in class IlvPositionableDecoration

See Also:

setOffset(java.awt.Point)

setOffset

public void setOffset(Point offset)

Sets the decoration's position, relative to the anchor. This method is meaningful only when the mode of this decoration is set to ANCHORED.

Overrides:

setOffset in class IlvPositionableDecoration

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.

computeLocation

protected void computeLocation()

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

Overrides:

computeLocation in class IlvPositionableDecoration