Package adams.gui.visualization.heatmap.plugins

Class Histogram

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.AbstractSelectedHeatmapsViewerPluginWithGOE

adams.gui.visualization.heatmap.plugins.Histogram

All Implemented Interfaces:

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

public class Histogram
extends AbstractSelectedHeatmapsViewerPluginWithGOE

Displays the histogram for heatmap(s).

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected List<HistogramPanel>	m_HistogramList	the list of histogram panels.
protected List<String>	m_TitleList	the titles for the panels.

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

m_Editor

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

Method Summary

Modifier and Type	Method	Description
boolean	canExecute(HeatmapPanel panel)	Checks whether the plugin can be executed given the specified image panel.
protected String	createLogEntry()	Creates the log message.
protected boolean	getCanChangeClassInDialog()	Returns whether the class can be changed in the GOE.
String	getCaption()	Returns the text for the menu item to create.
protected Object	getDefaultValue()	Returns the default object to use in the GOE if no last setup is yet available.
protected Class	getEditorType()	Returns the class to use as type (= superclass) in the GOE.
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.AbstractSelectedHeatmapsViewerPluginWithGOE

createConfigurationPanel, hasApprovalButton, hasCancelButton

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

createDialog, createListPanel, doExecute, getAllPanels, getDialogSize, 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_HistogramList

protected List<HistogramPanel> m_HistogramList

the list of histogram panels.

m_TitleList

protected List<String> m_TitleList

the titles for the panels.

Constructor Detail

Histogram

public Histogram()

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

getCanChangeClassInDialog

protected boolean getCanChangeClassInDialog()

Returns whether the class can be changed in the GOE.

Overrides:

getCanChangeClassInDialog in class AbstractSelectedHeatmapsViewerPluginWithGOE

Returns:

true if class can be changed by the user

getEditorType

protected Class getEditorType()

Returns the class to use as type (= superclass) in the GOE.

Specified by:

getEditorType in class AbstractSelectedHeatmapsViewerPluginWithGOE

Returns:

the class

getDefaultValue

protected Object getDefaultValue()

Returns the default object to use in the GOE if no last setup is yet available.

Specified by:

getDefaultValue in class AbstractSelectedHeatmapsViewerPluginWithGOE

Returns:

the object

processInit

protected String processInit()

Initializes the processing.

Overrides:

processInit in class AbstractSelectedHeatmapsViewerPluginWithGOE

Returns:

null if successful, otherwise error message

See Also:

AbstractToolPlugin.setLastSetup(Object)

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

Finishes up the processing.

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