Package adams.gui.visualization.heatmap.plugins

Class Notes

java.lang.Object

adams.core.logging.LoggingObject

adams.gui.plugin.AbstractToolPlugin<HeatmapPanel>

adams.gui.visualization.heatmap.plugins.AbstractHeatmapViewerPlugin

adams.gui.visualization.heatmap.plugins.AbstractSelectedHeatmapsViewerPlugin

adams.gui.visualization.heatmap.plugins.Notes

All Implemented Interfaces:

adams.core.logging.LoggingSupporter, adams.core.SizeOfHandler, Serializable

public class Notes
extends AbstractSelectedHeatmapsViewerPlugin

Displays the statistics about heatmaps.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected List<HeatmapContainer>	m_NotesList	the containers for the notes.

Fields inherited from class adams.gui.visualization.heatmap.plugins.AbstractSelectedHeatmapsViewerPlugin

m_SelectedPanels

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

Method Summary

Modifier and Type	Method	Description
boolean	canExecute(HeatmapPanel panel)	Checks whether the plugin can be executed given the specified image panel.
protected JPanel	createConfigurationPanel(adams.gui.dialog.ApprovalDialog dialog)	Creates the panel with the configuration (return null to suppress display).
protected String	createLogEntry()	Creates the log message.
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.
protected String	process(HeatmapPanel panel)	Processes the specified panel.
protected String	processFinish()	Finishes up the processing.
protected String	processInit()	Initializes the processing.

Methods inherited from class adams.gui.visualization.heatmap.plugins.AbstractSelectedHeatmapsViewerPlugin

createDialog, createListPanel, doExecute, getAllPanels, getDialogSize, hasApprovalButton, hasCancelButton, process

Methods inherited from class adams.gui.visualization.heatmap.plugins.AbstractHeatmapViewerPlugin

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

Field Detail

m_NotesList

protected List<HeatmapContainer> m_NotesList

the containers for the notes.

Constructor Detail

Notes

public Notes()

Method Detail

getMenu

public String getMenu()

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

Overrides:

getMenu in class adams.gui.plugin.AbstractToolPlugin<HeatmapPanel>

Returns:

the menu

getCaption

public String getCaption()

Returns the text for the menu item to create.

Specified by:

getCaption in class adams.gui.plugin.AbstractToolPlugin<HeatmapPanel>

Returns:

the text

getIconName

public String getIconName()

Returns the icon name.

Overrides:

getIconName in class adams.gui.plugin.AbstractToolPlugin<HeatmapPanel>

Returns:

the name, null if none available

canExecute

public boolean canExecute(HeatmapPanel panel)

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

Overrides:

canExecute in class AbstractSelectedHeatmapsViewerPlugin

Parameters:

panel - the panel to use as basis for decision

Returns:

true if plugin can be executed

createConfigurationPanel

protected JPanel createConfigurationPanel(adams.gui.dialog.ApprovalDialog dialog)

Creates the panel with the configuration (return null to suppress display).

Specified by:

createConfigurationPanel in class AbstractSelectedHeatmapsViewerPlugin

Parameters:

dialog - the dialog that is being created

Returns:

the generated panel, null to suppress

processInit

protected String processInit()

Initializes the processing.

Overrides:

processInit in class AbstractSelectedHeatmapsViewerPlugin

Returns:

null if successful, otherwise error message

process

protected String process(HeatmapPanel panel)

Processes the specified panel.

Specified by:

process in class AbstractSelectedHeatmapsViewerPlugin

Parameters:

panel - the panel to process

Returns:

null if successful, error message otherwise

processFinish

protected String processFinish()

Description copied from class: AbstractSelectedHeatmapsViewerPlugin

Finishes up the processing.

Default implementation returns null.

Overrides:

processFinish in class AbstractSelectedHeatmapsViewerPlugin

Returns:

null if successful, otherwise error message

createLogEntry

protected String createLogEntry()

Creates the log message.

Specified by:

createLogEntry in class adams.gui.plugin.AbstractToolPlugin<HeatmapPanel>

Returns:

the message, null if none available