java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.gui.tools.previewbrowser.AbstractContentHandler
      - adams.gui.tools.previewbrowser.PointsFromReportHandler

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, ContentHandler, Serializable
```
public class PointsFromReportHandler
extends AbstractContentHandler
```
Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

class PointsFromReportHandler.CombinedPanel
The panel for displaying the image.

Field Summary

Fields
Modifier and Type	Field	Description
`protected PlaceholderDirectory`	`m_AlternativeLocation`	the alternative location.
`protected Color`	`m_Color`	the color for the objects.
`protected int`	`m_Diameter`	the diameter of the circle.
`protected ObjectFinder`	`m_Finder`	the object finder to use.
`protected ImageAnchor`	`m_LabelAnchor`	the label anchor.
`protected Font`	`m_LabelFont`	the label font.
`protected String`	`m_LabelFormat`	the label for the points.
`protected int`	`m_LabelOffsetX`	the x offset for the label.
`protected int`	`m_LabelOffsetY`	the y offset for the label.
`protected BaseString[]`	`m_PredefinedLabels`	the predefined labels.
`protected String`	`m_Prefix`	the prefix for the objects in the report.
`protected boolean`	`m_ShowPointPanel`	whether to show the located object panel.
`protected ColorProvider`	`m_TypeColorProvider`	the color provider to use.
`protected BaseRegExp`	`m_TypeRegExp`	the regular expression for the types to draw.
`protected String`	`m_TypeSuffix`	the suffix for the type.
`protected boolean`	`m_UseAlternativeLocation`	whether to use an alternative location for the reports.
`protected boolean`	`m_UseColorsPerType`	whether to use colors per type.

Fields inherited from class adams.gui.tools.previewbrowser.AbstractContentHandler
m_Relation

Fields inherited from class adams.core.option.AbstractOptionHandler
m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject
m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Fields inherited from interface adams.gui.tools.previewbrowser.ContentHandler
MATCH_ALL

Constructor Summary

Constructors
Constructor Description

