Package adams.gui.tools.spreadsheetviewer

Class AbstractSelectedSheetsDataPlugin

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.tools.spreadsheetviewer.AbstractDataPlugin

adams.gui.tools.spreadsheetviewer.AbstractSelectedSheetsDataPlugin

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<AbstractDataPlugin>, SizeOfHandler, Serializable

Direct Known Subclasses:

AbstractSelectedSheetsDataPluginWithGOE, Append

public abstract class AbstractSelectedSheetsDataPlugin
extends AbstractDataPlugin

Ancestor for plugins that operate on multiple panels.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected SpreadSheetPanel[]	m_SelectedPanels	for panels to work on.

Fields inherited from class adams.gui.tools.spreadsheetviewer.AbstractDataPlugin

m_CanceledByUser, m_CurrentPanel, m_LastSetup

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

Method Summary

Modifier and Type	Method	Description
protected abstract JPanel	createConfigurationPanel(ApprovalDialog dialog)	Creates the panel with the configuration (return null to suppress display).
protected ApprovalDialog	createDialog()	Creates the dialog to display.
protected JPanel	createListPanel(ApprovalDialog dialog)	Creates the panel containing the list of all images.
protected SpreadSheet	doProcess(SpreadSheet sheet)	Executes the plugin.
protected SpreadSheetPanel[]	getAllPanels()	Returns all the available panels in the image viewer.
protected Dimension	getDialogSize()	Returns the size of the dialog.
protected boolean	hasApprovalButton()	Returns whether the dialog has an approval button.
protected boolean	hasCancelButton()	Returns whether the dialog has a cancel button.
protected abstract SpreadSheet	process()	Processes all the selected panels.

Methods inherited from class adams.gui.tools.spreadsheetviewer.AbstractDataPlugin

canProcess, check, getCanceledByUser, getCurrentPanel, getLastSetup, getMenuIcon, getMenuText, getPlugins, hasLastSetup, isInPlace, process, setCurrentPanel, setLastSetup, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_SelectedPanels

protected SpreadSheetPanel[] m_SelectedPanels

for panels to work on.

Constructor Detail

AbstractSelectedSheetsDataPlugin

public AbstractSelectedSheetsDataPlugin()

Method Detail

getAllPanels

protected SpreadSheetPanel[] getAllPanels()

Returns all the available panels in the image viewer.

Returns:

the available panels

createListPanel

protected JPanel createListPanel(ApprovalDialog dialog)

Creates the panel containing the list of all images. Also updates the m_SelectedPanels property.

Parameters:

dialog - the dialog that is being created

Returns:

the generated panel

createConfigurationPanel

protected abstract JPanel createConfigurationPanel(ApprovalDialog dialog)

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

Parameters:

dialog - the dialog that is being created

Returns:

the generated panel, null to suppress

getDialogSize

protected Dimension getDialogSize()

Returns the size of the dialog.

Returns:

the size

hasApprovalButton

protected boolean hasApprovalButton()

Returns whether the dialog has an approval button.

Returns:

true if approval button visible

hasCancelButton

protected boolean hasCancelButton()

Returns whether the dialog has a cancel button.

Returns:

true if cancel button visible

createDialog

protected ApprovalDialog createDialog()

Creates the dialog to display.

Returns:

the dialog

process

protected abstract SpreadSheet process()

Processes all the selected panels.

Returns:

spreadsheet if successful, otherwise null

doProcess

protected SpreadSheet doProcess(SpreadSheet sheet)

Executes the plugin.

Specified by:

doProcess in class AbstractDataPlugin

Parameters:

sheet - the sheet to process

Returns:

null if OK, otherwise error message