io.flutter.plugin.platform.PlatformViewWrapper Class Reference

Inheritance diagram for io.flutter.plugin.platform.PlatformViewWrapper:

Public Member Functions
	PlatformViewWrapper (@NonNull Context context)
	PlatformViewWrapper ( @NonNull Context context, @NonNull PlatformViewRenderTarget renderTarget)
void	setTouchProcessor (@Nullable AndroidTouchProcessor newTouchProcessor)
void	setLayoutParams (@NonNull FrameLayout.LayoutParams params)
void	resizeRenderTarget (int width, int height)
int	getRenderTargetWidth ()
int	getRenderTargetHeight ()
void	release ()
boolean	onInterceptTouchEvent (@NonNull MotionEvent event)
boolean	requestSendAccessibilityEvent (View child, AccessibilityEvent event)
void	onDescendantInvalidated (@NonNull View child, @NonNull View target)
ViewParent	invalidateChildInParent (int[] location, Rect dirty)
void	draw (Canvas canvas)
boolean	onTouchEvent (@NonNull MotionEvent event)
ViewTreeObserver.OnGlobalFocusChangeListener	getActiveFocusListener ()
void	setOnDescendantFocusChangeListener (@NonNull OnFocusChangeListener userFocusListener)
void	unsetOnDescendantFocusChangeListener ()

Detailed Description

Wraps a platform view to intercept gestures and project this view onto a PlatformViewRenderTarget.

An Android platform view is composed by the engine using a TextureLayer. The view is embeded to the Android view hierarchy like a normal view, but it's projected onto a PlatformViewRenderTarget, so it can be efficiently composed by the engine.

Since the view is in the Android view hierarchy, keyboard and accessibility interactions behave normally.

Definition at line 44 of file PlatformViewWrapper.java.

Constructor & Destructor Documentation

PlatformViewWrapper() [1/2]

io.flutter.plugin.platform.PlatformViewWrapper.PlatformViewWrapper ( @NonNull Context  context )

inline

Definition at line 56 of file PlatformViewWrapper.java.

                                                       {
    super(context);
    setWillNotDraw(false);
  }

PlatformViewWrapper() [2/2]

io.flutter.plugin.platform.PlatformViewWrapper.PlatformViewWrapper ( @NonNull Context  context, @NonNull PlatformViewRenderTarget  renderTarget  )

inline

Definition at line 61 of file PlatformViewWrapper.java.

                                                                                {
    this(context);
    this.renderTarget = renderTarget;
 
    Surface surface = renderTarget.getSurface();
    if (surface != null && !FlutterRenderer.debugDisableSurfaceClear) {
      final Canvas canvas = surface.lockHardwareCanvas();
      try {
        canvas.drawColor(Color.TRANSPARENT, PorterDuff.Mode.CLEAR);
      } finally {
        surface.unlockCanvasAndPost(canvas);
      }
    }
  }

Member Function Documentation

draw()

void io.flutter.plugin.platform.PlatformViewWrapper.draw ( Canvas  canvas )

inline

Definition at line 162 of file PlatformViewWrapper.java.

                                  {
    if (renderTarget == null) {
      super.draw(canvas);
      Log.e(TAG, "Platform view cannot be composed without a RenderTarget.");
      return;
    }
    final Surface targetSurface = renderTarget.getSurface();
    final Canvas targetCanvas = targetSurface.lockHardwareCanvas();
    if (targetCanvas == null) {
      // Cannot render right now.
      invalidate();
      return;
    }
 
    try {
      // Fill the render target with transparent pixels. This is needed for platform views that
      // expect a transparent background.
      targetCanvas.drawColor(Color.TRANSPARENT, PorterDuff.Mode.CLEAR);
      // Override the canvas that this subtree of views will use to draw.
      super.draw(targetCanvas);
    } finally {
      renderTarget.scheduleFrame();
      targetSurface.unlockCanvasAndPost(targetCanvas);
    }
  }

getActiveFocusListener()

ViewTreeObserver.OnGlobalFocusChangeListener io.flutter.plugin.platform.PlatformViewWrapper.getActiveFocusListener ( )

inline

Definition at line 217 of file PlatformViewWrapper.java.

                                                                               {
    return this.activeFocusListener;
  }

getRenderTargetHeight()

int io.flutter.plugin.platform.PlatformViewWrapper.getRenderTargetHeight ( )

inline

Definition at line 111 of file PlatformViewWrapper.java.

                                     {
    if (renderTarget != null) {
      return renderTarget.getHeight();
    }
    return 0;
  }

getRenderTargetWidth()

int io.flutter.plugin.platform.PlatformViewWrapper.getRenderTargetWidth ( )

inline

Definition at line 104 of file PlatformViewWrapper.java.

                                    {
    if (renderTarget != null) {
      return renderTarget.getWidth();
    }
    return 0;
  }

invalidateChildInParent()

ViewParent io.flutter.plugin.platform.PlatformViewWrapper.invalidateChildInParent ( int[]  location, Rect  dirty  )

inline

Definition at line 155 of file PlatformViewWrapper.java.

                                                                        {
    invalidate();
    return super.invalidateChildInParent(location, dirty);
  }

onDescendantInvalidated()

void io.flutter.plugin.platform.PlatformViewWrapper.onDescendantInvalidated ( @NonNull View  child, @NonNull View  target  )

