BaseMediaSearchBarState<T extends BaseMediaSearchBar> class

State for BaseMediaSearchBar.

Inheritance

Constructors

BaseMediaSearchBarState()

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
mediaSource → MediaSource
Get the active media source for the current media type.
read-onlyinherited
mediaType → MediaType
Each tab in the home page represents a media type.
read-onlyinherited
mounted → bool
Whether this State object is currently in a tree.
read-onlyinherited
pagingController ↔ PagingController<int, MediaItem>?
The paging controller which holds the media items for the search.
read / write
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
searchDelay → Duration
Search delay upon submit.
read-only
selectionControls → MaterialTextSelectionControls
Get the selection controls for a SelectableText.
read-onlyinherited
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 → BasePage
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
buildBackButton() → Widget
Allows user to close the FloatingSearchBar when open.
inherited
buildChangeSourceButton() → Widget
Allows user to swap the current active MediaSource.
inherited
buildEnterSearchTermPlaceholderMessage() → Widget
Shows when the search term is empty and there is nothing in search history.
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
buildFloatingSearchBar() → Widget
The search bar to show at the topmost of the tab body. When selected, buildSearchBarBody will take the place of the remainder tab body, or the elements below the search bar when unselected.
inherited
buildFloatingSearchBody(BuildContext context, Animation<double> transition) → Widget
Shows when the user taps on the floating search bar.
buildLoading() → Widget
Standard loading circle for use across the application.
inherited
buildNoSearchResultsPlaceholderMessage() → Widget
Shows when the media item search has returned no items.
buildResultList() → Widget
Shows when there are proper search results returned.
buildSearchBarBody(BuildContext context, Animation<double> transition) → Widget
The body to show when the search bar is currently selected.
inherited
buildSearchButton() → Widget
Changes between search and clear when focused.
buildSearchClearButton() → Widget
Shows when the user has focused the search bar.
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 BasePage 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
onFocusChanged({required bool focused}) → void
Respond to tapping to the search bar and execute an action if the source does not implement search.
inherited
onQueryChanged(String query) → void
Called when the search bar query has changed.
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
onSubmitted(String query) → void
Called when the user has submitted the search query.
reassemble() → void
Called whenever the application is reassembled during debugging, for example during hot reload.
inherited
refresh() → void
Refresh this tab.
inherited
setState(VoidCallback fn) → void
Notify the framework that the internal state of this object has changed.
inherited
showDeleteSearchHistoryPrompt() → void
Shows when the clear search history is shown.
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