Package com.calebleavell.jatui.core

Class RunFrame

java.lang.Object

com.calebleavell.jatui.core.RunFrame

public class RunFrame
extends Object

Holds information required for a single scheduling unit of the application. In principle, the application runs module-by-module, so the primary data stored is module. Everything else (e.g., parent) is auxiliary information to help manage the run stack (created in TUIModule.start()).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	RunFrame.State	Signals to the scheduler how to manage this frame.

Field Summary

Fields

Modifier and Type	Field	Description
final TUIModule	displacedChild	This field signals that the running module is replacing the currentRunningChild of a TUIModule (provided by TUIModule.getCurrentRunningChild()) in order to be able to set it back.
final TUIModule	module	The TUIModule that will be running.
final TUIModule	parent	The TUIModule that is the parent of the module that will be running.
final RunFrame.State	state	The RunFrame.State state of the module; could be RunFrame.State.BEGIN or RunFrame.State.END.

Constructor Summary

Constructors

Constructor	Description
RunFrame(TUIModule module, TUIModule parent, RunFrame.State state)	Constructs a new RunFrame to store information for a scheduling unit.
RunFrame(TUIModule module, TUIModule parent, RunFrame.State state, TUIModule displacedChild)	Constructs a new RunFrame to store information for a scheduling unit.

Method Summary

Modifier and Type	Method	Description
String	toString()	Format: "(toRun: <module> | parent: <parent> | state: <state> | displacedChild: <displacedChild>)".

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

module

public final TUIModule module

The TUIModule that will be running.

parent

public final TUIModule parent

The TUIModule that is the parent of the module that will be running.

state

public final RunFrame.State state

The RunFrame.State state of the module; could be RunFrame.State.BEGIN or RunFrame.State.END.

displacedChild

public final TUIModule displacedChild

This field signals that the running module is replacing the currentRunningChild of a TUIModule (provided by TUIModule.getCurrentRunningChild()) in order to be able to set it back. This replacement happens when TUIModule.navigateTo(TUIModule.Builder) is called.

Constructor Details

RunFrame

public RunFrame(TUIModule module,
 TUIModule parent,
 RunFrame.State state)

Constructs a new RunFrame to store information for a scheduling unit.

Parameters:

module - The TUIModule that will be running.

parent - The TUIModule that is the parent of the module that will be running.

state - The RunFrame.State state of the module; could be RunFrame.State.BEGIN or RunFrame.State.END.

RunFrame

public RunFrame(TUIModule module,
 TUIModule parent,
 RunFrame.State state,
 TUIModule displacedChild)

Constructs a new RunFrame to store information for a scheduling unit.

Parameters:

module - The TUIModule that will be running.

parent - The TUIModule that is the parent of the module that will be running.

state - The RunFrame.State state of the module; could be RunFrame.State.BEGIN or RunFrame.State.END.

displacedChild - The currentRunningChild of parent if module is temporarily replacing it.

Method Details

toString

public String toString()

Format: "(toRun: <module> | parent: <parent> | state: <state> | displacedChild: <displacedChild>)".

Overrides:

toString in class Object

Returns:

the formatted string