SingletonFlutterWindow class
Deprecated. Will be removed in a future version of Flutter.
This class is deprecated to prepare for Flutter's upcoming support for multiple views and eventually multiple windows.
This class has been split into two classes: FlutterView and PlatformDispatcher. A FlutterView gives an application access to view-specific functionality while the PlatformDispatcher contains platform-specific functionality that applies to all views.
This class backs the global window singleton, which is also deprecated. See the docs on window for migration options.
See also:
- FlutterView, which gives an application access to view-specific functionality.
- PlatformDispatcher, which gives an application access to platform-specific functionality.
- Inheritance
-
- Object
- FlutterView
- SingletonFlutterWindow
- Implementers
- Available Extensions
- Annotations
-
- @Deprecated('Use FlutterView or PlatformDispatcher instead. ' 'Deprecated to prepare for the upcoming multi-window support. ' 'This feature was deprecated after v3.7.0-32.0.pre.')
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
- devicePixelRatio → double
-
The number of device pixels for each logical pixel for the screen this
view is displayed on.
no setterinherited
- display → Display
-
The Display this view is drawn in.
no setterinherited
-
displayFeatures
→ List<
DisplayFeature> -
Areas of the display that are obstructed by hardware features.
no setterinherited
- frameData → FrameData
-
The FrameData object for the current frame.
no setter
- gestureSettings → GestureSettings
-
Additional configuration for touch gestures performed on this view.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- 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 that is invoked to notify the window that it is an appropriate
time to provide a scene using the SceneBuilder API and the render
method.
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
- 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 devicePixelRatio,
physicalSize, padding, viewInsets, PlatformDispatcher.views, or
systemGestureInsets values change.
getter/setter pair
- onPlatformBrightnessChanged ↔ VoidCallback?
-
A callback that is invoked whenever platformBrightness changes value.
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
- 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
- padding → ViewPadding
-
The number of physical pixels on each side of the display rectangle into
which the view can render, but which may be partially obscured by system
UI (such as the system notification area), or physical intrusions in
the display (e.g. overscan regions on television screens or phone sensor
housings).
no setterinherited
- physicalConstraints → ViewConstraints
-
The sizing constraints in physical pixels for this view.
no setterinherited
- physicalSize → Size
-
The current dimensions of the rectangle as last reported by the platform
into which scenes rendered in this view are drawn.
no setterinherited
- platformBrightness → Brightness
-
The setting indicating the current brightness mode of the host platform.
no setter
- platformDispatcher → PlatformDispatcher
-
The platform dispatcher that this view is registered with, and gets its
information from.
finalinherited
- 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 window changes.
no setter
- supportsShowingSystemContextMenu → bool
-
Whether the spell check service is supported on the current platform.
no setter
- systemFontFamily → String?
-
The setting indicating the system font of the host platform.
no setter
- systemGestureInsets → ViewPadding
-
The number of physical pixels on each side of the display rectangle into
which the view can render, but where the operating system will consume
input gestures for the sake of system navigation.
no setterinherited
- textScaleFactor → double
-
The system-reported text scale.
no setter
- viewId → int
-
The opaque ID for this view.
finalinherited
- viewInsets → ViewPadding
-
The number of physical pixels on each side of the display rectangle into
which the view can render, but over which the operating system will likely
place system UI, such as the keyboard, that fully obscures any content.
no setterinherited
- viewPadding → ViewPadding
-
The number of physical pixels on each side of the display rectangle into
which the view can render, but which may be partially obscured by system
UI (such as the system notification area), or physical intrusions in
the display (e.g. overscan regions on television screens or phone sensor
housings).
no setterinherited
Methods
-
computePlatformResolvedLocale(
List< Locale> supportedLocales) → Locale? - Performs the platform-native locale resolution.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
render(
Scene scene, {Size? size}) → void -
Updates the view's rendering on the GPU with the newly provided Scene.
inherited
-
scheduleFrame(
) → void - Requests that, at the next appropriate opportunity, the onBeginFrame and onDrawFrame callbacks be invoked.
-
sendPlatformMessage(
String name, ByteData? data, PlatformMessageResponseCallback? callback) → void - Sends a message to a platform-specific plugin.
-
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 FlutterView.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited