AbstractEncloseActor (adams-pom 24.5.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.gui.flow.tree.enclose.AbstractEncloseActor

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Serializable

Direct Known Subclasses:

ArrayDisplayEnclosure, DisplayPanelManagerEnclosure, TryCatchEnclosure
```
public abstract class AbstractEncloseActor
extends AbstractOptionHandler
```
Ancestor for classes that can enclose actors somehow.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected static Logger LOGGER
the logger for static methods.
- 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

AbstractEncloseActor()

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected abstract boolean`	`canEnclose(StateContainer state)`	Checks whether this enclose suggestion is available.
`abstract JMenuItem`	`enclose(StateContainer state)`	Returns a menu item that will perform the enclosing if selected.
`static JMenuItem[]`	`encloseAll(StateContainer state)`	Generates all the possible enclose menu items.

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
  - LOGGER
```
protected static Logger LOGGER
```
    the logger for static methods.
- Constructor Detail
  - AbstractEncloseActor
```
public AbstractEncloseActor()
```
- Method Detail
  - canEnclose
```
protected abstract boolean canEnclose(StateContainer state)
```
    Checks whether this enclose suggestion is available.
    
    Parameters:
    
    state - the current state
    
    Returns:
    
    true if enclosing is possible
  - enclose
```
public abstract JMenuItem enclose(StateContainer state)
```
    Returns a menu item that will perform the enclosing if selected.
    
    Parameters:
    
    state - the current state
    
    Returns:
    
    the list of potential swaps
  - encloseAll
```
public static JMenuItem[] encloseAll(StateContainer state)
```
    Generates all the possible enclose menu items.
    
    Parameters:
    
    state - the current state
    
    Returns:
    
    the list of potential swaps