doc/api/boost_flutter_binding/BoostFlutterBinding-mixin.html
This class is to hook the Binding，to handle lifecycle events
Superclass Constraints
window→ SingletonFlutterWindow The main window to which this binding is bound. [...] read-only, inherited platformDispatcher→ PlatformDispatcher The ui.PlatformDispatcher to which this binding is bound. [...] read-only, inherited locked→ bool Whether lockEvents is currently locking events. [...] @protected, read-only, inherited hashCode→ int The hash code for this object. [...] read-only, inherited runtimeType→ Type A representation of the runtime type of the object. read-only, inherited debugSamplingClock→ SamplingClock Overrides the sampling clock for debugging and testing. [...] @protected, read-only, inherited pointerRouter→ PointerRouter A router that routes all pointer events received from the engine. final, inherited gestureArena→ GestureArenaManager The gesture arenas used for disambiguating the meaning of sequences of pointer events. final, inherited pointerSignalResolver→ PointerSignalResolver The resolver used for determining which widget handles a PointerSignalEvent. final, inherited resamplingEnabled↔ bool Enable pointer event resampling for touch devices by setting this to true. [...] read / write, inherited samplingOffset↔ Duration Offset relative to current frame time that should be used for resampling. The samplingOffset is expected to be negative. Non-negative samplingOffset is allowed but will effectively disable resampling. read / write, inherited lifecycleState→ AppLifecycleState Whether the application is visible, and if so, whether it is currently interactive. [...] read-only, inherited transientCallbackCount→ int The current number of transient frame callbacks scheduled. [...] read-only, inherited endOfFrame→ Future<void> Returns a Future that completes after the frame completes. [...] read-only, inherited hasScheduledFrame→ bool Whether this scheduler has requested that handleBeginFrame be called soon. read-only, inherited schedulerPhase→ SchedulerPhase The phase that the scheduler is currently operating under. read-only, inherited framesEnabled→ bool Whether frames are currently being scheduled when scheduleFrame is called. [...] read-only, inherited currentFrameTimeStamp→ Duration The time stamp for the frame currently being processed. [...] read-only, inherited currentSystemFrameTimeStamp→ Duration The raw time stamp as provided by the engine to dart:ui.PlatformDispatcher.onBeginFrame for the frame currently being processed. [...] read-only, inherited schedulingStrategy↔ SchedulingStrategy The strategy to use when deciding whether to run a task or not. [...] read / write, inherited defaultBinaryMessenger→ BinaryMessenger The default instance of BinaryMessenger. [...] read-only, inherited restorationManager→ RestorationManager The RestorationManager synchronizes the restoration data between engine and framework. [...] read-only, inherited imageCache→ ImageCache The singleton that implements the Flutter framework's image cache. [...] read-only, inherited systemFonts→ Listenable Listenable that notifies when the available fonts on the system have changed. [...] read-only, inherited accessibilityFeatures→ AccessibilityFeatures The currently active set of AccessibilityFeatures. [...] read-only, inherited disableAnimations→ bool The platform is requesting that animations be disabled or simplified. [...] read-only, inherited mouseTracker→ MouseTracker The object that manages state about currently connected mice, for hover notification. read-only, inherited pipelineOwner→ PipelineOwner The render tree's owner, which maintains dirty state for layout, composite, paint, and accessibility semantics. read-only, inherited renderView↔ RenderView The render tree that's attached to the output surface. read / write, inherited sendFramesToEngine→ bool Whether frames produced by drawFrame are sent to the engine. [...] read-only, inherited buildOwner→ BuildOwner The BuildOwner in charge of executing the build pipeline for the widget tree rooted at this binding. read-only, inherited focusManager→ FocusManager The object in charge of the focus tree. [...] read-only, inherited firstFrameRasterized→ bool Whether the Flutter engine has rasterized the first frame. [...] read-only, inherited waitUntilFirstFrameRasterized→ Future<void> A future that completes when the Flutter engine has rasterized the first frame. [...] read-only, inherited debugDidSendFirstFrameEvent→ bool Whether the first frame has finished building. [...] read-only, inherited renderViewElement→ Element The Element that is at the root of the hierarchy (and which wraps the RenderView object at the root of the rendering hierarchy). [...] read-only, inherited isRootWidgetAttached→ bool Whether the renderViewElement has been initialized. [...] read-only, inherited debugBuildingDirtyElements↔ bool Whether we are currently in a frame. This is used to verify that frames are not scheduled redundantly. [...] @protected, read / write, inherited
initInstances() → void The initialization method. Subclasses override this method to hook into the platform and otherwise configure their services. Subclasses must call "super.initInstances()". [...]
override
handleAppLifecycleStateChanged(AppLifecycleState state) → void Called when the application lifecycle state changes. [...]
override
changeAppLifecycleState(AppLifecycleState state) → void initServiceExtensions() → void Called when the binding is initialized, to register service extensions. [...]
inherited
lockEvents(Future<void> callback()) → Future<void> Locks the dispatching of asynchronous events and callbacks until the callback's future completes. [...]
@protected, inherited
unlocked() → void Called by lockEvents when events get unlocked. [...]
inherited
reassembleApplication() → Future<void> Cause the entire application to redraw, e.g. after a hot reload. [...]
inherited
performReassemble() → Future<void> This method is called by reassembleApplication to actually cause the application to reassemble, e.g. after a hot reload. [...]
inherited
registerSignalServiceExtension({required String name, required AsyncCallback callback}) → void Registers a service extension method with the given name (full name "ext.flutter.name"), which takes no arguments and returns no value. [...]
@protected, inherited
registerBoolServiceExtension({required String name, required AsyncValueGetter<bool> getter, required AsyncValueSetter<bool> setter}) → void Registers a service extension method with the given name (full name "ext.flutter.name"), which takes a single argument "enabled" which can have the value "true" or the value "false" or can be omitted to read the current value. (Any value other than "true" is considered equivalent to "false". Other arguments are ignored.) [...]
@protected, inherited
registerNumericServiceExtension({required String name, required AsyncValueGetter<double> getter, required AsyncValueSetter<double> setter}) → void Registers a service extension method with the given name (full name "ext.flutter.name"), which takes a single argument with the same name as the method which, if present, must have a value that can be parsed by double.parse, and can be omitted to read the current value. (Other arguments are ignored.) [...]
@protected, inherited
postEvent(String eventKind, Map<String, dynamic> eventData) → void All events dispatched by a BindingBase use this method instead of calling developer.postEvent directly so that tests for BindingBase can track which events were dispatched by overriding this method.
@protected, inherited
registerStringServiceExtension({required String name, required AsyncValueGetter<String> getter, required AsyncValueSetter<String> setter}) → void Registers a service extension method with the given name (full name "ext.flutter.name"), which optionally takes a single argument with the name "value". If the argument is omitted, the value is to be read, otherwise it is to be set. Returns the current value. [...]
@protected, inherited
registerServiceExtension({required String name, required ServiceExtensionCallback callback}) → void Registers a service extension method with the given name (full name "ext.flutter.name"). [...]
@protected, inherited
toString() → String A string representation of this object. [...]
inherited
noSuchMethod(Invocation invocation) → dynamic Invoked when a non-existent method or property is accessed. [...]
inherited
cancelPointer(int pointer) → void Dispatch a PointerCancelEvent for the given pointer soon. [...]
inherited
handlePointerEvent(PointerEvent event) → void Dispatch an event to the targets found by a hit test on its position. [...]
inherited
hitTest(HitTestResult result, Offset position) → void Determine which HitTestTarget objects are located at a given position.
inherited
dispatchEvent(PointerEvent event, HitTestResult hitTestResult) → void Dispatch an event to pointerRouter and the path of a hit test result. [...]
inherited
handleEvent(PointerEvent event, HitTestEntry entry) → void Override this method to receive events.
inherited
resetGestureBinding() → void Reset states of GestureBinding. [...]
@protected, inherited
addTimingsCallback(TimingsCallback callback) → void Add a TimingsCallback that receives FrameTiming sent from the engine. [...]
inherited
removeTimingsCallback(TimingsCallback callback) → void Removes a callback that was earlier added by addTimingsCallback.
inherited
scheduleTask<T>(TaskCallback<T> task, Priority priority, {String debugLabel, Flow flow}) → Future<T> Schedules the given task with the given priority and returns a Future that completes to the task's eventual return value. [...]
inherited
handleEventLoopCallback() → bool Execute the highest-priority task, if it is of a high enough priority. [...]
@visibleForTesting, inherited
scheduleFrameCallback(FrameCallback callback, {bool rescheduling = false}) → int Schedules the given transient frame callback. [...]
inherited
cancelFrameCallbackWithId(int id) → void Cancels the transient frame callback with the given id. [...]
inherited
debugAssertNoTransientCallbacks(String reason) → bool Asserts that there are no registered transient callbacks; if there are, prints their locations and throws an exception. [...]
inherited
addPersistentFrameCallback(FrameCallback callback) → void Adds a persistent frame callback. [...]
inherited
addPostFrameCallback(FrameCallback callback) → void Schedule a callback for the end of this frame. [...]
inherited
ensureFrameCallbacksRegistered() → void Ensures callbacks for PlatformDispatcher.onBeginFrame and PlatformDispatcher.onDrawFrame are registered.
@protected, inherited
ensureVisualUpdate() → void Schedules a new frame using scheduleFrame if this object is not currently producing a frame. [...]
inherited
scheduleFrame() → void If necessary, schedules a new frame by calling dart:ui.PlatformDispatcher.scheduleFrame. [...]
inherited
scheduleForcedFrame() → void Schedules a new frame by calling dart:ui.PlatformDispatcher.scheduleFrame. [...]
inherited
scheduleWarmUpFrame() → void Schedule a frame to run as soon as possible, rather than waiting for the engine to request a frame in response to a system "Vsync" signal. [...]
inherited
resetEpoch() → void Prepares the scheduler for a non-monotonic change to how time stamps are calculated. [...]
inherited
handleBeginFrame(Duration rawTimeStamp) → void Called by the engine to prepare the framework to produce a new frame. [...]
inherited
handleDrawFrame() → void Called by the engine to produce a new frame. [...]
inherited
createBinaryMessenger() → BinaryMessenger Creates a default BinaryMessenger instance that can be used for sending platform messages.
@protected, inherited
handleMemoryPressure() → void Called when the operating system notifies the application of a memory pressure situation. [...]
inherited
handleSystemMessage(Object systemMessage) → Future<void> Handler called for messages received on the SystemChannels.system message channel. [...]
inherited
initLicenses() → void Adds relevant licenses to the LicenseRegistry. [...]
@mustCallSuper, @protected, inherited
evict(String asset) → void Called in response to the ext.flutter.evict service extension. [...]
inherited
readInitialLifecycleStateFromNativeWindow() → void Initializes the lifecycleState with the dart:ui.SingletonFlutterWindow.initialLifecycleState. [...]
@protected, inherited
createRestorationManager() → RestorationManager Creates the RestorationManager instance available via restorationManager. [...]
@protected, inherited
createImageCache() → ImageCache Creates the ImageCache singleton (accessible via imageCache). [...]
@protected, inherited
instantiateImageCodec(Uint8List bytes, {int cacheWidth, int cacheHeight, bool allowUpscaling = false}) → Future<Codec> Calls through to dart:ui.instantiateImageCodec from ImageCache. [...]
inherited
handleAccessibilityFeaturesChanged() → void Called when the platform accessibility features change. [...]
inherited
createSemanticsUpdateBuilder() → SemanticsUpdateBuilder Creates an empty semantics update builder. [...]
inherited
initRenderView() → void Creates a RenderView object to be the root of the RenderObject rendering tree, and initializes it so that it will be rendered when the next frame is requested. [...]
inherited
handleMetricsChanged() → void Called when the system metrics change. [...]
inherited
handleTextScaleFactorChanged() → void Called when the platform text scale factor changes. [...]
inherited
handlePlatformBrightnessChanged() → void Called when the platform brightness changes. [...]
inherited
createViewConfiguration() → ViewConfiguration Returns a ViewConfiguration configured for the RenderView based on the current environment. [...]
inherited
initMouseTracker([MouseTracker tracker]) → void Creates a MouseTracker which manages state about currently connected mice, for hover notification. [...]
@visibleForTesting, inherited
setSemanticsEnabled(bool enabled) → void Whether the render tree associated with this binding should produce a tree of SemanticsNode objects.
inherited
deferFirstFrame() → void Tell the framework to not send the first frames to the engine until there is a corresponding call to allowFirstFrame. [...]
inherited
allowFirstFrame() → void Called after deferFirstFrame to tell the framework that it is ok to send the first frame to the engine now. [...]
inherited
resetFirstFrameSent() → void Call this to pretend that no frames have been sent to the engine yet. [...]
inherited
drawFrame() → void Pump the build and rendering pipeline to generate a frame. [...]
inherited
addObserver(WidgetsBindingObserver observer) → void Registers the given object as a binding observer. Binding observers are notified when various application events occur, for example when the system locale changes. Generally, one widget in the widget tree registers itself as a binding observer, and converts the system state into inherited widgets. [...]
inherited
removeObserver(WidgetsBindingObserver observer) → bool Unregisters the given observer. This should be used sparingly as it is relatively expensive (O(N) in the number of registered observers). [...]
inherited
handleLocaleChanged() → void Called when the system locale changes. [...]
@mustCallSuper, @protected, inherited
dispatchLocalesChanged(List<Locale> locales) → void Notify all the observers that the locale has changed (using WidgetsBindingObserver.didChangeLocales), giving them the locales argument. [...]
@mustCallSuper, @protected, inherited
dispatchAccessibilityFeaturesChanged() → void Notify all the observers that the active set of AccessibilityFeatures has changed (using WidgetsBindingObserver.didChangeAccessibilityFeatures), giving them the features argument. [...]
@mustCallSuper, @protected, inherited
handlePopRoute() → Future<void> Called when the system pops the current route. [...]
@protected, inherited
handlePushRoute(String route) → Future<void> Called when the host tells the app to push a new route onto the navigator. [...]
@mustCallSuper, @protected, inherited
scheduleAttachRootWidget(Widget rootWidget) → void Schedules a Timer for attaching the root widget. [...]
@protected, inherited
attachRootWidget(Widget rootWidget) → void Takes a widget and attaches it to the renderViewElement, creating it if necessary. [...]
inherited
computePlatformResolvedLocale(List<Locale> supportedLocales) → Locale Computes the locale the current platform would resolve to. [...]
inherited
operator ==(Object other) → bool The equality operator. [...] inherited
instance→ BoostFlutterBinding The singleton instance of this object. read-only, override