PlatformDispatcher class
Platform event dispatcher singleton.
The most basic interface to the host operating system's interface.
This is the central entry point for platform messages and configuration events from the platform.
It exposes the core scheduler API, the input event callback, the graphics drawing API, and other such core services.
It manages the list of the application's views as well as the
configuration of various platform attributes.
Consider avoiding static references to this singleton through
PlatformDispatcher.instance and instead prefer using a binding for
dependency resolution such as WidgetsBinding.instance.platformDispatcher.
See PlatformDispatcher.instance for more information about why this is
preferred.
- Implementers
Properties
- accessibilityFeatures → AccessibilityFeatures
-
Additional accessibility features that may be enabled by the platform.
no setter
- alwaysUse24HourFormat → bool
-
The setting indicating whether time should always be shown in the 24-hour
format.
no setter
- brieflyShowPassword → bool
-
Whether briefly displaying the characters as you type in obscured text
fields is enabled in system settings.
no setter
- defaultRouteName → String
-
The route or path that the embedder requested when the application was
launched.
no setter
-
displays
→ Iterable<
Display> -
The current list of displays.
no setter
- engineId → int?
-
Opaque engine identifier for the engine running current isolate. Can be used
in native code to retrieve the engine instance.
The identifier is valid while the isolate is running.
no setter
- frameData → FrameData
-
The FrameData object for the current frame.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- implicitView → FlutterView?
-
The FlutterView provided by the engine if the platform is unable to
create windows, or, for backwards compatibility.
no setter
- initialLifecycleState → String
-
The lifecycle state immediately after dart isolate initialization.
no setter
- locale → Locale
-
The system-reported default locale of the device.
no setter
-
locales
→ List<
Locale> -
The full system-reported supported locales of the device.
no setter
- nativeSpellCheckServiceDefined → bool
-
Whether the spell check service is supported on the current platform.
no setter
- onAccessibilityFeaturesChanged ↔ VoidCallback?
-
A callback that is invoked when the value of accessibilityFeatures
changes.
getter/setter pair
- onBeginFrame ↔ FrameCallback?
-
A callback invoked when any view begins a frame.
getter/setter pair
- onDrawFrame ↔ VoidCallback?
-
A callback that is invoked for each frame after onBeginFrame has
completed and after the microtask queue has been drained.
getter/setter pair
- onError ↔ ErrorCallback?
-
A callback that is invoked when an unhandled error occurs in the root
isolate.
getter/setter pair
- onFrameDataChanged ↔ VoidCallback?
-
A callback that is invoked when the window updates the FrameData.
getter/setter pair
- onKeyData ↔ KeyDataCallback?
-
A callback that is invoked when key data is available.
getter/setter pair
- onLocaleChanged ↔ VoidCallback?
-
A callback that is invoked whenever locale changes value.
getter/setter pair
- onMetricsChanged ↔ VoidCallback?
-
A callback that is invoked whenever the ViewConfiguration of any of the
views changes.
getter/setter pair
- onPlatformBrightnessChanged ↔ VoidCallback?
-
A callback that is invoked whenever platformBrightness changes value.
getter/setter pair
- onPlatformConfigurationChanged ↔ VoidCallback?
-
Called when the platform configuration changes.
getter/setter pair
- onPlatformMessage ↔ PlatformMessageCallback?
-
Deprecated. Migrate to ChannelBuffers.setListener instead.
getter/setter pair
- onPointerDataPacket ↔ PointerDataPacketCallback?
-
A callback that is invoked when pointer data is available.
getter/setter pair
- onReportTimings ↔ TimingsCallback?
-
A callback that is invoked to report the FrameTiming of recently
rasterized frames.
getter/setter pair
- onSemanticsActionEvent ↔ SemanticsActionEventCallback?
-
A callback that is invoked whenever the user requests an action to be
performed on a semantics node.
getter/setter pair
- onSemanticsEnabledChanged ↔ VoidCallback?
-
A callback that is invoked when the value of semanticsEnabled changes.
getter/setter pair
- onSystemFontFamilyChanged ↔ VoidCallback?
-
A callback that is invoked whenever systemFontFamily changes value.
getter/setter pair
- onTextScaleFactorChanged ↔ VoidCallback?
-
A callback that is invoked whenever textScaleFactor changes value.
getter/setter pair
- onViewFocusChange ↔ ViewFocusChangeCallback?
-
A callback invoked immediately after the focus is transitioned across FlutterViews.
getter/setter pair
- platformBrightness → Brightness
-
The setting indicating the current brightness mode of the host platform.
If the platform has no preference, platformBrightness defaults to
Brightness.light.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- semanticsEnabled → bool
-
Whether the user has requested that updateSemantics be called when the
semantic contents of a view changes.
no setter
- supportsShowingSystemContextMenu → bool
-
Whether showing system context menu is supported on the current platform.
no setter
- systemFontFamily → String?
-
The setting indicating the current system font of the host platform.
no setter
- textScaleFactor → double
-
The system-reported text scale.
no setter
-
views
→ Iterable<
FlutterView> -
The current list of views, including top level platform windows used by
the application.
no setter
Methods
-
computePlatformResolvedLocale(
List< Locale> supportedLocales) → Locale? - Performs the platform-native locale resolution.
-
getPersistentIsolateData(
) → ByteData? - The embedder can specify data that the isolate can request synchronously on launch. This accessor fetches that data.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerBackgroundIsolate(
RootIsolateToken token) → void -
Registers the current isolate with the isolate identified with by the
token. This is required if platform channels are to be used on a background isolate. -
requestDartPerformanceMode(
DartPerformanceMode mode) → void -
Requests the Dart VM to adjusts the GC heuristics based on the requested
performance_mode. -
requestViewFocusChange(
{required int viewId, required ViewFocusState state, required ViewFocusDirection direction}) → void -
Requests a focus change of the FlutterView with ID
viewId. -
scaleFontSize(
double unscaledFontSize) → double -
Computes the scaled font size from the given
unscaledFontSize, according to the user's platform preferences. -
scheduleFrame(
) → void - Requests that, at the next appropriate opportunity, the onBeginFrame and onDrawFrame callbacks be invoked.
-
scheduleWarmUpFrame(
{required VoidCallback beginFrame, required VoidCallback drawFrame}) → 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.
-
sendPlatformMessage(
String name, ByteData? data, PlatformMessageResponseCallback? callback) → void - Sends a message to a platform-specific plugin.
-
sendPortPlatformMessage(
String name, ByteData? data, int identifier, SendPort port) → void - Sends a message to a platform-specific plugin via a SendPort.
-
setIsolateDebugName(
String name) → void - Set the debug name associated with this platform dispatcher's root isolate.
-
toString(
) → String -
A string representation of this object.
inherited
-
updateSemantics(
SemanticsUpdate update) → void - Change the retained semantics data about this platform dispatcher.
-
view(
{required int id}) → FlutterView? - Returns the FlutterView with the provided ID if one exists, or null otherwise.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
- instance → PlatformDispatcher
-
The PlatformDispatcher singleton.
no setter