AppState class

Object to represent the application's state

This object represents the whole Pheasant Application State, and contains all functionality needed for controlling state in a pheasant application.

This object contains functionality to control state throughout an application, and also contains a list of ChangeWatchers to watch for changes throughout the cycle of an application.

The object can emit, receive, register changes and more for the application.

Inheritance

• Object
• State<PheasantTemplate>
• ElementState<PheasantTemplate>
• TemplateState
• AppState

Constructors

AppState({required PheasantTemplate component, List<ChangeWatcher> watchers = const [], PheasantTemplate? initState, PheasantTemplate? disposeState})

Properties

component ↔ PheasantTemplate

The component

getter/setter pair, inherited

componentState ↔ State<PheasantTemplate>

The initial state of the application

getter/setter pair, override

currentState → State<PheasantTemplate>

no setter

currentValue → PheasantTemplate

The current value of the variable

no setter, inherited

disposeState ↔ PheasantTemplate?

The disposing state

getter/setter pair, inherited

emitter ↔ ChangeEmitter

getter/setter pair, inherited

hashCode → int

The hash code for this object.

no setter, inherited

initState ↔ PheasantTemplate

The initial state of the component - used to initialise state in a pheasant component

getter/setter pair, inherited

initValue → PheasantTemplate

The initial value of the variable.

final, inherited

onPause → bool

Whether the state has been paused or not

no setter, inherited

previousValue → PheasantTemplate

The previous value of the variable

no setter, inherited

receiver ↔ ChangeReceiver

getter/setter pair, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

stateChange → StateChange<PheasantTemplate>

The current state change in an application

no setter

stateStream → Stream<StateChange<PheasantTemplate>>

Stream for listening to state changes

no setter, override

watchers ↔ List<ChangeWatcher>

The watchers used to watch changes in an application.

getter/setter pair, inherited-setter, override-getter

Methods

applyState() → void

Function used in making a copy of the current state of an object to be implemented elsewhere in code.

inherited

change(PheasantTemplate newValue, {StateChange<PheasantTemplate>? stateChange}) → void

Function used to change state.

inherited

dispose() → void

Function used in disposing current component state, and disposing of any broadcast streams used in the process.

inherited

emit(Event event, {PheasantTemplate? templateState}) → void

Function used to emit state changes in a PheasantTemplate object.

override

freeze() → void

Function used to freeze state.

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

receive<T>(StateChange stateChange, T refVariable) → void

Function used to receive state changes in a PheasantTemplate object.

override

registerWatcher<T>(State<T> variableState, T variable, {ChangeWatcher<T>? watcher}) → void

Function used to register and add a ChangeWatcher for the application

inherited

reload() → void

Function used to refresh or reload state.

override

removeWatcher<T>(ChangeWatcher watcher, {T? reference}) → void

Function used to remove a ChangeWatcher

inherited

toString() → String

A string representation of this object.

inherited

unfreeze() → void

Function used to unfreeze state.

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited