Embeds an Android view in the Widget hierarchy.

Requires Android API level 23 or greater.

Embedding Android views is an expensive operation and should be avoided when a Flutter equivalent is possible.

The embedded Android view is painted just like any other Flutter widget and transformations apply to it as well.

The widget fills all available space, the parent of this object must provide bounded layout constraints.

The widget participates in Flutter's gesture arenas, and dispatches touch events to the platform view iff it won the arena. Specific gestures that should be dispatched to the platform view can be specified in the gestureRecognizers constructor parameter. If the set of gesture recognizers is empty, a gesture will be dispatched to the platform view iff it was not claimed by any other gesture recognizer.

The Android view object is created using a PlatformViewFactory. Plugins can register platform view factories with PlatformViewRegistry#registerViewFactory.

Registration is typically done in the plugin's registerWith method, e.g:

  public static void registerWith(Registrar registrar) {
    registrar.platformViewRegistry().registerViewFactory("webview", WebViewFactory(registrar.messenger()));
  }

The platform view's lifetime is the same as the lifetime of the State object for this widget. When the State is disposed the platform view (and auxiliary resources) are lazily released (some resources are immediately released and some by platform garbage collector). A stateful widget's state is disposed when the widget is removed from the tree or when it is moved within the tree. If the stateful widget has a key and it's only moved relative to its siblings, or it has a GlobalKey and it's moved within the tree, it will not be disposed.

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatefulWidget
• AndroidView

Constructors

AndroidView({Key? key, required String viewType, PlatformViewCreatedCallback? onPlatformViewCreated, PlatformViewHitTestBehavior hitTestBehavior = PlatformViewHitTestBehavior.opaque, TextDirection? layoutDirection, Set<Factory<OneSequenceGestureRecognizer>>? gestureRecognizers, dynamic creationParams, MessageCodec? creationParamsCodec, Clip clipBehavior = Clip.hardEdge})

Creates a widget that embeds an Android view.

const

Properties

clipBehavior → Clip

The content will be clipped (or not) according to this option.

final

creationParams → dynamic

Passed as the args argument of PlatformViewFactory#create

final

creationParamsCodec → MessageCodec?

The codec used to encode creationParams before sending it to the platform side. It should match the codec passed to the constructor of PlatformViewFactory.

final

gestureRecognizers → Set<Factory<OneSequenceGestureRecognizer>>?

Which gestures should be forwarded to the Android view.

final

hashCode → int

The hash code for this object.

no setterinherited

hitTestBehavior → PlatformViewHitTestBehavior

How this widget should behave during hit testing.

final

key → Key?

Controls how one widget replaces another widget in the tree.

finalinherited

layoutDirection → TextDirection?

The text direction to use for the embedded view.

final

onPlatformViewCreated → PlatformViewCreatedCallback?

Callback to invoke after the platform view has been created.

final

runtimeType → Type

A representation of the runtime type of the object.

no setterinherited

viewType → String

The unique identifier for Android view type to be embedded by this widget.

final

Methods

createElement() → StatefulElement

Creates a StatefulElement to manage this widget's location in the tree.

inherited

createState() → State<AndroidView>

Creates the mutable state for this widget at a given location in the tree.

override

debugDescribeChildren() → List<DiagnosticsNode>

Returns a list of DiagnosticsNode objects describing this node's children.

inherited

debugFillProperties(DiagnosticPropertiesBuilder properties) → void

Add additional properties associated with the node.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

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

toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String

Returns a string representation of this node and its descendants.

inherited

toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String

Returns a one-line detailed description of the object.

inherited

toStringShort() → String

A short, textual description of this widget.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited