Package adams.gui.visualization.image

Class ReportPointOverlay

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.image.AbstractReportBasedOverlayHelper

adams.gui.visualization.image.ReportPointOverlay

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Serializable

public class ReportPointOverlay
extends AbstractReportBasedOverlayHelper

Ancestor for overlays that use point locations from a report.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	PREFIX_DEFAULT	the default prefix.

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

m_AllObjects, m_Color, m_Colors, m_FilteredObjects, m_LabelAnchor, m_LabelFont, m_LabelFormat, m_LabelOffsetX, m_LabelOffsetY, m_Labels, m_Locations, m_ObjectLocationMappings, m_PredefinedLabels, m_Prefix, m_TypeColorProvider, m_TypeColors, m_TypeRegExp, m_TypeSuffix, m_UseColorsPerType

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

Method Summary

Modifier and Type	Method	Description
boolean	determineLocations(Report report, LocatedObjectFilter filter)	Determines the locations of the objects.
protected String	getDefaultPrefix()	Returns the default prefix for the objects in the report.
String	globalInfo()	Returns a string describing the object.

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

applyFormatOptions, applyLabelFormat, calcStringDimenions, colorTipText, defineOptions, determineLocations, determineTypeSuffix, drawString, getAllObjects, getColor, getColor, getFilteredObjects, getLabel, getLabelAnchor, getLabelFont, getLabelFormat, getLabelOffsetX, getLabelOffsetY, getLocations, getObjectLocationMappings, getPredefinedLabels, getPrefix, getTypeColor, getTypeColorProvider, getTypeRegExp, getTypeSuffix, getUseColorsPerType, hasAllObjects, hasColor, hasFilteredObjects, hasLabel, hasLocations, hasObjectLocationMappings, hasTypeColor, labelAnchorTipText, labelFontTipText, labelFormatTipText, labelOffsetXTipText, labelOffsetYTipText, predefinedLabelsTipText, prefixTipText, reset, setColor, setLabelAnchor, setLabelFont, setLabelFormat, setLabelOffsetX, setLabelOffsetY, setPredefinedLabels, setPrefix, setTypeColorProvider, setTypeRegExp, setTypeSuffix, setUseColorsPerType, typeColorProviderTipText, typeRegExpTipText, typeSuffixTipText, useColorsPerTypeTipText

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, 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.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

PREFIX_DEFAULT

public static final String PREFIX_DEFAULT

the default prefix.

See Also:

Constant Field Values

Constructor Detail

ReportPointOverlay

public ReportPointOverlay()

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

getDefaultPrefix

protected String getDefaultPrefix()

Returns the default prefix for the objects in the report.

Specified by:

getDefaultPrefix in class AbstractReportBasedOverlayHelper

Returns:

the default

determineLocations

public boolean determineLocations(Report report,
                                  LocatedObjectFilter filter)

Determines the locations of the objects.

Specified by:

determineLocations in class AbstractReportBasedOverlayHelper

Parameters:

report - the report to inspect

Returns:

true if updated