io.flutter.plugin.platform

Class PlatformViewsController

java.lang.Object

io.flutter.plugin.platform.PlatformViewsController

All Implemented Interfaces:

MethodChannel.MethodCallHandler, PlatformViewsAccessibilityDelegate

public class PlatformViewsController
extends Object
implements MethodChannel.MethodCallHandler, PlatformViewsAccessibilityDelegate

Manages platform views.

Each FlutterPluginRegistry has a single platform views controller. A platform views controller can be attached to at most one Flutter view.

Constructor Summary

Constructors

Constructor and Description
PlatformViewsController()

Method Summary

Modifier and Type	Method and Description
void	attach(Context context, TextureRegistry textureRegistry, BinaryMessenger messenger) Attaches this platform views controller to its input and output channels.
void	attachAccessibilityBridge(AccessibilityBridge accessibilityBridge) Attaches an accessibility bridge for this platform views accessibility delegate.
void	detach() Detaches this platform views controller.
void	detachAccessibiltyBridge() Detaches the current accessibility bridge.
View	getPlatformViewById(Integer id) Returns the root of the view hierarchy for the platform view with the requested id, or null if there is no corresponding view.
PlatformViewRegistry	getRegistry()
void	onFlutterViewDestroyed()
void	onMethodCall(MethodCall call, MethodChannel.Result result) Handles the specified method call received from Flutter.
void	onPreEngineRestart()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PlatformViewsController

public PlatformViewsController()

Method Detail

attach

public void attach(Context context,
                   TextureRegistry textureRegistry,
                   BinaryMessenger messenger)

Attaches this platform views controller to its input and output channels.

Parameters:

context - The base context that will be passed to embedded views created by this controller. This should be the context of the Activity hosting the Flutter application.

textureRegistry - The texture registry which provides the output textures into which the embedded views will be rendered.

messenger - The Flutter application on the other side of this messenger drives this platform views controller.

detach

public void detach()

Detaches this platform views controller. This is typically called when a Flutter applications moves to run in the background, or is destroyed. After calling this the platform views controller will no longer listen to it's previous messenger, and will not maintain references to the texture registry, context, and messenger passed to the previous attach call.

attachAccessibilityBridge

public void attachAccessibilityBridge(AccessibilityBridge accessibilityBridge)

Description copied from interface: PlatformViewsAccessibilityDelegate

Attaches an accessibility bridge for this platform views accessibility delegate. Accessibility events originating in platform views belonging to this delegate will be delegated to this accessibility bridge.

Specified by:

attachAccessibilityBridge in interface PlatformViewsAccessibilityDelegate

detachAccessibiltyBridge

public void detachAccessibiltyBridge()

Description copied from interface: PlatformViewsAccessibilityDelegate

Detaches the current accessibility bridge. Any accessibility events sent by platform views belonging to this delegate will be ignored until a new accessibility bridge is attached.

Specified by:

detachAccessibiltyBridge in interface PlatformViewsAccessibilityDelegate

getRegistry

public PlatformViewRegistry getRegistry()

onFlutterViewDestroyed

public void onFlutterViewDestroyed()

onPreEngineRestart

public void onPreEngineRestart()

getPlatformViewById

public View getPlatformViewById(Integer id)

Description copied from interface: PlatformViewsAccessibilityDelegate

Returns the root of the view hierarchy for the platform view with the requested id, or null if there is no corresponding view.

Specified by:

getPlatformViewById in interface PlatformViewsAccessibilityDelegate

onMethodCall

public void onMethodCall(MethodCall call,
                         MethodChannel.Result result)

Description copied from interface: MethodChannel.MethodCallHandler

Handles the specified method call received from Flutter.

Handler implementations must submit a result for all incoming calls, by making a single call on the given MethodChannel.Result callback. Failure to do so will result in lingering Flutter result handlers. The result may be submitted asynchronously. Calls to unknown or unimplemented methods should be handled using MethodChannel.Result.notImplemented().

Any uncaught exception thrown by this method will be caught by the channel implementation and logged, and an error result will be sent back to Flutter.

The handler is called on the platform thread (Android main thread). For more details see Threading in the Flutter Engine.

Specified by:

onMethodCall in interface MethodChannel.MethodCallHandler

Parameters:

call - A MethodCall.

result - A MethodChannel.Result used for submitting the result of the call.