com.luciad.format.raster

LuciadFusionClass TLcdNumericParameterizedIcon

java.lang.Object

com.luciad.format.raster.TLcdNumericParameterizedIcon

All Implemented Interfaces:

ILcdParameterizedIcon

public class TLcdNumericParameterizedIcon
extends Object
implements ILcdParameterizedIcon

This ILcdParameterizedIcon displays numbers, based on the first value in the array of parameters.

Since:

2015.0

Constructor Summary

Constructors

Constructor and Description
TLcdNumericParameterizedIcon() Default constructor

Method Summary

Modifier and Type	Method and Description
void	anchorPointSFCT(double[] aParameters, Point aPointSFCT) Returns the anchor point of this icon.
Color	getColor() Gets the color of the numbers.
Font	getFont() Gets the font of the numbers.
Format	getFormat() Gets the format for the numbers.
int	getHeight(double[] aParameters) Returns the height of the icon for the given parameter values.
int	getWidth(double[] aParameters) Returns the width of the icon for the given parameter values.
void	paintIcon(Graphics aGraphics, int aX, int aY, double[] aParameters) Paint the icon at the specified location for the parameters
void	setColor(Color aColor) Sets the color of the numbers.
void	setFont(Font aFont) Sets the font of the numbers.
void	setFormat(Format aFormat) Sets the format for the numbers.

Methods inherited from class java.lang.Object

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

Constructor Detail

TLcdNumericParameterizedIcon

public TLcdNumericParameterizedIcon()

Default constructor

Method Detail

getFont

public Font getFont()

Gets the font of the numbers.

Returns:

The font of the numbers.

See Also:

setFont(java.awt.Font)

setFont

public void setFont(Font aFont)

Sets the font of the numbers.

Parameters:

aFont - The font of the numbers.

See Also:

getFont()

getColor

public Color getColor()

Gets the color of the numbers.

Returns:

The color of the numbers.

See Also:

setColor(java.awt.Color)

setColor

public void setColor(Color aColor)

Sets the color of the numbers.

Parameters:

aColor - The color of the numbers.

See Also:

getColor()

getFormat

public Format getFormat()

Gets the format for the numbers.

Returns:

The format for the numbers.

See Also:

setFormat(java.text.Format)

setFormat

public void setFormat(Format aFormat)

Sets the format for the numbers.

Parameters:

aFormat - The format for the numbers.

See Also:

getFormat()

anchorPointSFCT

public void anchorPointSFCT(double[] aParameters,
                            Point aPointSFCT)

Description copied from interface: ILcdParameterizedIcon

Returns the anchor point of this icon. The anchor point of an icon is the point on the icon that is attached to the underlying object. For example: a circle icon is attached to an underlying point object by its center. An arrow icon can for example be attached to its object at the start of the arrow. The x-coordinate of the anchor point typically lies between 0 and getWidth(). The y-coordinate typically lies between 0 and getHeight().

Note that implementations don't need to take the anchor point into account when implementing the paintIcon method. The coordinates passed to that method always represent the top left corner of the icon. Callers of the paint method should make sure that the anchor point is taken into account.

A good default implementation can be to use the middle of the icon:

 aPointSFCT.setLocation(getWidth(aParameters) / 2, getHeight(aParameters) / 2);
 

Specified by:

anchorPointSFCT in interface ILcdParameterizedIcon

Parameters:

aParameters - the parameter values

aPointSFCT - the point that has to be moved to the location of the anchor point of this icon.

paintIcon

public void paintIcon(Graphics aGraphics,
                      int aX,
                      int aY,
                      double[] aParameters)

Description copied from interface: ILcdParameterizedIcon

Paint the icon at the specified location for the parameters

Specified by:

paintIcon in interface ILcdParameterizedIcon

Parameters:

aGraphics - the Graphics on which the icon is painted

aX - the x coordinate at which the icon is painted. aX is the x-coordinate of the top left corner point of the icon.

aY - the y coordinate at which the icon is painted. aY is the y-coordinate of the top left corner point of the icon.

aParameters - the parameter values

getWidth

public int getWidth(double[] aParameters)

Description copied from interface: ILcdParameterizedIcon

Returns the width of the icon for the given parameter values.

Specified by:

getWidth in interface ILcdParameterizedIcon

Parameters:

aParameters - the parameter values as passed in ILcdParameterizedIcon.paintIcon(java.awt.Graphics, int, int, double[])

Returns:

the width

getHeight

public int getHeight(double[] aParameters)

Description copied from interface: ILcdParameterizedIcon

Returns the height of the icon for the given parameter values.

Specified by:

getHeight in interface ILcdParameterizedIcon

Parameters:

aParameters - the parameter values as passed in ILcdParameterizedIcon.paintIcon(java.awt.Graphics, int, int, double[])

Returns:

the height