ilog.views.chart.graphic

Class IlvMarkerIcon

java.lang.Object

ilog.views.chart.graphic.IlvMarkerIcon

All Implemented Interfaces:

Serializable, Icon

public class IlvMarkerIcon
extends Object
implements Icon, Serializable

An Icon class that draws an IlvMarker object of a specific type.

IlvMarkerIcon can be used by the IlvDefaultDataAnnotation class to draw an IlvMarker next to the graphical representation of a data point.

Since:

JViews 5.0

See Also:

IlvMarkerFactory, IlvMarker, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	CIRCLE_MARKER The circle type value.
static int	DIAMOND_MARKER The diamond type value.
static int	PLUS_MARKER The plus type value.
static int	SQUARE_MARKER The square type value.

Constructor Summary

Constructors

Constructor and Description
IlvMarkerIcon() Creates a new IlvMarkerIcon of a square type with a size of 3.
IlvMarkerIcon(IlvMarker marker, int size, IlvStyle style) Creates a new IlvMarkerIcon using the given marker with the specified size.
IlvMarkerIcon(int type, int size, IlvStyle style) Creates a new IlvMarkerIcon of the specified type with the given size.

Method Summary

Modifier and Type	Method and Description
int	getIconHeight() Returns the height of the icon.
int	getIconWidth() Returns the width of the icon.
IlvMarker	getMarker() Returns the marker.
int	getSize() Returns the symbol size.
IlvStyle	getStyle() Returns the current style.
void	paintIcon(Component c, Graphics g, int x, int y) Draws the icon.
void	setSize(int size) Sets the symbol size.
void	setStyle(IlvStyle style) Sets the current style.

Methods inherited from class java.lang.Object

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

Field Detail

SQUARE_MARKER

public static final int SQUARE_MARKER

The square type value. Identical to IlvMarkerFactory.SQUARE

See Also:

Constant Field Values

DIAMOND_MARKER

public static final int DIAMOND_MARKER

The diamond type value. Identical to IlvMarkerFactory.DIAMOND

See Also:

Constant Field Values

CIRCLE_MARKER

public static final int CIRCLE_MARKER

The circle type value. Identical to IlvMarkerFactory.CIRCLE

See Also:

Constant Field Values

PLUS_MARKER

public static final int PLUS_MARKER

The plus type value. Identical to IlvMarkerFactory.PLUS

See Also:

Constant Field Values

Constructor Detail

IlvMarkerIcon

public IlvMarkerIcon()

Creates a new IlvMarkerIcon of a square type with a size of 3.

IlvMarkerIcon

public IlvMarkerIcon(int type,
                     int size,
                     IlvStyle style)

Creates a new IlvMarkerIcon of the specified type with the given size.

See Also:

IlvMarkerFactory.getMarker(int)

IlvMarkerIcon

public IlvMarkerIcon(IlvMarker marker,
                     int size,
                     IlvStyle style)

Creates a new IlvMarkerIcon using the given marker with the specified size.

See Also:

IlvMarker

Method Detail

getMarker

public final IlvMarker getMarker()

Returns the marker.

getSize

public final int getSize()

Returns the symbol size.

setSize

public void setSize(int size)

Sets the symbol size.

getStyle

public final IlvStyle getStyle()

Returns the current style.

setStyle

public void setStyle(IlvStyle style)

Sets the current style.

getIconHeight

public int getIconHeight()

Returns the height of the icon.

Specified by:

getIconHeight in interface Icon

getIconWidth

public int getIconWidth()

Returns the width of the icon.

Specified by:

getIconWidth in interface Icon

paintIcon

public void paintIcon(Component c,
                      Graphics g,
                      int x,
                      int y)

Draws the icon.

Specified by:

paintIcon in interface Icon

Parameters:

c - The component to be used to initialize the renderer if none has been set.

g - The graphics context.

x - The x-coordinate of the icon top-left corner.

y - The y-coordinate of the icon top-left corner.