Package adams.gui.visualization.image

Class MetaDataText

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.image.AbstractImageOverlay

adams.gui.visualization.image.MetaDataText

All Implemented Interfaces:

CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<AbstractImageOverlay>, SizeOfHandler, ImageOverlay, Serializable

public class MetaDataText
extends AbstractImageOverlay

Overlay for text from the image's meta-data.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

ImagePanel.getAllProperties(), Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Color	m_Color	the color of the text.
protected Field	m_Field	the meta-data field to display.
protected Font	m_Font	the font for the text.
protected String	m_Prefix	the prefix to use.
protected int	m_X	the X for the text.
protected int	m_Y	the Y for the text.

Fields inherited from class adams.gui.visualization.image.AbstractImageOverlay

m_Enabled

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
MetaDataText()

Method Summary

Modifier and Type	Method	Description
String	colorTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected void	doImageChanged(ImagePanel.PaintPanel panel)	Notifies the overlay that the image has changed.
protected void	doPaintOverlay(ImagePanel.PaintPanel panel, Graphics g)	Performs the actual painting of the overlay.
String	fieldTipText()	Returns the tip text for this property.
String	fontTipText()	Returns the tip text for this property.
Color	getColor()	Returns the color of the text.
Field	getField()	Returns the meta-data field to display.
Font	getFont()	Returns the font of the text.
String	getPrefix()	Returns the optional prefix for the text.
int	getX()	Returns the X of the text.
int	getY()	Returns the Y of the text.
String	globalInfo()	Returns a string describing the object.
String	prefixTipText()	Returns the tip text for this property.
void	setColor(Color value)	Sets the color of the text.
void	setField(Field value)	Sets the meta-data field to display.
void	setFont(Font value)	Sets the font of the text.
void	setPrefix(String value)	Sets the optional prefix for the text.
void	setX(int value)	Sets the X of the text.
void	setY(int value)	Sets the Y of the text.
String	XTipText()	Returns the tip text for this property.
String	YTipText()	Returns the tip text for this property.

Methods inherited from class adams.gui.visualization.image.AbstractImageOverlay

cleanUp, enabledTipText, imageChanged, isEnabled, overlayAdded, overlayRemoved, paintOverlay, setEnabled, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_X

protected int m_X

the X for the text.

m_Y

protected int m_Y

the Y for the text.

m_Font

protected Font m_Font

the font for the text.

m_Color

protected Color m_Color

the color of the text.

m_Prefix

protected String m_Prefix

the prefix to use.

m_Field

protected Field m_Field

the meta-data field to display.

Constructor Detail

MetaDataText

public MetaDataText()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractImageOverlay

setX

public void setX(int value)

Sets the X of the text.

Parameters:

value - the X

getX

public int getX()

Returns the X of the text.

Returns:

the X

XTipText

public String XTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setY

public void setY(int value)

Sets the Y of the text.

Parameters:

value - the Y

getY

public int getY()

Returns the Y of the text.

Returns:

the Y

YTipText

public String YTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setFont

public void setFont(Font value)

Sets the font of the text.

Parameters:

value - the font

getFont

public Font getFont()

Returns the font of the text.

Returns:

the font

fontTipText

public String fontTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setColor

public void setColor(Color value)

Sets the color of the text.

Parameters:

value - the color

getColor

public Color getColor()

Returns the color of the text.

Returns:

the color

colorTipText

public String colorTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setPrefix

public void setPrefix(String value)

Sets the optional prefix for the text.

Parameters:

value - the prefix

getPrefix

public String getPrefix()

Returns the optional prefix for the text.

Returns:

the prefix

prefixTipText

public String prefixTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setField

public void setField(Field value)

Sets the meta-data field to display.

Parameters:

value - the field

getField

public Field getField()

Returns the meta-data field to display.

Returns:

the field

fieldTipText

public String fieldTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

doImageChanged

protected void doImageChanged(ImagePanel.PaintPanel panel)

Notifies the overlay that the image has changed.

Specified by:

doImageChanged in class AbstractImageOverlay

Parameters:

panel - the panel this overlay belongs to

doPaintOverlay

protected void doPaintOverlay(ImagePanel.PaintPanel panel,
                              Graphics g)

Performs the actual painting of the overlay.

Specified by:

doPaintOverlay in class AbstractImageOverlay

Parameters:

panel - the panel this overlay is for

g - the graphics context