PointsFromReportHandler()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`alternativeLocationTipText()`	Returns the tip text for this property.
`String`	`colorTipText()`	Returns the tip text for this property.
`PreviewPanel`	`createPreview(File file)`	Creates the actual view.
`void`	`defineOptions()`	Adds options to the internal list of options.
`String`	`diameterTipText()`	Returns the tip text for this property.
`protected Report`	`filterReport(Report report)`	Filters the objects in the report, if necessary.
`String`	`finderTipText()`	Returns the tip text for this property.
`PlaceholderDirectory`	`getAlternativeLocation()`	Returns the alternative location to use for the reports.
`Color`	`getColor()`	Returns the color to use for the objects.
`protected ImageAnchor`	`getDefaultLabelAnchor()`	Returns the default label anchor.
`protected int`	`getDefaultLabelOffsetX()`	Returns the default label offset for X.
`protected int`	`getDefaultLabelOffsetY()`	Returns the default label offset for Y.
`int`	`getDiameter()`	Returns the diameter to use for drawing the circle.
`String[]`	`getExtensions()`	Returns the list of extensions (without dot) that this handler can take care of.
`ObjectFinder`	`getFinder()`	Returns the finder to use for locating the objects.
`ImageAnchor`	`getLabelAnchor()`	Returns the anchor for the label.
`Font`	`getLabelFont()`	Returns the label font.
`String`	`getLabelFormat()`	Returns the label format.
`int`	`getLabelOffsetX()`	Returns the X offset for the label.
`int`	`getLabelOffsetY()`	Returns the Y offset for the label.
`BaseString[]`	`getPredefinedLabels()`	Returns the predefined labels.
`String`	`getPrefix()`	Returns the prefix to use for the objects in the report.
`boolean`	`getShowPointPanel()`	Returns whether to show the panel with the located points.
`ColorProvider`	`getTypeColorProvider()`	Returns the color provider to use for the types.
`BaseRegExp`	`getTypeRegExp()`	Returns the regular expression that the types must match in order to get drawn.
`String`	`getTypeSuffix()`	Returns the suffix to use for the types.
`boolean`	`getUseAlternativeLocation()`	Returns whether to use an alternative location for the reports.
`boolean`	`getUseColorsPerType()`	Returns whether to use colors per type.
`String`	`globalInfo()`	Returns a string describing the object.
`String`	`labelAnchorTipText()`	Returns the tip text for this property.
`String`	`labelFontTipText()`	Returns the tip text for this property.
`String`	`labelFormatTipText()`	Returns the tip text for this property.
`String`	`labelOffsetXTipText()`	Returns the tip text for this property.
`String`	`labelOffsetYTipText()`	Returns the tip text for this property.
`protected Report`	`loadReport(PointsFromReportHandler.CombinedPanel panel, File file)`	Loads the report associated with the image file.
`String`	`predefinedLabelsTipText()`	Returns the tip text for this property.
`String`	`prefixTipText()`	Returns the tip text for this property.
`PreviewPanel`	`reusePreview(File file, PreviewPanel previewPanel)`	Reuses the last preview, if possible.
`void`	`setAlternativeLocation(PlaceholderDirectory value)`	Sets the alternative location to use for the reports.
`void`	`setColor(Color value)`	Sets the color to use for the objects.
`void`	`setDiameter(int value)`	Sets the diameter to use for drawing the circle.
`void`	`setFinder(ObjectFinder value)`	Sets the finder to use for locating the objects.
`void`	`setLabelAnchor(ImageAnchor value)`	Sets the anchor for the label.
`void`	`setLabelFont(Font value)`	Sets the label font.
`void`	`setLabelFormat(String value)`	Sets the label format.
`void`	`setLabelOffsetX(int value)`	Sets the X offset for the label.
`void`	`setLabelOffsetY(int value)`	Sets the Y offset for the label.
`void`	`setPredefinedLabels(BaseString[] value)`	Sets the predefined labels.
`void`	`setPrefix(String value)`	Sets the prefix to use for the objects in the report.
`void`	`setShowPointPanel(boolean value)`	Sets whether to show the panel with the located points.
`void`	`setTypeColorProvider(ColorProvider value)`	Sets the color provider to use for the types.
`void`	`setTypeRegExp(BaseRegExp value)`	Sets the regular expression that the types must match in order to get drawn.
`void`	`setTypeSuffix(String value)`	Sets the suffix to use for the types.
`void`	`setUseAlternativeLocation(boolean value)`	Sets whether to use an alternative location for the reports.
`void`	`setUseColorsPerType(boolean value)`	Sets whether to use colors per type.
`String`	`showPointPanelTipText()`	Returns the tip text for this property.
`String`	`typeColorProviderTipText()`	Returns the tip text for this property.
`String`	`typeRegExpTipText()`	Returns the tip text for this property.
`String`	`typeSuffixTipText()`	Returns the tip text for this property.
`String`	`useAlternativeLocationTipText()`	Returns the tip text for this property.
`String`	`useColorsPerTypeTipText()`	Returns the tip text for this property.

Methods inherited from class adams.gui.tools.previewbrowser.AbstractContentHandler
checkFile, getHandlers, getHandlersForFile, getHandlersForFile, getPreview, getRelation, hasHandler, hasHandler

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_Prefix
```
protected String m_Prefix
```
    the prefix for the objects in the report.
  - m_Diameter
```
protected int m_Diameter
```
    the diameter of the circle.
  - m_Color
```
protected Color m_Color
```
    the color for the objects.
  - m_UseColorsPerType
```
protected boolean m_UseColorsPerType
```
    whether to use colors per type.
  - m_TypeColorProvider
```
protected ColorProvider m_TypeColorProvider
```
    the color provider to use.
  - m_TypeSuffix
