BasePageState<T extends BasePage> class

A base class for providing all pages in the app with a collection of shared functions and variables. In large part, this was implemented to define shortcuts for common lengthy methods across UI code.

Inheritance
Implementers

Constructors

BasePageState()

Properties

appModel → AppModel
Access the global model responsible for app-wide state management.
read-only
appModelNoUpdate → AppModel
Access the global model responsible for app-wide state management without listening to state updates. Useful when accessing state from initState.
read-only
context → BuildContext
The location in the tree where this widget builds.
read-onlyinherited
creatorModel → CreatorModel
Access the global model responsible for creator state management.
read-only
creatorModelNoUpdate → CreatorModel
Access the global model responsible for creator state management. without listening to state updates. Useful when accessing state from initState.
read-only
hashCode → int
The hash code for this object.
read-onlyinherited
mounted → bool
Whether this State object is currently in a tree.
read-onlyinherited
ref → WidgetRef
An object that allows widgets to interact with providers.
latefinalinherited
runtimeType → Type
A representation of the runtime type of the object.
read-onlyinherited
selectionControls → MaterialTextSelectionControls
Get the selection controls for a SelectableText.
read-only
textTheme → TextTheme
Shortcut for accessing the app-wide theme-defined text theme.
read-only
theme → ThemeData
Shortcut for accessing the app-wide theme.
read-only
widget → T
The current configuration.
read-onlyinherited

Methods

activate() → void
Called when this object is reinserted into the tree after having been removed via deactivate.
inherited
build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
buildError({Object? error, StackTrace? stack, dynamic refresh()?}) → Widget
Standard error message for use across the application. General widget for showing an error or a retry screen.
buildLoading() → Widget
Standard loading circle for use across the application.
deactivate() → void
Called when this object is removed from the tree.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
didChangeDependencies() → void
Called when a dependency of this State object changes.
inherited
didUpdateWidget(covariant T oldWidget) → void
Called whenever the widget configuration changes.
inherited
dispose() → void
Called when this object is removed from the tree permanently.
inherited
initState() → void
Called when this object is inserted into the tree.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onSearch(String searchTerm, {String? sentence = ''}) → void
Action to perform upon using the Search context option.
onShare(String searchTerm, {String? sentence = ''}) → void
Action to perform upon using the Share context option.
onStash(String searchTerm) → void
Action to perform upon using the Stash context option.
reassemble() → void
Called whenever the application is reassembled during debugging, for example during hot reload.
inherited
setState(VoidCallback fn) → void
Notify the framework that the internal state of this object has changed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringShort() → String
A brief description of this object, usually just the runtimeType and the hashCode.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited