Package adams.gui.visualization.image.plugins

Class DisplayObjectLocationsFromReport

java.lang.Object

adams.core.logging.LoggingObject

adams.gui.plugin.AbstractToolPlugin<ImagePanel>

adams.gui.visualization.image.plugins.AbstractImageViewerPlugin

adams.gui.visualization.image.plugins.DisplayObjectLocationsFromReport

All Implemented Interfaces:

LoggingSupporter, SizeOfHandler, Serializable

public class DisplayObjectLocationsFromReport
extends AbstractImageViewerPlugin

Prompts user to select report with object locations to be overlayed.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.gui.plugin.AbstractToolPlugin

m_CanceledByUser, m_CurrentPanel, m_LastSetup

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
DisplayObjectLocationsFromReport()

Method Summary

Modifier and Type	Method	Description
boolean	canExecute(ImagePanel panel)	Checks whether the plugin can be executed given the specified image panel.
protected DefaultReportFileChooser	configureFileChooser(File file)	Configures the filechooser for selecting the report.
protected ObjectLocationsOverlayFromReport	configureOverlay()	Lets the user configure the overlay.
protected String	createLogEntry()	Creates the log message.
protected String	doExecute()	Executes the plugin.
String	getCaption()	Returns the text for the menu item to create.
String	getIconName()	Returns the icon name.
String	getMenu()	Returns the text for the menu to place the plugin beneath.

Methods inherited from class adams.gui.visualization.image.plugins.AbstractImageViewerPlugin

doLog

Methods inherited from class adams.gui.plugin.AbstractToolPlugin

execute, getCanceledByUser, getIcon, getLastSetup, hasLastSetup, log, setLastSetup

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, toString, wait, wait, wait

Constructor Detail

DisplayObjectLocationsFromReport

public DisplayObjectLocationsFromReport()

Method Detail

getMenu

public String getMenu()

Returns the text for the menu to place the plugin beneath.

Overrides:

getMenu in class AbstractToolPlugin<ImagePanel>

Returns:

the menu

getCaption

public String getCaption()

Returns the text for the menu item to create.

Specified by:

getCaption in class AbstractToolPlugin<ImagePanel>

Returns:

the text

getIconName

public String getIconName()

Returns the icon name.

Overrides:

getIconName in class AbstractToolPlugin<ImagePanel>

Returns:

the name, null if none available

canExecute

public boolean canExecute(ImagePanel panel)

Checks whether the plugin can be executed given the specified image panel.

Specified by:

canExecute in class AbstractToolPlugin<ImagePanel>

Parameters:

panel - the panel to use as basis for decision

Returns:

true if plugin can be executed

createLogEntry

protected String createLogEntry()

Creates the log message.

Specified by:

createLogEntry in class AbstractToolPlugin<ImagePanel>

Returns:

always null

configureOverlay

protected ObjectLocationsOverlayFromReport configureOverlay()

Lets the user configure the overlay.

Returns:

the configured overlay, null if user cancelled

configureFileChooser

protected DefaultReportFileChooser configureFileChooser(File file)

Configures the filechooser for selecting the report.

Parameters:

file - the current image file

Returns:

the filechooser

doExecute

protected String doExecute()

Executes the plugin.

Specified by:

doExecute in class AbstractToolPlugin<ImagePanel>

Returns:

null if OK, otherwise error message