```
protected String m_TypeSuffix
```
    the suffix for the type.
  - m_TypeRegExp
```
protected BaseRegExp m_TypeRegExp
```
    the regular expression for the types to draw.
  - m_LabelFormat
```
protected String m_LabelFormat
```
    the label for the points.
  - m_LabelFont
```
protected Font m_LabelFont
```
    the label font.
  - m_LabelAnchor
```
protected ImageAnchor m_LabelAnchor
```
    the label anchor.
  - m_LabelOffsetX
```
protected int m_LabelOffsetX
```
    the x offset for the label.
  - m_LabelOffsetY
```
protected int m_LabelOffsetY
```
    the y offset for the label.
  - m_PredefinedLabels
```
protected BaseString[] m_PredefinedLabels
```
    the predefined labels.
  - m_Finder
```
protected ObjectFinder m_Finder
```
    the object finder to use.
  - m_UseAlternativeLocation
```
protected boolean m_UseAlternativeLocation
```
    whether to use an alternative location for the reports.
  - m_AlternativeLocation
```
protected PlaceholderDirectory m_AlternativeLocation
```
    the alternative location.
  - m_ShowPointPanel
```
protected boolean m_ShowPointPanel
```
    whether to show the located object panel.
- Constructor Detail
  - PointsFromReportHandler
```
public PointsFromReportHandler()
```
- 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 AbstractOptionHandler
  - setPrefix
```
public void setPrefix(String value)
```
    Sets the prefix to use for the objects in the report.
    
    Parameters:
    
    value - the prefix
  - getPrefix
```
public String getPrefix()
```
    Returns the prefix to use for the objects in the report.
    
    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.
  - setDiameter
```
public void setDiameter(int value)
```
    Sets the diameter to use for drawing the circle.
    
    Parameters:
    
    value - the diameter
  - getDiameter
```
public int getDiameter()
```
    Returns the diameter to use for drawing the circle.
    
    Returns:
    
    the diameter
  - 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 to use for the objects.
    
    Parameters:
    
    value - the color
  - getColor
```
public Color getColor()
```
    Returns the color to use for the objects.
    
    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.
  - setUseColorsPerType
```
public void setUseColorsPerType(boolean value)
```
    Sets whether to use colors per type.
    
    Parameters:
    
    value - true if to use colors per type
  - getUseColorsPerType
```
public boolean getUseColorsPerType()
```
    Returns whether to use colors per type.
    
    Returns:
    
    true if to use colors per type
  - useColorsPerTypeTipText
```
public String useColorsPerTypeTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setTypeColorProvider
```
public void setTypeColorProvider(ColorProvider value)
```
    Sets the color provider to use for the types.
    
    Parameters:
    
    value - the provider
  - getTypeColorProvider
```
public ColorProvider getTypeColorProvider()
```
    Returns the color provider to use for the types.
    
    Returns:
    
    the provider
  - typeColorProviderTipText
```
public String typeColorProviderTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setTypeSuffix
```
public void setTypeSuffix(String value)
```
    Sets the suffix to use for the types.
    
    Parameters:
    
    value - the suffix
  - getTypeSuffix
```
public String getTypeSuffix()
```
    Returns the suffix to use for the types.
    
    Returns:
    
    the suffix
  - typeSuffixTipText
```
public String typeSuffixTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setTypeRegExp
```
public void setTypeRegExp(BaseRegExp value)
```
    Sets the regular expression that the types must match in order to get drawn.
    
    Parameters:
    
    value - the expression
  - getTypeRegExp
```
public BaseRegExp getTypeRegExp()
```
    Returns the regular expression that the types must match in order to get drawn.
    
    Returns:
    
    the expression
  - typeRegExpTipText
```
public String typeRegExpTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setLabelFormat
```
public void setLabelFormat(String value)
```
    Sets the label format.
    
    Parameters:
    
    value - the label format
  - getLabelFormat
