ilog.views.chart.graphic

Class IlvDefaultDataAnnotation

java.lang.Object

ilog.views.chart.graphic.IlvDefaultDataAnnotation

All Implemented Interfaces:

IlvDataAnnotation, Serializable, SwingConstants

public class IlvDefaultDataAnnotation
extends Object
implements IlvDataAnnotation, SwingConstants, Serializable

A default implementation of the IlvDataAnnotation interface that draws a Swing Icon.

This class references an object that implements the javax.swing.Icon interface, and draws it next to a display point.

The location of the annotation is computed according to a position relative to the display point with which it is associated. This position can take the following values, defined in javax.swing.SwingConstants: CENTER, NORTH, NORTH_EAST, EAST, SOUTH_EAST, SOUTH, SOUTH_WEST, WEST, NORTH_WEST.

When the position is different from CENTER, an offset in pixel can be specified between the annotation and the display point.

Note that the IlvDefaultDataAnnotation is immutable: changing either the icon, position or offset creates a new instance.

Since:

JViews 5.0

See Also:

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
IlvDefaultDataAnnotation(Icon icon) Initializes a new IlvDefaultDataAnnotation object that draws the specified icon with a CENTER position.
IlvDefaultDataAnnotation(Icon icon, int position, int offset) Initializes a new IlvDefaultDataAnnotation object that draws the specified icon with the specified position and offset.
IlvDefaultDataAnnotation(URL imageURL) Initializes a new IlvDefaultDataAnnotation object that draws an image with a CENTER position.
IlvDefaultDataAnnotation(URL imageURL, int position, int offset) Initializes a new IlvDefaultDataAnnotation object that draws an image with the specified position and offset.

Method Summary

Modifier and Type	Method and Description
protected Point	computeIconLocation(IlvDisplayPoint dp) Computes the location of the icon according to the specified display point.
static Point	computeLocation(Icon icon, int position, int offset, Point anchor) Computes the location of an icon according to a specified anchor, position and offset.
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.
Icon	getIcon() Returns the drawn icon.
int	getOffset() Returns the offset between the annotation and the display point.
int	getPosition() Returns the position of the annotation relative to the display point.
URL	getURL() Returns the URL of the drawn image.
IlvDefaultDataAnnotation	setIcon(Icon icon) Creates a copy of this annotation, with the specified icon.
IlvDefaultDataAnnotation	setOffset(int offset) Sets the offset between the annotation and the display point.
IlvDefaultDataAnnotation	setPosition(int position) Sets the position of the annotation relative to the display point.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvDefaultDataAnnotation

public IlvDefaultDataAnnotation(URL imageURL)

Initializes a new IlvDefaultDataAnnotation object that draws an image with a CENTER position.

Parameters:

imageURL - The URL of the image.

Since:

JViews 5.5

See Also:

getPosition()

IlvDefaultDataAnnotation

public IlvDefaultDataAnnotation(URL imageURL,
                                int position,
                                int offset)

Initializes a new IlvDefaultDataAnnotation object that draws an image with the specified position and offset.

Parameters:

imageURL - The URL of the image.

position - The position of the icon relative to the display point.

offset - The offset of the icon, expressed in pixel.

Since:

JViews 5.5

See Also:

getPosition(), getOffset()

IlvDefaultDataAnnotation

public IlvDefaultDataAnnotation(Icon icon)

Initializes a new IlvDefaultDataAnnotation object that draws the specified icon with a CENTER position.

See Also:

getPosition()

IlvDefaultDataAnnotation

public IlvDefaultDataAnnotation(Icon icon,
                                int position,
                                int offset)

Initializes a new IlvDefaultDataAnnotation object that draws the specified icon with the specified position and offset.

Parameters:

icon - The icon to draw.

position - The position of the icon relative to the display point.

offset - The offset of the icon, expressed in pixel.

See Also:

getPosition(), getOffset()

Method Detail

getURL

public final URL getURL()

Returns the URL of the drawn image.

Returns:

The URL of the drawn image, if the annotation was created with the IlvDefaultDataAnnotation(URL), or the IlvDefaultDataAnnotation(URL, int, int) constructor, and null otherwise.

Since:

JViews 5.5

getIcon

public final Icon getIcon()

Returns the drawn icon.

setIcon

public final IlvDefaultDataAnnotation setIcon(Icon icon)

Creates a copy of this annotation, with the specified icon.

Returns:

An annotation with the specified icon.

getOffset

public final int getOffset()

Returns the offset between the annotation and the display point.

Returns:

The offset in pixels.

setOffset

public final IlvDefaultDataAnnotation setOffset(int offset)

Sets the offset between the annotation and the display point.

Parameters:

offset - The offset in pixels.

Returns:

An annotation with the new offset.

getPosition

public final int getPosition()

Returns the position of the annotation relative to the display point.

Returns:

One of the following positions defined in javax.swing.SwingConstants: CENTER, NORTH, NORTH_EAST, EAST, SOUTH_EAST, SOUTH, SOUTH_WEST, WEST, NORTH_WEST.

setPosition

public final IlvDefaultDataAnnotation setPosition(int position)

Sets the position of the annotation relative to the display point.

Parameters:

position - One of the following positions defined in javax.swing.SwingConstants: CENTER, NORTH, NORTH_EAST, EAST, SOUTH_EAST, SOUTH, SOUTH_WEST, WEST, NORTH_WEST.

Returns:

An annotation with the new position.

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.

computeIconLocation

protected Point computeIconLocation(IlvDisplayPoint dp)

Computes the location of the icon according to the specified display point.

computeLocation

public static Point computeLocation(Icon icon,
                                    int position,
                                    int offset,
                                    Point anchor)

Computes the location of an icon according to a specified anchor, position and offset.

Parameters:

icon - The considered icon.

position - The position relative to the anchor point.

offset - The offset between the anchor point and the icon.

anchor - The anchor point. This parameter is modified and returned by the method.

Returns:

The icon location.