Package adams.flow.core.displaytype

Class Default

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.core.displaytype.AbstractDisplayType

adams.flow.core.displaytype.Default

All Implemented Interfaces:

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

public class Default
extends AbstractDisplayType

Displays the frame on top of all windows.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_AutoFocus	whether the window will be automatically focused.

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

Method Summary

Modifier and Type	Method	Description
String	autoFocusTipText()	Returns the tip text for this property.
void	cleanUpGUI(AbstractDisplay actor)	Cleans up the GUI.
void	defineOptions()	Adds options to the internal list of options.
boolean	getAutoFocus()	Returns whether to automatically focus the display.
String	globalInfo()	Returns a string describing the object.
void	init(AbstractDisplay actor)	Initializes the use of the display.
void	setAutoFocus(boolean value)	Sets whether to automatically focus the display.
void	show(AbstractDisplay actor)	Shows the display.
void	updateOptions(AbstractDisplay actor)	Updates the options of the display actor, if necessary.
void	wrapUp(AbstractDisplay actor)	Performs wrap up operations.

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, 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_AutoFocus

protected boolean m_AutoFocus

whether the window will be automatically focused.

Constructor Detail

Default

public Default()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setAutoFocus

public void setAutoFocus(boolean value)

Sets whether to automatically focus the display.

Parameters:

value - true if focused

getAutoFocus

public boolean getAutoFocus()

Returns whether to automatically focus the display.

Returns:

true if focused

autoFocusTipText

public String autoFocusTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

updateOptions

public void updateOptions(AbstractDisplay actor)

Updates the options of the display actor, if necessary.

Specified by:

updateOptions in class AbstractDisplayType

Parameters:

actor - the actor to update

init

public void init(AbstractDisplay actor)

Initializes the use of the display.

Specified by:

init in class AbstractDisplayType

Parameters:

actor - the actor to display

show

public void show(AbstractDisplay actor)

Shows the display.

Specified by:

show in class AbstractDisplayType

Parameters:

actor - the actor to display

wrapUp

public void wrapUp(AbstractDisplay actor)

Performs wrap up operations.

Specified by:

wrapUp in class AbstractDisplayType

Parameters:

actor - the actor to wrap up

cleanUpGUI

public void cleanUpGUI(AbstractDisplay actor)

Cleans up the GUI.

Specified by:

cleanUpGUI in class AbstractDisplayType

Parameters:

actor - the actor to clean up