BaseHistoryPageState<T extends BaseHistoryPage> class

A base class for providing all tabs in the main menu. In large part, this was implemented to define shortcuts for common lengthy methods across UI code.

Inheritance
Implementers

Constructors

BaseHistoryPageState()

Properties

appModel AppModel
Access the global model responsible for app-wide state management.
read-onlyinherited
appModelNoUpdate AppModel
Access the global model responsible for app-wide state management without listening to state updates. Useful when accessing state from initState.
read-onlyinherited
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-onlyinherited
creatorModelNoUpdate CreatorModel
Access the global model responsible for creator state management. without listening to state updates. Useful when accessing state from initState.
read-onlyinherited
hashCode int
The hash code for this object.
read-onlyinherited
isHistory bool
Whether or not to allow edit and delete.
read-only
mediaSource MediaSource
Get the active media source for the current media type.
read-only
mediaType MediaType
Each tab in the home page represents a media type.
read-only
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-onlyinherited
shouldPlaceholderBeShown bool
This variable is true when the buildPlaceholder should be shown. For example, if a certain media type does not have any media items to show in its history.
read-only
textTheme TextTheme
Shortcut for accessing the app-wide theme-defined text theme.
read-onlyinherited
theme ThemeData
Shortcut for accessing the app-wide theme.
read-onlyinherited
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.
inherited
buildHistory(List<MediaItem> items) Widget
This is shown as the body when shouldPlaceholderBeShown is false.
buildLoading() Widget
Standard loading circle for use across the application.
inherited
buildMediaItem(MediaItem item) Widget
Wraps the MediaItem and adds interaction functionality for tapping and long pressing.
buildMediaItemContent(MediaItem item) Widget
Build the widget visually representing the MediaItem's history tile.
buildPlaceholder() Widget
This is shown as the body when shouldPlaceholderBeShown is true.
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
extraActions(MediaItem item) List<Widget>
Extra actions to supply to a history page.
initState() → void
Called when this object is inserted into the tree.
override
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.
inherited
onShare(String searchTerm, {String? sentence = ''}) → void
Action to perform upon using the Share context option.
inherited
onStash(String searchTerm) → void
Action to perform upon using the Stash context option.
inherited
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