Package adams.flow.execution

Class AbstractGraphicalFlowExecutionListener

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.execution.AbstractFlowExecutionListener

adams.flow.execution.AbstractGraphicalFlowExecutionListener

All Implemented Interfaces:

CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<FlowExecutionListener>, SizeOfHandler, FlowExecutionListener, GraphicalFlowExecutionListener, Serializable, Comparable

Direct Known Subclasses:

AbstractFlowExecutionListenerWithTable, Debug

public abstract class AbstractGraphicalFlowExecutionListener
extends AbstractFlowExecutionListener
implements GraphicalFlowExecutionListener

Ancestor for graphical listeners.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected BasePanel	m_ListenerPanel	the listener panel.

Fields inherited from class adams.flow.execution.AbstractFlowExecutionListener

m_Owner

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

Method Summary

Modifier and Type	Method	Description
void	finishListening()	Gets called when the flow execution ends.
Dimension	getDefaultFrameSize()	Returns the default size for the frame.
boolean	getDisposeOnFinish()	Returns whether the frame should get disposed when the flow finishes.
abstract BasePanel	newListenerPanel()	Returns the panel to use.
BasePanel	newListenerPanelIfNecessary()	Returns a new panel if necessary.
protected abstract void	updateGUI()	Updates the GUI.

Methods inherited from class adams.flow.execution.AbstractFlowExecutionListener

cleanUp, compareTo, equals, getListeners, getOwner, postExecute, postInput, postOutput, preExecute, preInput, preOutput, setOwner, shallowCopy, shallowCopy, startListening

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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.CleanUpHandler

cleanUp

Methods inherited from interface adams.flow.execution.FlowExecutionListener

getOwner, postExecute, postInput, postOutput, preExecute, preInput, preOutput, setOwner, startListening

Methods inherited from interface adams.flow.execution.GraphicalFlowExecutionListener

getListenerTitle

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_ListenerPanel

protected BasePanel m_ListenerPanel

the listener panel.

Constructor Detail

AbstractGraphicalFlowExecutionListener

public AbstractGraphicalFlowExecutionListener()

Method Detail

newListenerPanelIfNecessary

public BasePanel newListenerPanelIfNecessary()

Returns a new panel if necessary.

Specified by:

newListenerPanelIfNecessary in interface GraphicalFlowExecutionListener

Returns:

the control panel

newListenerPanel

public abstract BasePanel newListenerPanel()

Returns the panel to use.

Specified by:

newListenerPanel in interface GraphicalFlowExecutionListener

Returns:

the panel, null if none available

getDefaultFrameSize

public Dimension getDefaultFrameSize()

Returns the default size for the frame.

Specified by:

getDefaultFrameSize in interface GraphicalFlowExecutionListener

Returns:

the frame size

getDisposeOnFinish

public boolean getDisposeOnFinish()

Returns whether the frame should get disposed when the flow finishes.

Default implementation returns false.

Specified by:

getDisposeOnFinish in interface GraphicalFlowExecutionListener

Returns:

true if to dispose when flow finishes

updateGUI

protected abstract void updateGUI()

Updates the GUI.

finishListening

public void finishListening()

Gets called when the flow execution ends.

Also updates the GUI for a final time.

Specified by:

finishListening in interface FlowExecutionListener

Overrides:

finishListening in class AbstractFlowExecutionListener