Package adams.gui.visualization.object.overlay

Class SimplePointOverlayFromReport

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.object.overlay.AbstractOverlay

adams.gui.visualization.object.overlay.AbstractPointOverlayFromReport

adams.gui.visualization.object.overlay.SimplePointOverlayFromReport

All Implemented Interfaces:

CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Overlay, OverlayWithCustomAlphaSupport, Serializable

public class SimplePointOverlayFromReport
extends AbstractPointOverlayFromReport

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_Diameter	the diameter of the circle.

Fields inherited from class adams.gui.visualization.object.overlay.AbstractPointOverlayFromReport

m_CustomAlpha, m_CustomAlphaColorCache, m_CustomAlphaEnabled, m_LocationsUpdatedListeners, m_Overlays, PREFIX_DEFAULT

Fields inherited from class adams.gui.visualization.object.overlay.AbstractOverlay

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
String	diameterTipText()	Returns the tip text for this property.
protected void	doPaintObjects(ObjectAnnotationPanel panel, Graphics g, List<Polygon> locations)	Performs the actual painting of the objects.
int	getDiameter()	Returns the diameter to use for drawing the circle (if < 1 to draw an ellipse using the rectangle's dimensions).
String	globalInfo()	Returns a string describing the object.
void	setDiameter(int value)	Sets the diameter to use for drawing the circle (if < 1 to draw an ellipse using the rectangle's dimensions).

Methods inherited from class adams.gui.visualization.object.overlay.AbstractPointOverlayFromReport

addLocationsUpdatedListeners, annotationsChanged, applyAlpha, cleanUp, colorTipText, doPaint, getColor, getCustomAlpha, getLabelAnchor, getLabelFont, getLabelFormat, getLabelOffsetX, getLabelOffsetY, getPredefinedLabels, getPrefix, getTypeColor, getTypeColorProvider, getTypeRegExp, getTypeSuffix, getUseColorsPerType, hasTypeColor, initialize, isCustomAlphaEnabled, labelAnchorTipText, labelFontTipText, labelFormatTipText, labelOffsetXTipText, labelOffsetYTipText, notifyLocationsUpdatedListeners, predefinedLabelsTipText, prefixTipText, removeLocationsUpdatedListeners, setColor, setCustomAlpha, setCustomAlphaEnabled, setLabelAnchor, setLabelFont, setLabelFormat, setLabelOffsetX, setLabelOffsetY, setPredefinedLabels, setPrefix, setTypeColorProvider, setTypeRegExp, setTypeSuffix, setUseColorsPerType, typeColorProviderTipText, typeRegExpTipText, typeSuffixTipText, useColorsPerTypeTipText

Methods inherited from class adams.gui.visualization.object.overlay.AbstractOverlay

enabledTipText, getEnabled, paint, setEnabled

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

Methods inherited from interface adams.gui.visualization.object.overlay.Overlay

enabledTipText, getEnabled, paint, setEnabled

Field Detail

m_Diameter

protected int m_Diameter

the diameter of the circle.

Constructor Detail

SimplePointOverlayFromReport

public SimplePointOverlayFromReport()

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 AbstractPointOverlayFromReport

setDiameter

public void setDiameter(int value)

Sets the diameter to use for drawing the circle (if < 1 to draw an ellipse using the rectangle's dimensions).

Parameters:

value - the diameter, < 1 if using the rectangle's dimensions

getDiameter

public int getDiameter()

Returns the diameter to use for drawing the circle (if < 1 to draw an ellipse using the rectangle's dimensions).

Returns:

the diameter, < 1 if using the rectangle's dimensions

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.

doPaintObjects

protected void doPaintObjects(ObjectAnnotationPanel panel,
                              Graphics g,
                              List<Polygon> locations)

Performs the actual painting of the objects.

Specified by:

doPaintObjects in class AbstractPointOverlayFromReport

Parameters:

panel - the panel this overlay is for

g - the graphics context

locations - the locations to paint