org.esa.snap.core.datamodel

Class ImageLegend

java.lang.Object

org.esa.snap.core.datamodel.ImageLegend

public class ImageLegend
extends Object

The ImageLegend class is used to generate an image legend from a ImageInfo instance.

Version:

$Revision$ $Date$

Field Summary

Fields

Modifier and Type	Field and Description
static int	HORIZONTAL
static int	VERTICAL

Constructor Summary

Constructors

Constructor and Description
ImageLegend(ImageInfo imageInfo, RasterDataNode raster)

Method Summary

Modifier and Type	Method and Description
BufferedImage	createImage()
int	getBackgroundAlpha()
Color	getBackgroundColor()
float	getBackgroundTransparency()
Font	getFont()
Color	getForegroundColor()
String	getHeaderText()
ImageInfo	getImageInfo()
int	getOrientation()
RasterDataNode	getRaster()
boolean	isAlphaUsed()
boolean	isAntialiasing()
boolean	isBackgroundTransparencyEnabled()
boolean	isUsingHeader()
void	setAntialiasing(boolean antialiasing)
void	setBackgroundColor(Color backgroundColor)
void	setBackgroundTransparency(float backgroundTransparency)
void	setBackgroundTransparencyEnabled(boolean backgroundTransparencyEnabled)
void	setFont(Font font)
void	setForegroundColor(Color foregroundColor)
void	setHeaderText(String headerText)
void	setOrientation(int orientation)
void	setUsingHeader(boolean usingHeader)

Methods inherited from class java.lang.Object

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

Field Detail

HORIZONTAL

public static final int HORIZONTAL

See Also:

Constant Field Values

VERTICAL

public static final int VERTICAL

See Also:

Constant Field Values

Constructor Detail

ImageLegend

public ImageLegend(ImageInfo imageInfo,
                   RasterDataNode raster)

Method Detail

getImageInfo

public ImageInfo getImageInfo()

getRaster

public RasterDataNode getRaster()

isUsingHeader

public boolean isUsingHeader()

setUsingHeader

public void setUsingHeader(boolean usingHeader)

getHeaderText

public String getHeaderText()

setHeaderText

public void setHeaderText(String headerText)

getOrientation

public int getOrientation()

setOrientation

public void setOrientation(int orientation)

getFont

public Font getFont()

setFont

public void setFont(Font font)

getBackgroundColor

public Color getBackgroundColor()

setBackgroundColor

public void setBackgroundColor(Color backgroundColor)

getForegroundColor

public Color getForegroundColor()

setForegroundColor

public void setForegroundColor(Color foregroundColor)

isAntialiasing

public boolean isAntialiasing()

setAntialiasing

public void setAntialiasing(boolean antialiasing)

isBackgroundTransparencyEnabled

public boolean isBackgroundTransparencyEnabled()

setBackgroundTransparencyEnabled

public void setBackgroundTransparencyEnabled(boolean backgroundTransparencyEnabled)

getBackgroundTransparency

public float getBackgroundTransparency()

setBackgroundTransparency

public void setBackgroundTransparency(float backgroundTransparency)

isAlphaUsed

public boolean isAlphaUsed()

getBackgroundAlpha

public int getBackgroundAlpha()

createImage

public BufferedImage createImage()