```
public String getLabelFormat()
```
    Returns the label format.
    
    Returns:
    
    the label format
  - labelFormatTipText
```
public String labelFormatTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setLabelFont
```
public void setLabelFont(Font value)
```
    Sets the label font.
    
    Parameters:
    
    value - the label font
  - getLabelFont
```
public Font getLabelFont()
```
    Returns the label font.
    
    Returns:
    
    the label font
  - labelFontTipText
```
public String labelFontTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - getDefaultLabelAnchor
```
protected ImageAnchor getDefaultLabelAnchor()
```
    Returns the default label anchor.
    
    Returns:
    
    the default
  - setLabelAnchor
```
public void setLabelAnchor(ImageAnchor value)
```
    Sets the anchor for the label.
    
    Parameters:
    
    value - the anchor
  - getLabelAnchor
```
public ImageAnchor getLabelAnchor()
```
    Returns the anchor for the label.
    
    Returns:
    
    the anchor
  - labelAnchorTipText
```
public String labelAnchorTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - getDefaultLabelOffsetX
```
protected int getDefaultLabelOffsetX()
```
    Returns the default label offset for X.
    
    Returns:
    
    the default
  - setLabelOffsetX
```
public void setLabelOffsetX(int value)
```
    Sets the X offset for the label.
    
    Parameters:
    
    value - the X offset
  - getLabelOffsetX
```
public int getLabelOffsetX()
```
    Returns the X offset for the label.
    
    Returns:
    
    the X offset
  - labelOffsetXTipText
```
public String labelOffsetXTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - getDefaultLabelOffsetY
```
protected int getDefaultLabelOffsetY()
```
    Returns the default label offset for Y.
    
    Returns:
    
    the default
  - setLabelOffsetY
```
public void setLabelOffsetY(int value)
```
    Sets the Y offset for the label.
    
    Parameters:
    
    value - the Y offset
  - getLabelOffsetY
```
public int getLabelOffsetY()
```
    Returns the Y offset for the label.
    
    Returns:
    
    the Y offset
  - labelOffsetYTipText
```
public String labelOffsetYTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setPredefinedLabels
```
public void setPredefinedLabels(BaseString[] value)
```
    Sets the predefined labels.
    
    Parameters:
    
    value - the labels
  - getPredefinedLabels
```
public BaseString[] getPredefinedLabels()
```
    Returns the predefined labels.
    
    Returns:
    
    the labels
  - predefinedLabelsTipText
```
public String predefinedLabelsTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setFinder
```
public void setFinder(ObjectFinder value)
```
    Sets the finder to use for locating the objects.
    
    Parameters:
    
    value - the finder
  - getFinder
```
public ObjectFinder getFinder()
```
    Returns the finder to use for locating the objects.
    
    Returns:
    
    the finder
  - finderTipText
```
public String finderTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setUseAlternativeLocation
```
public void setUseAlternativeLocation(boolean value)
```
    Sets whether to use an alternative location for the reports.
    
    Parameters:
    
    value - true if to use
  - getUseAlternativeLocation
```
public boolean getUseAlternativeLocation()
```
    Returns whether to use an alternative location for the reports.
    
    Returns:
    
    true if to use
  - useAlternativeLocationTipText
```
public String useAlternativeLocationTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setAlternativeLocation
```
public void setAlternativeLocation(PlaceholderDirectory value)
```
    Sets the alternative location to use for the reports.
    
    Parameters:
    
    value - the location
  - getAlternativeLocation
```
public PlaceholderDirectory getAlternativeLocation()
```
    Returns the alternative location to use for the reports.
    
    Returns:
    
    the location
  - alternativeLocationTipText
