Package adams.gui.visualization.image

Class HighlightLocations

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.image.AbstractImageOverlay

adams.gui.visualization.image.HighlightLocations

All Implemented Interfaces:

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

public class HighlightLocations
extends AbstractImageOverlay

Overlay for highlighting points on an image.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Color	m_Color	the color of the circle.
protected int	m_Diameter	the diameter of the circle.
protected List<Point>	m_Locations	the list of locations to highlight.
protected float	m_StrokeThickness	the thickness of the stroke.

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
HighlightLocations()

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.
String	diameterTipText()	Returns the tip text for this property.
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.
Color	getColor()	Returns the color of the circles.
int	getDiameter()	Returns the diameter of the circles.
List<Point>	getLocations()	Returns the current locations that are being highlighted.
float	getStrokeThickness()	Returns the current stroke thickness.
String	globalInfo()	Returns a string describing the object.
protected void	initialize()	Initializes the members.
void	setColor(Color value)	Sets the color of the circles.
void	setDiameter(int value)	Sets the diameter of the circles.
void	setLocations(List<Point> value)	Sets the locations to highlight.
void	setStrokeThickness(float value)	Sets the stroke thickness to use.
String	strokeThicknessTipText()	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, 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_Locations

protected List<Point> m_Locations

the list of locations to highlight.

m_StrokeThickness

protected float m_StrokeThickness

the thickness of the stroke.

m_Diameter

protected int m_Diameter

the diameter of the circle.

m_Color

protected Color m_Color

the color of the circle.

Constructor Detail

HighlightLocations

public HighlightLocations()

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

setStrokeThickness

public void setStrokeThickness(float value)

Sets the stroke thickness to use.

Parameters:

value - the thickness

getStrokeThickness

public float getStrokeThickness()

Returns the current stroke thickness.

Returns:

the thickness

strokeThicknessTipText

public String strokeThicknessTipText()

Returns the tip text for this property.

Returns:

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

setDiameter

public void setDiameter(int value)

Sets the diameter of the circles.

Parameters:

value - the diameter in pixels

getDiameter

public int getDiameter()

Returns the diameter of the circles.

Returns:

the diameter in pixels

diameterTipText

public String diameterTipText()

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 circles.

Parameters:

value - the color

getColor

public Color getColor()

Returns the color of the circles.

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.

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractOptionHandler

setLocations

public void setLocations(List<Point> value)

Sets the locations to highlight.

Parameters:

value - the locations

getLocations

public List<Point> getLocations()

Returns the current locations that are being highlighted.

Returns:

the locations

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