BaseView<KWidget extends BaseWidget, ScreenState, ViewModel extends BaseViewModel<KWidget, ScreenState>> class abstract

Main class for flutter_kore view It holds reference to view model, receives WidgetsBinding post frame callback and manages AutomaticKeepAliveClientMixin for this view. It also can receive events

Example:

class PostView extends BaseWidget {
  const PostView({
    super.key,
    super.viewModel,
  });

  @override
  State<StatefulWidget> createState() {
    return _PostViewWidgetState();
  }
}

class _PostViewWidgetState extends BaseView<PostView, PostViewState, PostViewModel> {
  @override
  Widget buildView(BuildContext context) {
    return Container();
  }

  @override
  PostViewModel createViewModel() {
    return PostViewModel();
  }

  @override
  List<EventBusSubscriber> subscribe() => [
        on<TestEvent>((event) {
          number = event.number;
        }),
      ];
}
Inheritance
Mixed-in types
Implementers

Constructors

BaseView()

Properties

allPartsReady → Observable<bool>
Observable indicating that all parts are connected to this instance
finalinherited
configuration → KoreInstanceConfiguration
KoreInstanceConfiguration for this instance
no setteroverride
context → BuildContext
The location in the tree where this widget builds.
no setterinherited
disposeOperations → List<Function>
List of operations that will be executed with dispose call
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
initializationCompleter → Completer
finalinherited
input ↔ KWidget
Input for this instance
latefinalinherited
isAsync → bool
Getter that returns true if instance contains async parts or require async initialization
no setterinherited
isDisposed ↔ bool
Flag indicating that this instance is disposed
getter/setter pairinherited
isInitialized ↔ bool
Flag indicating that this instance is fully initialized
getter/setter pairinherited
isPaused ↔ bool
getter/setter pairinherited
mounted → bool
Whether this State object is currently in a tree.
no setterinherited
pauseWhenViewBecomeInvisible → bool
Flag indicating if view model needs to be paused when became invisible
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
viewModel → ViewModel
View model for this view
no setter
wantKeepAlive → bool
Whether the current instance should be kept alive.
no setteroverride
widget → KWidget
The current configuration.
no setterinherited

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
buildView(BuildContext context) → Widget
Builds widget that represents this view
checkEventWasReceived(Type event, {int? count}) → bool
Returns true if underlying events list contains given event name
inherited
cleanupReceivedEvents() → void
Cleans collection of received events
inherited
createViewModel() → ViewModel
Factory method for view model for this view
deactivate() → void
Called when this object is removed from the tree.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
didChangeAccessibilityFeatures() → void
Called when the system changes the set of currently active accessibility features.
inherited
didChangeAppLifecycleState(AppLifecycleState state) → void
Called when the system puts the app in the background or returns the app to the foreground.
inherited
didChangeDependencies() → void
Called when a dependency of this State object changes.
inherited
didChangeLocales(List<Locale>? locales) → void
Called when the system tells the app that the user's locale has changed. For example, if the user changes the system language settings.
inherited
didChangeMetrics() → void
Called when the application's dimensions change. For example, when a phone is rotated.
inherited
didChangePlatformBrightness() → void
Called when the platform brightness changes.
inherited
didChangeTextScaleFactor() → void
Called when the platform's text scale factor changes.
inherited
didChangeViewFocus(ViewFocusEvent event) → void
Called whenever the PlatformDispatcher receives a notification that the focus state on a view has changed.
inherited
didHaveMemoryPressure() → void
Called when the system is running low on memory.
inherited
didPopRoute() → Future<bool>
Called when the system tells the app to pop the current route, such as after a system back button press or back gesture.
inherited
didPushRoute(String route) → Future<bool>
Called when the host tells the application to push a new route onto the navigator.
inherited
didPushRouteInformation(RouteInformation routeInformation) → Future<bool>
Called when the host tells the application to push a new RouteInformation and a restoration state onto the router.
inherited
didRequestAppExit() → Future<AppExitResponse>
Called when a request is received from the system to exit the application.
inherited
didUpdateWidget(covariant KWidget oldWidget) → void
Called whenever the widget configuration changes.
inherited
dispose() → void
Called when this object is removed from the tree permanently.
override
disposeEventBusSubscription() → void
Closes underlying stream subscription for EventBus
inherited
disposeInstance() → void
Base method for instance dispose
inherited
ensureInitialized<O>(Future<O> block()) → Future<O>
Helper function that runs given block after async initialization is completed.
inherited
getFullPartConnectorsList() → List<PartConnector>
Returns list of parts
inherited
handleCancelBackGesture() → void
Called when a predictive back gesture is canceled, indicating that no navigation should occur.
inherited
handleCommitBackGesture() → void
Called when a predictive back gesture is finished successfully, indicating that the current route should be popped.
inherited
handleStartBackGesture(PredictiveBackEvent backEvent) → bool
Called at the start of a predictive back gesture.
inherited
handleUpdateBackGestureProgress(PredictiveBackEvent backEvent) → void
Called when a predictive back gesture moves.
inherited
initialize(KWidget input) → void
Base method for instance initialization
inherited
initializeAsync() → Future<void>
Base method for async instance initialization.
inherited
initializeEventBusSubscription() → void
inherited
initializeInstanceParts() → void
Adds parts to local collection
inherited
initializeInstancePartsAsync() → Future<void>
Adds parts to local collection
inherited
initializeViewModel() → void
Initializes view model
initializeWithoutConnections(KWidget input) → void
Base method for lightweight instance initialization
inherited
initializeWithoutConnectionsAsync() → Future<void>
Base method for lightweight async instance initialization
inherited
initState() → void
Called when this object is inserted into the tree.
override
markInitialized() → void
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
on<T>(EventBusSubscriber<T> processor, {bool reactsToPause = false, bool firesAfterResume = true}) → EventBusSubscriber
Subscribes to event of given type
inherited
onAllPartReady() → void
Runs for every async part when it is initialized
inherited
onAsyncPartReady(Type type, int? index) → void
Runs for every async part when it is initialized
inherited
pauseEventBusSubscription() → void
Sets paused flag to false so events stop processing
inherited
reassemble() → void
Called whenever the application is reassembled during debugging, for example during hot reload.
inherited
resumeEventBusSubscription({bool sendAllEventsReceivedWhilePause = true}) → void
Resumes events processing
inherited
setState(VoidCallback fn) → void
Notify the framework that the internal state of this object has changed.
inherited
subscribe() → void
Map of EventBus events and function to be executed for this events
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
updateKeepAlive() → void
Ensures that any AutomaticKeepAlive ancestors are in a good state, by firing a KeepAliveNotification or triggering the KeepAliveHandle as appropriate.
inherited
useInstancePart<InstancePartType extends BaseInstancePart<dynamic, KoreInstance>>({int index = 0}) → InstancePartType
Returns initialized instance part for given type
inherited
waitTillEventIsReceived(Type event, {int? count, Duration timeout = const Duration(seconds: 1)}) → Future<void>
Waits till given event is received by this instance
inherited

Operators

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