Package io.flutter.plugin.platform

Interface PlatformView


public interfacePlatformView
A handle to an Android view to be embedded in the Flutter hierarchy.
  • Method Details

    • getView

      @NullableView getView()
      Returns the Android view to be embedded in the Flutter hierarchy.
    • onFlutterViewAttached

      default void onFlutterViewAttached(@NonNullView flutterView)
      Called by theFlutterEngine that owns this PlatformView when the AndroidView responsible for rendering a Flutter UI is associated with theFlutterEngine.

      This means that our associatedFlutterEngine can now render a UI and interact with the user.

      Some platform views may have unusual dependencies on theView that renders Flutter UIs, such as unique keyboard interactions. ThatView is provided here for those purposes. Use of thisView should be avoided if it is not absolutely necessary, because depending on thisView will tend to make platform view code more brittle to future changes.

    • onFlutterViewDetached

      default void onFlutterViewDetached()
      Called by theFlutterEngine that owns this PlatformView when the AndroidView responsible for rendering a Flutter UI is detached and disassociated from theFlutterEngine.

      This means that our associatedFlutterEngine no longer has a rendering surface, or a user interaction surface of any kind.

      This platform view must release any references related to the AndroidView that was provided inonFlutterViewAttached(View).

    • dispose

      void dispose()
      Dispose this platform view.

      ThePlatformView object is unusable after this method is called.

      Plugins implementingPlatformView must clear all references to the View object and the PlatformView after this method is called. Failing to do so will result in a memory leak.

      References related to the AndroidView attached inonFlutterViewAttached(View) must be released indispose() to avoid memory leaks.

    • onInputConnectionLocked

      default void onInputConnectionLocked()
      Callback fired when the platform's input connection is locked, or should be used.

      This hook only exists for rare cases where the plugin relies on the state of the input connection. This probably doesn't need to be implemented.

    • onInputConnectionUnlocked

      default void onInputConnectionUnlocked()
      Callback fired when the platform input connection has been unlocked.

      This hook only exists for rare cases where the plugin relies on the state of the input connection. This probably doesn't need to be implemented.