inline

Used on Android O+, invalidateChildInParent used for previous versions.

Definition at line 149 of file PlatformViewWrapper.java.

                                                                                 {
    super.onDescendantInvalidated(child, target);
    invalidate();
  }

onInterceptTouchEvent()

boolean io.flutter.plugin.platform.PlatformViewWrapper.onInterceptTouchEvent ( @NonNull MotionEvent  event )

inline

Definition at line 127 of file PlatformViewWrapper.java.

                                                                   {
    return true;
  }

onTouchEvent()

boolean io.flutter.plugin.platform.PlatformViewWrapper.onTouchEvent ( @NonNull MotionEvent  event )

inline

Definition at line 190 of file PlatformViewWrapper.java.

                                                          {
    if (touchProcessor == null) {
      return super.onTouchEvent(event);
    }
    final Matrix screenMatrix = new Matrix();
    switch (event.getAction()) {
      case MotionEvent.ACTION_DOWN:
        prevLeft = left;
        prevTop = top;
        screenMatrix.postTranslate(left, top);
        break;
      case MotionEvent.ACTION_MOVE:
        // While the view is dragged, use the left and top positions as
        // they were at the moment the touch event fired.
        screenMatrix.postTranslate(prevLeft, prevTop);
        prevLeft = left;
        prevTop = top;
        break;
      case MotionEvent.ACTION_UP:
      default:
        screenMatrix.postTranslate(left, top);
        break;
    }
    return touchProcessor.onTouchEvent(event, screenMatrix);
  }

release()

void io.flutter.plugin.platform.PlatformViewWrapper.release ( )

inline

Releases resources.

Definition at line 119 of file PlatformViewWrapper.java.

                        {
    if (renderTarget != null) {
      renderTarget.release();
      renderTarget = null;
    }
  }

requestSendAccessibilityEvent()

boolean io.flutter.plugin.platform.PlatformViewWrapper.requestSendAccessibilityEvent ( View  child, AccessibilityEvent  event  )

inline

Definition at line 132 of file PlatformViewWrapper.java.

                                                                                     {
    final View embeddedView = getChildAt(0);
    if (embeddedView != null
        && embeddedView.getImportantForAccessibility()
            == View.IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS) {
      return false;
    }
    // Forward the request only if the embedded view is in the Flutter accessibility tree.
    // The embedded view may be ignored when the framework doesn't populate a SemanticNode
    // for the current platform view.
    // See AccessibilityBridge for more.
    return super.requestSendAccessibilityEvent(child, event);
  }

resizeRenderTarget()

void io.flutter.plugin.platform.PlatformViewWrapper.resizeRenderTarget ( int  width, int  height  )

inline

Definition at line 98 of file PlatformViewWrapper.java.

                                                        {
    if (renderTarget != null) {
      renderTarget.resize(width, height);
    }
  }

setLayoutParams()

void io.flutter.plugin.platform.PlatformViewWrapper.setLayoutParams ( @NonNull FrameLayout.LayoutParams  params )

inline

Sets the layout parameters for this view.

Parameters

params

The new parameters.

Definition at line 91 of file PlatformViewWrapper.java.

                                                                        {
    super.setLayoutParams(params);
 
    left = params.leftMargin;
    top = params.topMargin;
  }

setOnDescendantFocusChangeListener()

void io.flutter.plugin.platform.PlatformViewWrapper.setOnDescendantFocusChangeListener ( @NonNull OnFocusChangeListener  userFocusListener )

inline

Definition at line 221 of file PlatformViewWrapper.java.

                                                                                                   {
    unsetOnDescendantFocusChangeListener();
    final ViewTreeObserver observer = getViewTreeObserver();
    if (observer.isAlive() && activeFocusListener == null) {
      activeFocusListener =
          new ViewTreeObserver.OnGlobalFocusChangeListener() {
            @Override
            public void onGlobalFocusChanged(View oldFocus, View newFocus) {
              userFocusListener.onFocusChange(
                  PlatformViewWrapper.this, ViewUtils.childHasFocus(PlatformViewWrapper.this));
            }
          };
      observer.addOnGlobalFocusChangeListener(activeFocusListener);
    }
  }

setTouchProcessor()

void io.flutter.plugin.platform.PlatformViewWrapper.setTouchProcessor ( @Nullable AndroidTouchProcessor  newTouchProcessor )

inline

Sets the touch processor that allows to intercept gestures.

Parameters

newTouchProcessor

The touch processor.

Definition at line 82 of file PlatformViewWrapper.java.

                                                                                   {
    touchProcessor = newTouchProcessor;
  }

unsetOnDescendantFocusChangeListener()

void io.flutter.plugin.platform.PlatformViewWrapper.unsetOnDescendantFocusChangeListener ( )

inline

Definition at line 237 of file PlatformViewWrapper.java.

                                                     {
    final ViewTreeObserver observer = getViewTreeObserver();
    if (observer.isAlive() && activeFocusListener != null) {
      final ViewTreeObserver.OnGlobalFocusChangeListener currFocusListener = activeFocusListener;
      activeFocusListener = null;
      observer.removeOnGlobalFocusChangeListener(currFocusListener);
    }
  }

---

The documentation for this class was generated from the following file:

• shell/platform/android/io/flutter/plugin/platform/PlatformViewWrapper.java