```
public String alternativeLocationTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setShowPointPanel
```
public void setShowPointPanel(boolean value)
```
    Sets whether to show the panel with the located points.
    
    Parameters:
    
    value - true if to show
  - getShowPointPanel
```
public boolean getShowPointPanel()
```
    Returns whether to show the panel with the located points.
    
    Returns:
    
    true if to show
  - showPointPanelTipText
```
public String showPointPanelTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - getExtensions
```
public String[] getExtensions()
```
    Returns the list of extensions (without dot) that this handler can take care of.
    
    Returns:
    
    the list of extensions (no dot)
  - filterReport
```
protected Report filterReport(Report report)
```
    Filters the objects in the report, if necessary.
    
    Parameters:
    
    report - the report to filter
    
    Returns:
    
    the filtered report (copy, in case filtering occurred)
  - loadReport
```
protected Report loadReport(PointsFromReportHandler.CombinedPanel panel,
                            File file)
```
    Loads the report associated with the image file.
    
    Parameters:
    
    panel - the context panel
    
    file - the image file
    
    Returns:
    
    the report, null if not present or failed to load
  - createPreview
```
public PreviewPanel createPreview(File file)
```
    Creates the actual view.
    
    Specified by:
    
    createPreview in interface ContentHandler
    
    Specified by:
    
    createPreview in class AbstractContentHandler
    
    Parameters:
    
    file - the file to create the view for
    
    Returns:
    
    the view
  - reusePreview
```
public PreviewPanel reusePreview(File file,
                                 PreviewPanel previewPanel)
```
    Reuses the last preview, if possible.
    
    Specified by:
    
    reusePreview in interface ContentHandler
    
    Overrides:
    
    reusePreview in class AbstractContentHandler
    
    Parameters:
    
    file - the file to create the view for
    
    Returns:
    
    the view

Class PointsFromReportHandler

Nested Class Summary

Field Summary

Fields inherited from class adams.gui.tools.previewbrowser.AbstractContentHandler

Fields inherited from class adams.core.option.AbstractOptionHandler

Fields inherited from class adams.core.logging.LoggingObject

Fields inherited from interface adams.gui.tools.previewbrowser.ContentHandler

Constructor Summary

Method Summary

Methods inherited from class adams.gui.tools.previewbrowser.AbstractContentHandler

Methods inherited from class adams.core.option.AbstractOptionHandler

Methods inherited from class adams.core.logging.LoggingObject

Methods inherited from class java.lang.Object

Methods inherited from interface adams.core.Destroyable

Methods inherited from interface adams.core.logging.LoggingLevelHandler

Methods inherited from interface adams.core.option.OptionHandler

Field Detail

m_Prefix

m_Diameter

m_Color

m_UseColorsPerType

m_TypeColorProvider

m_TypeSuffix

m_TypeRegExp

m_LabelFormat

m_LabelFont

m_LabelAnchor

m_LabelOffsetX

m_LabelOffsetY

m_PredefinedLabels

m_Finder

m_UseAlternativeLocation

m_AlternativeLocation

m_ShowPointPanel

Constructor Detail

PointsFromReportHandler

Method Detail

globalInfo

defineOptions

setPrefix

getPrefix

prefixTipText

setDiameter

getDiameter

diameterTipText

setColor

getColor

colorTipText

setUseColorsPerType

getUseColorsPerType

useColorsPerTypeTipText

setTypeColorProvider

getTypeColorProvider

typeColorProviderTipText

setTypeSuffix

getTypeSuffix

typeSuffixTipText

setTypeRegExp

getTypeRegExp

typeRegExpTipText

setLabelFormat

getLabelFormat

labelFormatTipText

setLabelFont

getLabelFont

labelFontTipText

getDefaultLabelAnchor

setLabelAnchor

getLabelAnchor

labelAnchorTipText

getDefaultLabelOffsetX

setLabelOffsetX

getLabelOffsetX

labelOffsetXTipText

getDefaultLabelOffsetY

setLabelOffsetY

getLabelOffsetY

labelOffsetYTipText

setPredefinedLabels

getPredefinedLabels