AbstractImageViewerPluginWithGOE (adams-pom 24.5.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.gui.plugin.AbstractToolPlugin<ImagePanel>
  - - adams.gui.visualization.image.plugins.AbstractImageViewerPlugin
    - - adams.gui.visualization.image.plugins.AbstractImageViewerPluginWithGOE

All Implemented Interfaces:

LoggingSupporter, SizeOfHandler, Serializable

Direct Known Subclasses:

Barcode, BoofCVDetectLines, BoofCVDetectLineSegments, ImageFileMetaData
```
public abstract class AbstractImageViewerPluginWithGOE
extends AbstractImageViewerPlugin
```
Ancestor for plugins that require a GOE.

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

AbstractImageViewerPluginWithGOE()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected String`	`doExecute()`	Executes the plugin.
`protected boolean`	`getCanChangeClassInDialog()`	Returns whether the class can be changed in the GOE.
`protected abstract Object`	`getDefaultValue()`	Returns the default object to use in the GOE if no last setup is yet available.
`protected Dimension`	`getDialogSize()`	Returns the size of the dialog.
`protected abstract Class`	`getEditorType()`	Returns the class to use as type (= superclass) in the GOE.
`protected abstract String`	`process()`	Processes the image.

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

Methods inherited from class adams.gui.plugin.AbstractToolPlugin
canExecute, createLogEntry, execute, getCanceledByUser, getCaption, getIcon, getIconName, getLastSetup, getMenu, 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
  - AbstractImageViewerPluginWithGOE
```
public AbstractImageViewerPluginWithGOE()
```
- Method Detail
  - getEditorType
```
protected abstract Class getEditorType()
```
    Returns the class to use as type (= superclass) in the GOE.
    
    Returns:
    
    the class
  - getDefaultValue
```
protected abstract Object getDefaultValue()
```
    Returns the default object to use in the GOE if no last setup is yet available.
    
    Returns:
    
    the object
  - getCanChangeClassInDialog
```
protected boolean getCanChangeClassInDialog()
```
    Returns whether the class can be changed in the GOE.
    
    Returns:
    
    true if class can be changed by the user
  - getDialogSize
```
protected Dimension getDialogSize()
```
    Returns the size of the dialog.
    
    Returns:
    
    the size
  - process
```
protected abstract String process()
```
    Processes the image.
  - doExecute
```
protected String doExecute()
```
    Executes the plugin.
    
    Specified by:
    
    doExecute in class AbstractToolPlugin<ImagePanel>
    
    Returns:
    
    null if OK, otherwise error message. Using an empty string will suppress the error message display and the creation of a log entry.