PlatformViewSurface class
Integrates a platform view with Flutter's compositor, touch, and semantics subsystems.
The compositor integration is done by adding a PlatformViewLayer to the layer tree. PlatformViewSurface isn't supported on all platforms (e.g on Android platform views can be composited by using a TextureLayer or AndroidViewSurface). Custom Flutter embedders can support PlatformViewLayers by implementing a SystemCompositor.
The widget fills all available space, the parent of this object must provide bounded layout constraints.
If the associated platform view is not created the PlatformViewSurface does not paint any contents.
See also:
- AndroidView which embeds an Android platform view in the widget hierarchy using a TextureLayer.
- UiKitView which embeds an iOS platform view in the widget hierarchy.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- RenderObjectWidget
- LeafRenderObjectWidget
- PlatformViewSurface
Constructors
-
PlatformViewSurface({Key? key, required PlatformViewController controller, required PlatformViewHitTestBehavior hitTestBehavior, required Set<
Factory< gestureRecognizers})OneSequenceGestureRecognizer> > -
Construct a PlatformViewSurface.
const
Properties
- controller → PlatformViewController
-
The controller for the platform view integrated by this PlatformViewSurface.
final
-
gestureRecognizers
→ Set<
Factory< OneSequenceGestureRecognizer> > -
Which gestures should be forwarded to the PlatformView.
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
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
createElement(
) → LeafRenderObjectElement -
RenderObjectWidgets always inflate to a RenderObjectElement subclass.
inherited
-
createRenderObject(
BuildContext context) → RenderObject -
Creates an instance of the RenderObject class that this
RenderObjectWidget represents, using the configuration described by this
RenderObjectWidget.
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
-
didUnmountRenderObject(
covariant RenderObject renderObject) → void -
A render object previously associated with this widget has been removed
from the tree. The given RenderObject will be of the same type as
returned by this object's createRenderObject.
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
-
updateRenderObject(
BuildContext context, covariant PlatformViewRenderBox renderObject) → void -
Copies the configuration described by this RenderObjectWidget to the
given RenderObject, which will be of the same type as returned by this
object's createRenderObject.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited