Inheritance diagram for io.flutter.embedding.android.FlutterFragment:

Classes
interface	ActivityCallThrough

class	CachedEngineFragmentBuilder

class	NewEngineFragmentBuilder

class	NewEngineInGroupFragmentBuilder

Public Member Functions
FlutterActivityAndFragmentDelegate	createDelegate (FlutterActivityAndFragmentDelegate.Host host)

	FlutterFragment ()

ExclusiveAppComponent< Activity >	getExclusiveAppComponent ()

void	onAttach (@NonNull Context context)

void	onCreate (@Nullable Bundle savedInstanceState)

View	onCreateView (LayoutInflater inflater, @Nullable ViewGroup container, @Nullable Bundle savedInstanceState)

void	onStart ()

void	onResume ()

void	onPostResume ()

void	onPause ()

void	onStop ()

void	onViewCreated (View view, Bundle savedInstanceState)

void	onDestroyView ()

void	onSaveInstanceState (Bundle outState)

void	detachFromFlutterEngine ()

void	onDetach ()

void	onRequestPermissionsResult (int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults)

void	onNewIntent (@NonNull Intent intent)

void	onBackPressed ()

void	onActivityResult (int requestCode, int resultCode, Intent data)

void	onUserLeaveHint ()

void	onTrimMemory (int level)

FlutterShellArgs	getFlutterShellArgs ()

String	getCachedEngineId ()

String	getCachedEngineGroupId ()

boolean	shouldDestroyEngineWithHost ()

String	getDartEntrypointFunctionName ()

List< String >	getDartEntrypointArgs ()

String	getDartEntrypointLibraryUri ()

String	getAppBundlePath ()

String	getInitialRoute ()

RenderMode	getRenderMode ()

TransparencyMode	getTransparencyMode ()

FlutterEngine	provideFlutterEngine (@NonNull Context context)

FlutterEngine	getFlutterEngine ()

PlatformPlugin	providePlatformPlugin ( @Nullable Activity activity, @NonNull FlutterEngine flutterEngine)

void	configureFlutterEngine (@NonNull FlutterEngine flutterEngine)

void	cleanUpFlutterEngine (@NonNull FlutterEngine flutterEngine)

boolean	shouldAttachEngineToActivity ()

boolean	shouldHandleDeeplinking ()

void	onFlutterSurfaceViewCreated (@NonNull FlutterSurfaceView flutterSurfaceView)

void	onFlutterTextureViewCreated (@NonNull FlutterTextureView flutterTextureView)

void	onFlutterUiDisplayed ()

void	onFlutterUiNoLongerDisplayed ()

boolean	shouldRestoreAndSaveState ()

void	updateSystemUiOverlays ()

boolean	shouldDispatchAppLifecycleState ()

boolean	attachToEngineAutomatically ()

boolean	popSystemNavigator ()

void	setFrameworkHandlesBack (boolean frameworkHandlesBack)

Public Member Functions inherited from io.flutter.embedding.android.FlutterActivityAndFragmentDelegate.Host
Context	getContext ()

boolean	shouldHandleDeeplinking ()

Activity	getActivity ()

Lifecycle	getLifecycle ()

FlutterShellArgs	getFlutterShellArgs ()

String	getCachedEngineId ()

String	getCachedEngineGroupId ()

boolean	shouldDestroyEngineWithHost ()

void	detachFromFlutterEngine ()

String	getDartEntrypointFunctionName ()

String	getDartEntrypointLibraryUri ()

List< String >	getDartEntrypointArgs ()

String	getAppBundlePath ()

String	getInitialRoute ()

RenderMode	getRenderMode ()

TransparencyMode	getTransparencyMode ()

ExclusiveAppComponent< Activity >	getExclusiveAppComponent ()

FlutterEngine	provideFlutterEngine (@NonNull Context context)

PlatformPlugin	providePlatformPlugin ( @Nullable Activity activity, @NonNull FlutterEngine flutterEngine)

void	configureFlutterEngine (@NonNull FlutterEngine flutterEngine)

void	cleanUpFlutterEngine (@NonNull FlutterEngine flutterEngine)

boolean	shouldAttachEngineToActivity ()

void	onFlutterSurfaceViewCreated (@NonNull FlutterSurfaceView flutterSurfaceView)

void	onFlutterTextureViewCreated (@NonNull FlutterTextureView flutterTextureView)

void	onFlutterUiDisplayed ()

void	onFlutterUiNoLongerDisplayed ()

boolean	shouldRestoreAndSaveState ()

void	updateSystemUiOverlays ()

boolean	shouldDispatchAppLifecycleState ()

boolean	attachToEngineAutomatically ()

FlutterEngine	provideFlutterEngine (@NonNull Context context)

void	configureFlutterEngine (@NonNull FlutterEngine flutterEngine)

void	cleanUpFlutterEngine (@NonNull FlutterEngine flutterEngine)

boolean	popSystemNavigator ()

default void	setFrameworkHandlesBack (boolean frameworkHandlesBack)

FlutterActivityAndFragmentDelegate	createDelegate (FlutterActivityAndFragmentDelegate.Host host)

Static Public Member Functions
static FlutterFragment	createDefault ()

static NewEngineFragmentBuilder	withNewEngine ()

static CachedEngineFragmentBuilder	withCachedEngine (@NonNull String engineId)

static NewEngineInGroupFragmentBuilder	withNewEngineInGroup ( @NonNull String engineGroupId)

Static Public Attributes
static final int	FLUTTER_VIEW_ID = View.generateViewId()

Static Protected Attributes
static final String	ARG_DART_ENTRYPOINT = "dart_entrypoint"

static final String	ARG_DART_ENTRYPOINT_URI = "dart_entrypoint_uri"

static final String	ARG_DART_ENTRYPOINT_ARGS = "dart_entrypoint_args"

static final String	ARG_INITIAL_ROUTE = "initial_route"

static final String	ARG_HANDLE_DEEPLINKING = "handle_deeplinking"

static final String	ARG_APP_BUNDLE_PATH = "app_bundle_path"

static final String	ARG_SHOULD_DELAY_FIRST_ANDROID_VIEW_DRAW

static final String	ARG_FLUTTER_INITIALIZATION_ARGS = "initialization_args"

static final String	ARG_FLUTTERVIEW_RENDER_MODE = "flutterview_render_mode"

static final String	ARG_FLUTTERVIEW_TRANSPARENCY_MODE = "flutterview_transparency_mode"

static final String	ARG_SHOULD_ATTACH_ENGINE_TO_ACTIVITY

static final String	ARG_CACHED_ENGINE_ID = "cached_engine_id"

static final String	ARG_CACHED_ENGINE_GROUP_ID = "cached_engine_group_id"

static final String	ARG_DESTROY_ENGINE_WITH_FRAGMENT = "destroy_engine_with_fragment"

static final String	ARG_ENABLE_STATE_RESTORATION = "enable_state_restoration"

static final String	ARG_SHOULD_AUTOMATICALLY_HANDLE_ON_BACK_PRESSED

Package Functions
void	setDelegateFactory ( @NonNull FlutterActivityAndFragmentDelegate.DelegateFactory delegateFactory)

boolean	isFlutterEngineInjected ()

boolean	shouldDelayFirstAndroidViewDraw ()

Package Attributes
FlutterActivityAndFragmentDelegate	delegate

Detailed Description

Fragment which displays a Flutter UI that takes up all available Fragment space.

Using a FlutterFragment requires forwarding a number of calls from an Activity to ensure that the internal Flutter app behaves as expected:

onBackPressed() does not need to be called through if the fragment is constructed by one of the builders with shouldAutomaticallyHandleOnBackPressed(true).

Additionally, when starting an Activity for a result from this Fragment, be sure to invoke Fragment#startActivityForResult(Intent, int) rather than android.app.Activity#startActivityForResult(Intent, int). If the Activity version of the method is invoked then this Fragment will never receive its Fragment#onActivityResult(int, int, Intent) callback.

If convenient, consider using a FlutterActivity instead of a FlutterFragment to avoid the work of forwarding calls.

FlutterFragment supports the use of an existing, cached io.flutter.embedding.engine.FlutterEngine. To use a cached io.flutter.embedding.engine.FlutterEngine, ensure that the io.flutter.embedding.engine.FlutterEngine is stored in io.flutter.embedding.engine.FlutterEngineCache and then use withCachedEngine(String) to build a FlutterFragment with the cached io.flutter.embedding.engine.FlutterEngine's ID.

It is generally recommended to use a cached io.flutter.embedding.engine.FlutterEngine to avoid a momentary delay when initializing a new io.flutter.embedding.engine.FlutterEngine. The two exceptions to using a cached FlutterEngine are:

When FlutterFragment is in the first Activity displayed by the app, because pre-warming a io.flutter.embedding.engine.FlutterEngine would have no impact in this situation.
When you are unsure when/if you will need to display a Flutter experience.

The following illustrates how to pre-warm and cache a io.flutter.embedding.engine.FlutterEngine:



// Create and pre-warm a FlutterEngine.

FlutterEngineGroup group = new FlutterEngineGroup(context);

FlutterEngine flutterEngine = group.createAndRunDefaultEngine(context);

flutterEngine

  .getDartExecutor()

  .executeDartEntrypoint(DartEntrypoint.createDefault());



// Cache the pre-warmed FlutterEngine in the FlutterEngineCache.

FlutterEngineCache.getInstance().put("my_engine", flutterEngine);

If Flutter is needed in a location that can only use a View, consider using a io.flutter.embedding.android.FlutterView. Using a io.flutter.embedding.android.FlutterView requires forwarding some calls from an Activity, as well as forwarding lifecycle calls from an Activity or a Fragment.

Definition at line 97 of file FlutterFragment.java.

Constructor & Destructor Documentation

◆ FlutterFragment()

io.flutter.embedding.android.FlutterFragment.FlutterFragment ( )

inline

Definition at line 1020 of file FlutterFragment.java.

                           {
    // Ensure that we at least have an empty Bundle of arguments so that we don't
    // need to continually check for null arguments before grabbing one.
    setArguments(new Bundle());
  }

Member Function Documentation

◆ attachToEngineAutomatically()

boolean io.flutter.embedding.android.FlutterFragment.attachToEngineAutomatically ( )

inline

Whether to automatically attach the FlutterView to the engine.

Returning false means that the task of attaching the FlutterView to the engine will be taken over by the host application.

Defaults to true.

Implements io.flutter.embedding.android.FlutterActivityAndFragmentDelegate.Host.

Definition at line 1654 of file FlutterFragment.java.

                                               {
    return true;
  }

◆ cleanUpFlutterEngine()

void io.flutter.embedding.android.FlutterFragment.cleanUpFlutterEngine ( @NonNull FlutterEngine flutterEngine )

inline

Hook for the host to cleanup references that were established in configureFlutterEngine(FlutterEngine) before the host is destroyed or detached.

This method is called in onDetach().

Implements io.flutter.embedding.android.FlutterActivityAndFragmentDelegate.Host.

Definition at line 1539 of file FlutterFragment.java.

                                                                         {
    FragmentActivity attachedActivity = getActivity();
    if (attachedActivity instanceof FlutterEngineConfigurator) {
      ((FlutterEngineConfigurator) attachedActivity).cleanUpFlutterEngine(flutterEngine);
    }
  }

◆ configureFlutterEngine()

void io.flutter.embedding.android.FlutterFragment.configureFlutterEngine ( @NonNull FlutterEngine flutterEngine )

inline

Configures a io.flutter.embedding.engine.FlutterEngine after its creation.

This method is called after provideFlutterEngine(Context), and after the given io.flutter.embedding.engine.FlutterEngine has been attached to the owning FragmentActivity. See io.flutter.embedding.engine.plugins.activity.ActivityControlSurface#attachToActivity( ExclusiveAppComponent, Lifecycle).

It is possible that the owning FragmentActivity opted not to connect itself as an io.flutter.embedding.engine.plugins.activity.ActivityControlSurface. In that case, any configuration, e.g., plugins, must not expect or depend upon an available Activity at the time that this method is invoked.

The default behavior of this method is to defer to the owning FragmentActivity as a io.flutter.embedding.android.FlutterEngineConfigurator. Subclasses can override this method if the subclass needs to override the FragmentActivity's behavior, or add to it.

Used by this FlutterFragment's FlutterActivityAndFragmentDelegate.Host

Implements io.flutter.embedding.android.FlutterActivityAndFragmentDelegate.Host.

Definition at line 1525 of file FlutterFragment.java.

                                                                           {
    FragmentActivity attachedActivity = getActivity();
    if (attachedActivity instanceof FlutterEngineConfigurator) {
      ((FlutterEngineConfigurator) attachedActivity).configureFlutterEngine(flutterEngine);
    }
  }

◆ createDefault()

static FlutterFragment io.flutter.embedding.android.FlutterFragment.createDefault ( )

inlinestatic

Creates a FlutterFragment with a default configuration.

FlutterFragment's default configuration creates a new io.flutter.embedding.engine.FlutterEngine within the FlutterFragment and uses the following settings:

Dart entrypoint: "main"
Initial route: "/"
Render mode: surface
Transparency mode: transparent

To use a new io.flutter.embedding.engine.FlutterEngine with different settings, use withNewEngine().

To use a cached io.flutter.embedding.engine.FlutterEngine instead of creating a new one, use withCachedEngine(String).

Definition at line 201 of file FlutterFragment.java.

                                                {
    return new NewEngineFragmentBuilder().build();
  }

◆ createDelegate()

FlutterActivityAndFragmentDelegate io.flutter.embedding.android.FlutterFragment.createDelegate ( FlutterActivityAndFragmentDelegate.Host host )

inline

Default delegate factory that creates a simple FlutterActivityAndFragmentDelegate instance.

Implements io.flutter.embedding.android.FlutterActivityAndFragmentDelegate.DelegateFactory.

Definition at line 1007 of file FlutterFragment.java.

                                                    {
    return new FlutterActivityAndFragmentDelegate(host);
  }

◆ detachFromFlutterEngine()

void io.flutter.embedding.android.FlutterFragment.detachFromFlutterEngine ( )

inline

Callback called when the io.flutter.embedding.engine.FlutterEngine has been attached to by another activity before this activity was destroyed.

The expected behavior is for this activity to synchronously stop using the FlutterEngine to avoid lifecycle crosstalk with the new activity.

Implements io.flutter.embedding.android.FlutterActivityAndFragmentDelegate.Host.

Definition at line 1156 of file FlutterFragment.java.

                                        {
    Log.w(
        TAG,
        "FlutterFragment "
            + this
            + " connection to the engine "
            + getFlutterEngine()
            + " evicted by another attaching activity");
    if (delegate != null) {
      // Redundant calls are ok.
      delegate.onDestroyView();
      delegate.onDetach();
    }
  }

◆ getAppBundlePath()

String io.flutter.embedding.android.FlutterFragment.getAppBundlePath ( )

inline

A custom path to the bundle that contains this Flutter app's resources, e.g., Dart code snapshots.

When unspecified, the value is null, which defaults to the app bundle path defined in io.flutter.embedding.engine.loader.FlutterLoader#findAppBundlePath().

Used by this FlutterFragment's FlutterActivityAndFragmentDelegate.Host

Implements io.flutter.embedding.android.FlutterActivityAndFragmentDelegate.Host.

Definition at line 1397 of file FlutterFragment.java.

                                   {
    return getArguments().getString(ARG_APP_BUNDLE_PATH);
  }

◆ getCachedEngineGroupId()

String io.flutter.embedding.android.FlutterFragment.getCachedEngineGroupId ( )

inline

Returns the ID of a statically cached io.flutter.embedding.engine.FlutterEngineGroup to use within this FlutterFragment, or null if this FlutterFragment does not want to use a cached io.flutter.embedding.engine.FlutterEngineGroup.

Implements io.flutter.embedding.android.FlutterActivityAndFragmentDelegate.Host.

Definition at line 1312 of file FlutterFragment.java.

                                         {
    return getArguments().getString(ARG_CACHED_ENGINE_GROUP_ID, null);
  }

◆ getCachedEngineId()

String io.flutter.embedding.android.FlutterFragment.getCachedEngineId ( )

inline

Returns the ID of a statically cached io.flutter.embedding.engine.FlutterEngine to use within this FlutterFragment, or null if this FlutterFragment does not want to use a cached io.flutter.embedding.engine.FlutterEngine.

Implements io.flutter.embedding.android.FlutterActivityAndFragmentDelegate.Host.

Definition at line 1301 of file FlutterFragment.java.

                                    {
    return getArguments().getString(ARG_CACHED_ENGINE_ID, null);
  }

◆ getDartEntrypointArgs()

List< String > io.flutter.embedding.android.FlutterFragment.getDartEntrypointArgs ( )

inline

The Dart entrypoint arguments will be passed as a list of string to Dart's entrypoint function.

A value of null means do not pass any arguments to Dart's entrypoint function.

Subclasses may override this method to directly control the Dart entrypoint arguments.

Implements io.flutter.embedding.android.FlutterActivityAndFragmentDelegate.Host.

Definition at line 1368 of file FlutterFragment.java.

                                              {
    return getArguments().getStringArrayList(ARG_DART_ENTRYPOINT_ARGS);
  }

◆ getDartEntrypointFunctionName()

String io.flutter.embedding.android.FlutterFragment.getDartEntrypointFunctionName ( )

inline

Returns the name of the Dart method that this FlutterFragment should execute to start a Flutter app.

Defaults to "main".

Used by this FlutterFragment's FlutterActivityAndFragmentDelegate.Host

Implements io.flutter.embedding.android.FlutterActivityAndFragmentDelegate.Host.

Definition at line 1355 of file FlutterFragment.java.

                                                {
    return getArguments().getString(ARG_DART_ENTRYPOINT, "main");
  }

◆ getDartEntrypointLibraryUri()

String io.flutter.embedding.android.FlutterFragment.getDartEntrypointLibraryUri ( )

inline

Returns the library URI of the Dart method that this FlutterFragment should execute to start a Flutter app.

Defaults to null (example value: "package:foo/bar.dart").

Used by this FlutterFragment's FlutterActivityAndFragmentDelegate.Host

Implements io.flutter.embedding.android.FlutterActivityAndFragmentDelegate.Host.

Definition at line 1382 of file FlutterFragment.java.

                                              {
    return getArguments().getString(ARG_DART_ENTRYPOINT_URI);
  }

◆ getExclusiveAppComponent()

ExclusiveAppComponent< Activity > io.flutter.embedding.android.FlutterFragment.getExclusiveAppComponent ( )

inline

Returns the Android App Component exclusively attached to io.flutter.embedding.engine.FlutterEngine.

Implements io.flutter.embedding.android.FlutterActivityAndFragmentDelegate.Host.

Definition at line 1048 of file FlutterFragment.java.

                                                                    {
    return delegate;
  }

◆ getFlutterEngine()

FlutterEngine io.flutter.embedding.android.FlutterFragment.getFlutterEngine ( )

inline

Hook for subclasses to obtain a reference to the io.flutter.embedding.engine.FlutterEngine that is owned by this FlutterActivity.

Definition at line 1489 of file FlutterFragment.java.

                                          {
    return delegate.getFlutterEngine();
  }

◆ getFlutterShellArgs()

FlutterShellArgs io.flutter.embedding.android.FlutterFragment.getFlutterShellArgs ( )

inline

FlutterActivityAndFragmentDelegate.Host method that is used by FlutterActivityAndFragmentDelegate to obtain Flutter shell arguments when initializing Flutter.

Implements io.flutter.embedding.android.FlutterActivityAndFragmentDelegate.Host.

Definition at line 1288 of file FlutterFragment.java.

                                                {
    String[] flutterShellArgsArray = getArguments().getStringArray(ARG_FLUTTER_INITIALIZATION_ARGS);
    return new FlutterShellArgs(
        flutterShellArgsArray != null ? flutterShellArgsArray : new String[] {});
  }

◆ getInitialRoute()

String io.flutter.embedding.android.FlutterFragment.getInitialRoute ( )

inline

Returns the initial route that should be rendered within Flutter, once the Flutter app starts.

Defaults to null, which signifies a route of "/" in Flutter.

Used by this FlutterFragment's FlutterActivityAndFragmentDelegate.Host

Implements io.flutter.embedding.android.FlutterActivityAndFragmentDelegate.Host.

Definition at line 1410 of file FlutterFragment.java.

                                  {
    return getArguments().getString(ARG_INITIAL_ROUTE);
  }

◆ getRenderMode()

RenderMode io.flutter.embedding.android.FlutterFragment.getRenderMode ( )

inline

Returns the desired RenderMode for the io.flutter.embedding.android.FlutterView displayed in this FlutterFragment.

Defaults to RenderMode#surface.

Used by this FlutterFragment's FlutterActivityAndFragmentDelegate.Host

Implements io.flutter.embedding.android.FlutterActivityAndFragmentDelegate.Host.

Definition at line 1424 of file FlutterFragment.java.

                                    {
    String renderModeName =
        getArguments().getString(ARG_FLUTTERVIEW_RENDER_MODE, RenderMode.surface.name());
    return RenderMode.valueOf(renderModeName);
  }

◆ getTransparencyMode()

TransparencyMode io.flutter.embedding.android.FlutterFragment.getTransparencyMode ( )

inline

Returns the desired TransparencyMode for the io.flutter.embedding.android.FlutterView displayed in this FlutterFragment.

Defaults to TransparencyMode#transparent.

Used by this FlutterFragment's FlutterActivityAndFragmentDelegate.Host

Implements io.flutter.embedding.android.FlutterActivityAndFragmentDelegate.Host.

Definition at line 1440 of file FlutterFragment.java.

                                                {
    String transparencyModeName =
        getArguments()
            .getString(ARG_FLUTTERVIEW_TRANSPARENCY_MODE, TransparencyMode.transparent.name());
    return TransparencyMode.valueOf(transparencyModeName);
  }

◆ isFlutterEngineInjected()

boolean io.flutter.embedding.android.FlutterFragment.isFlutterEngineInjected ( )

inlinepackage

Returns true a FlutterEngine was explicitly created and injected into the FlutterFragment rather than one that was created implicitly in the FlutterFragment.

Definition at line 1320 of file FlutterFragment.java.

                                      {
    return delegate.isFlutterEngineFromHost();
  }

◆ onActivityResult()

void io.flutter.embedding.android.FlutterFragment.onActivityResult	(	int	requestCode,
		int	resultCode,
		Intent	data
	)

inline

A result has been returned after an invocation of Fragment#startActivityForResult(Intent, int).

Parameters

requestCode	request code sent with `Fragment#startActivityForResult(Intent, int)`
resultCode	code representing the result of the `Activity` that was launched
data	any corresponding return data, held within an `Intent`

Definition at line 1246 of file FlutterFragment.java.

                                                                             {
    if (stillAttachedForEvent("onActivityResult")) {
      delegate.onActivityResult(requestCode, resultCode, data);
    }
  }

◆ onAttach()

void io.flutter.embedding.android.FlutterFragment.onAttach ( @NonNull Context context )

inline

Definition at line 1053 of file FlutterFragment.java.

                                                 {
    super.onAttach(context);
    delegate = delegateFactory.createDelegate(this);
    delegate.onAttach(context);
    if (getArguments().getBoolean(ARG_SHOULD_AUTOMATICALLY_HANDLE_ON_BACK_PRESSED, false)) {
      requireActivity().getOnBackPressedDispatcher().addCallback(this, onBackPressedCallback);
      // When Android handles a back gesture, it pops an Activity or goes back
      // to the home screen. When Flutter handles a back gesture, it pops a
      // route inside of the Flutter part of the app. By default, Android
      // handles back gestures, so this callback is disabled. If, for example,
      // the Flutter app has routes for which it wants to handle the back
      // gesture, then it will enable this callback using
      // setFrameworkHandlesBack.
      onBackPressedCallback.setEnabled(false);
    }
    context.registerComponentCallbacks(this);
  }

◆ onBackPressed()

void io.flutter.embedding.android.FlutterFragment.onBackPressed ( )

inline

The hardware back button was pressed.

If the fragment uses shouldAutomaticallyHandleOnBackPressed(true), this method should not be called through. It will be called automatically instead.

See android.app.Activity#onBackPressed()

Definition at line 1229 of file FlutterFragment.java.

                              {
    if (stillAttachedForEvent("onBackPressed")) {
      delegate.onBackPressed();
    }
  }

◆ onCreate()

void io.flutter.embedding.android.FlutterFragment.onCreate ( @Nullable Bundle savedInstanceState )

inline

Definition at line 1072 of file FlutterFragment.java.

                                                            {
    super.onCreate(savedInstanceState);
    delegate.onRestoreInstanceState(savedInstanceState);
  }

◆ onCreateView()

View io.flutter.embedding.android.FlutterFragment.onCreateView	(	LayoutInflater	inflater,
		@Nullable ViewGroup	container,
		@Nullable Bundle	savedInstanceState
	)

inline

Definition at line 1079 of file FlutterFragment.java.

                                                                                                   {
    return delegate.onCreateView(
        inflater,
        container,
        savedInstanceState,
        /*flutterViewId=*/ FLUTTER_VIEW_ID,
        shouldDelayFirstAndroidViewDraw());
  }

◆ onDestroyView()

void io.flutter.embedding.android.FlutterFragment.onDestroyView ( )

inline

Definition at line 1137 of file FlutterFragment.java.

                              {
    super.onDestroyView();
    requireView()
        .getViewTreeObserver()
        .removeOnWindowFocusChangeListener(onWindowFocusChangeListener);
    if (stillAttachedForEvent("onDestroyView")) {
      delegate.onDestroyView();
    }
  }

◆ onDetach()

void io.flutter.embedding.android.FlutterFragment.onDetach ( )

inline

Definition at line 1172 of file FlutterFragment.java.

                         {
    getContext().unregisterComponentCallbacks(this);
    super.onDetach();
    if (delegate != null) {
      delegate.onDetach();
      delegate.release();
      delegate = null;
    } else {
      Log.v(TAG, "FlutterFragment " + this + " onDetach called after release.");
    }
  }

◆ onFlutterSurfaceViewCreated()

void io.flutter.embedding.android.FlutterFragment.onFlutterSurfaceViewCreated ( @NonNull FlutterSurfaceView flutterSurfaceView )

inline

Invoked by this delegate when the FlutterSurfaceView that renders the Flutter UI is initially instantiated.

This method is only invoked if the io.flutter.embedding.android.FlutterView.RenderMode is set to io.flutter.embedding.android.FlutterView.RenderMode#surface. Otherwise, onFlutterTextureViewCreated(FlutterTextureView) is invoked.

This method is invoked before the given FlutterSurfaceView is attached to the View hierarchy. Implementers should not attempt to climb the View hierarchy or make assumptions about relationships with other Views.

Implements io.flutter.embedding.android.FlutterActivityAndFragmentDelegate.Host.

Definition at line 1567 of file FlutterFragment.java.

                                                                                          {
    // Hook for subclasses.
  }

◆ onFlutterTextureViewCreated()

void io.flutter.embedding.android.FlutterFragment.onFlutterTextureViewCreated ( @NonNull FlutterTextureView flutterTextureView )

inline

Invoked by this delegate when the FlutterTextureView that renders the Flutter UI is initially instantiated.

This method is only invoked if the io.flutter.embedding.android.FlutterView.RenderMode is set to io.flutter.embedding.android.FlutterView.RenderMode#texture. Otherwise, onFlutterSurfaceViewCreated(FlutterSurfaceView) is invoked.

This method is invoked before the given FlutterTextureView is attached to the View hierarchy. Implementers should not attempt to climb the View hierarchy or make assumptions about relationships with other Views.

Implements io.flutter.embedding.android.FlutterActivityAndFragmentDelegate.Host.

Definition at line 1572 of file FlutterFragment.java.

                                                                                          {
    // Hook for subclasses.
  }

◆ onFlutterUiDisplayed()

void io.flutter.embedding.android.FlutterFragment.onFlutterUiDisplayed ( )

inline

Invoked after the io.flutter.embedding.android.FlutterView within this FlutterFragment starts rendering pixels to the screen.

This method forwards onFlutterUiDisplayed() to its attached Activity, if the attached Activity implements FlutterUiDisplayListener.

Subclasses that override this method must call through to the super method.

Used by this FlutterFragment's FlutterActivityAndFragmentDelegate.Host

Implements io.flutter.embedding.android.FlutterActivityAndFragmentDelegate.Host.

Definition at line 1588 of file FlutterFragment.java.

                                     {
    FragmentActivity attachedActivity = getActivity();
    if (attachedActivity instanceof FlutterUiDisplayListener) {
      ((FlutterUiDisplayListener) attachedActivity).onFlutterUiDisplayed();
    }
  }

◆ onFlutterUiNoLongerDisplayed()

void io.flutter.embedding.android.FlutterFragment.onFlutterUiNoLongerDisplayed ( )

inline

Invoked after the io.flutter.embedding.android.FlutterView within this FlutterFragment stops rendering pixels to the screen.

This method forwards onFlutterUiNoLongerDisplayed() to its attached Activity, if the attached Activity implements FlutterUiDisplayListener.

Subclasses that override this method must call through to the super method.

Used by this FlutterFragment's FlutterActivityAndFragmentDelegate.Host

Implements io.flutter.embedding.android.FlutterActivityAndFragmentDelegate.Host.

Definition at line 1607 of file FlutterFragment.java.

                                             {
    FragmentActivity attachedActivity = getActivity();
    if (attachedActivity instanceof FlutterUiDisplayListener) {
      ((FlutterUiDisplayListener) attachedActivity).onFlutterUiNoLongerDisplayed();
    }
  }

◆ onNewIntent()

void io.flutter.embedding.android.FlutterFragment.onNewIntent ( @NonNull Intent intent )

inline

A new Intent was received by the android.app.Activity that currently owns this Fragment.

See android.app.Activity#onNewIntent(Intent)

Parameters

intent new Intent

Definition at line 1214 of file FlutterFragment.java.

                                                  {
    if (stillAttachedForEvent("onNewIntent")) {
      delegate.onNewIntent(intent);
    }
  }

◆ onPause()

void io.flutter.embedding.android.FlutterFragment.onPause ( )

inline

Definition at line 1115 of file FlutterFragment.java.

                        {
    super.onPause();
    if (stillAttachedForEvent("onPause")) {
      delegate.onPause();
    }
  }

◆ onPostResume()

void io.flutter.embedding.android.FlutterFragment.onPostResume ( )

inline

Definition at line 1108 of file FlutterFragment.java.

                             {
    if (stillAttachedForEvent("onPostResume")) {
      delegate.onPostResume();
    }
  }

◆ onRequestPermissionsResult()

void io.flutter.embedding.android.FlutterFragment.onRequestPermissionsResult	(	int	requestCode,
		@NonNull String[]	permissions,
		@NonNull int[]	grantResults
	)

inline

The result of a permission request has been received.

See android.app.Activity#onRequestPermissionsResult(int, String[], int[])

Parameters

requestCode	identifier passed with the initial permission request
permissions	permissions that were requested
grantResults	permission grants or denials

Definition at line 1196 of file FlutterFragment.java.

                                                                                   {
    if (stillAttachedForEvent("onRequestPermissionsResult")) {
      delegate.onRequestPermissionsResult(requestCode, permissions, grantResults);
    }
  }

◆ onResume()

void io.flutter.embedding.android.FlutterFragment.onResume ( )

inline

Definition at line 1098 of file FlutterFragment.java.

                         {
    super.onResume();
    if (stillAttachedForEvent("onResume")) {
      delegate.onResume();
    }
  }

◆ onSaveInstanceState()

void io.flutter.embedding.android.FlutterFragment.onSaveInstanceState ( Bundle outState )

inline

Definition at line 1148 of file FlutterFragment.java.

                                                   {
    super.onSaveInstanceState(outState);
    if (stillAttachedForEvent("onSaveInstanceState")) {
      delegate.onSaveInstanceState(outState);
    }
  }

◆ onStart()

void io.flutter.embedding.android.FlutterFragment.onStart ( )

inline

Definition at line 1090 of file FlutterFragment.java.

                        {
    super.onStart();
    if (stillAttachedForEvent("onStart")) {
      delegate.onStart();
    }
  }

◆ onStop()

void io.flutter.embedding.android.FlutterFragment.onStop ( )

inline

Definition at line 1123 of file FlutterFragment.java.

                       {
    super.onStop();
    if (stillAttachedForEvent("onStop")) {
      delegate.onStop();
    }
  }

◆ onTrimMemory()

void io.flutter.embedding.android.FlutterFragment.onTrimMemory ( int level )

inline

Callback invoked when memory is low.

This implementation forwards a memory pressure warning to the running Flutter app.

Parameters

level level

Definition at line 1275 of file FlutterFragment.java.

                                      {
    if (stillAttachedForEvent("onTrimMemory")) {
      delegate.onTrimMemory(level);
    }
  }

◆ onUserLeaveHint()

void io.flutter.embedding.android.FlutterFragment.onUserLeaveHint ( )

inline

The android.app.Activity that owns this Fragment is about to go to the background as the result of a user's choice/action, i.e., not as the result of an OS decision.

See android.app.Activity#onUserLeaveHint()

Definition at line 1259 of file FlutterFragment.java.

                                {
    if (stillAttachedForEvent("onUserLeaveHint")) {
      delegate.onUserLeaveHint();
    }
  }

◆ onViewCreated()

void io.flutter.embedding.android.FlutterFragment.onViewCreated	(	View	view,
		Bundle	savedInstanceState
	)

inline

Definition at line 1131 of file FlutterFragment.java.

                                                                  {
    super.onViewCreated(view, savedInstanceState);
    view.getViewTreeObserver().addOnWindowFocusChangeListener(onWindowFocusChangeListener);
  }

◆ popSystemNavigator()

boolean io.flutter.embedding.android.FlutterFragment.popSystemNavigator ( )

inline

Allow implementer to customize the behavior needed when the Flutter framework calls to pop the Android-side navigation stack.

Returns: true if the implementation consumed the pop signal. If false, a default behavior of finishing the activity or sending the signal to androidx.activity.OnBackPressedDispatcher will be executed.

Avoid overriding this method when using shouldAutomaticallyHandleOnBackPressed(true). If you do, you must always return super.popSystemNavigator() rather than return false. Otherwise the navigation behavior will recurse infinitely between this method and onBackPressed(), breaking navigation.

Implements io.flutter.plugin.platform.PlatformPlugin.PlatformPluginDelegate.

Definition at line 1667 of file FlutterFragment.java.

                                      {
    if (getArguments().getBoolean(ARG_SHOULD_AUTOMATICALLY_HANDLE_ON_BACK_PRESSED, false)) {
      FragmentActivity activity = getActivity();
      if (activity != null) {
        // Unless we disable the callback, the dispatcher call will trigger it. This will then
        // trigger the fragment's onBackPressed() implementation, which will call through to the
        // dart side and likely call back through to this method, creating an infinite call loop.
        boolean enabledAtStart = onBackPressedCallback.isEnabled();
        if (enabledAtStart) {
          onBackPressedCallback.setEnabled(false);
        }
        activity.getOnBackPressedDispatcher().onBackPressed();
        if (enabledAtStart) {
          onBackPressedCallback.setEnabled(true);
        }
        return true;
      }
    }
    // Hook for subclass. No-op if returns false.
    return false;
  }

◆ provideFlutterEngine()

FlutterEngine io.flutter.embedding.android.FlutterFragment.provideFlutterEngine ( @NonNull Context context )

inline

Hook for subclasses to return a io.flutter.embedding.engine.FlutterEngine with whatever configuration is desired.

By default this method defers to this FlutterFragment's surrounding Activity, if that Activity implements io.flutter.embedding.android.FlutterEngineProvider. If this method is overridden, the surrounding Activity will no longer be given an opportunity to provide a io.flutter.embedding.engine.FlutterEngine, unless the subclass explicitly implements that behavior.

Consider returning a cached io.flutter.embedding.engine.FlutterEngine instance from this method to avoid the typical warm-up time that a new io.flutter.embedding.engine.FlutterEngine instance requires.

If null is returned then a new default io.flutter.embedding.engine.FlutterEngine will be created to back this FlutterFragment.

Used by this FlutterFragment's FlutterActivityAndFragmentDelegate.Host

Implements io.flutter.embedding.android.FlutterActivityAndFragmentDelegate.Host.

Definition at line 1469 of file FlutterFragment.java.

                                                                      {
    // Defer to the FragmentActivity that owns us to see if it wants to provide a
    // FlutterEngine.
    FlutterEngine flutterEngine = null;
    FragmentActivity attachedActivity = getActivity();
    if (attachedActivity instanceof FlutterEngineProvider) {
      // Defer to the Activity that owns us to provide a FlutterEngine.
      Log.v(TAG, "Deferring to attached Activity to provide a FlutterEngine.");
      FlutterEngineProvider flutterEngineProvider = (FlutterEngineProvider) attachedActivity;
      flutterEngine = flutterEngineProvider.provideFlutterEngine(getContext());
    }
 
    return flutterEngine;
  }

◆ providePlatformPlugin()

PlatformPlugin io.flutter.embedding.android.FlutterFragment.providePlatformPlugin	(	@Nullable Activity	activity,
		@NonNull FlutterEngine	flutterEngine
	)

inline

Hook for the host to create/provide a PlatformPlugin if the associated Flutter experience should control system chrome.

Implements io.flutter.embedding.android.FlutterActivityAndFragmentDelegate.Host.

Definition at line 1495 of file FlutterFragment.java.

                                                                         {
    if (activity != null) {
      return new PlatformPlugin(getActivity(), flutterEngine.getPlatformChannel(), this);
    } else {
      return null;
    }
  }

◆ setDelegateFactory()

void io.flutter.embedding.android.FlutterFragment.setDelegateFactory ( @NonNull FlutterActivityAndFragmentDelegate.DelegateFactory delegateFactory )

inlinepackage

This method exists so that JVM tests can ensure that a delegate exists without putting this Fragment through any lifecycle events, because JVM tests cannot handle executing any lifecycle methods, at the time of writing this.

The testing infrastructure should be upgraded to make FlutterFragment tests easy to write while exercising real lifecycle methods. At such a time, this method should be removed.

Definition at line 1037 of file FlutterFragment.java.

                                                                                   {
    this.delegateFactory = delegateFactory;
    delegate = delegateFactory.createDelegate(this);
  }

◆ setFrameworkHandlesBack()

void io.flutter.embedding.android.FlutterFragment.setFrameworkHandlesBack ( boolean frameworkHandlesBack )

inline

The Flutter application would or would not like to handle navigation pop events itself.

Relevant for registering and unregistering the app's OnBackInvokedCallback for the Predictive Back feature, for example as in io.flutter.embedding.android.FlutterActivity.

Implements io.flutter.plugin.platform.PlatformPlugin.PlatformPluginDelegate.

Definition at line 1690 of file FlutterFragment.java.

                                                                    {
    if (!getArguments().getBoolean(ARG_SHOULD_AUTOMATICALLY_HANDLE_ON_BACK_PRESSED, false)) {
      return;
    }
    onBackPressedCallback.setEnabled(frameworkHandlesBack);
  }

◆ shouldAttachEngineToActivity()

boolean io.flutter.embedding.android.FlutterFragment.shouldAttachEngineToActivity ( )

inline

See NewEngineFragmentBuilder#shouldAttachEngineToActivity() and CachedEngineFragmentBuilder#shouldAttachEngineToActivity().

Used by this FlutterFragment's FlutterActivityAndFragmentDelegate

Implements io.flutter.embedding.android.FlutterActivityAndFragmentDelegate.Host.

Definition at line 1553 of file FlutterFragment.java.

                                                {
    return getArguments().getBoolean(ARG_SHOULD_ATTACH_ENGINE_TO_ACTIVITY);
  }

◆ shouldDelayFirstAndroidViewDraw()

boolean io.flutter.embedding.android.FlutterFragment.shouldDelayFirstAndroidViewDraw ( )

inlinepackage

Definition at line 1699 of file FlutterFragment.java.

                                            {
    return getArguments().getBoolean(ARG_SHOULD_DELAY_FIRST_ANDROID_VIEW_DRAW);
  }

◆ shouldDestroyEngineWithHost()

boolean io.flutter.embedding.android.FlutterFragment.shouldDestroyEngineWithHost ( )

inline

Returns false if the io.flutter.embedding.engine.FlutterEngine within this FlutterFragment should outlive the FlutterFragment, itself.

Defaults to true if no custom is provided, false if a custom FlutterEngine is provided.

Implements io.flutter.embedding.android.FlutterActivityAndFragmentDelegate.Host.

Definition at line 1332 of file FlutterFragment.java.

                                               {
    boolean explicitDestructionRequested =
        getArguments().getBoolean(ARG_DESTROY_ENGINE_WITH_FRAGMENT, false);
    if (getCachedEngineId() != null || delegate.isFlutterEngineFromHost()) {
      // Only destroy a cached engine if explicitly requested by app developer.
      return explicitDestructionRequested;
    } else {
      // If this Fragment created the FlutterEngine, destroy it by default unless
      // explicitly requested not to.
      return getArguments().getBoolean(ARG_DESTROY_ENGINE_WITH_FRAGMENT, true);
    }
  }

◆ shouldDispatchAppLifecycleState()

boolean io.flutter.embedding.android.FlutterFragment.shouldDispatchAppLifecycleState ( )

inline

Give the host application a chance to take control of the app lifecycle events.

Return false means the host application dispatches these app lifecycle events, while return true means the engine dispatches these events.

Defaults to true.

Implements io.flutter.embedding.android.FlutterActivityAndFragmentDelegate.Host.

Definition at line 1641 of file FlutterFragment.java.

                                                   {
    return true;
  }

◆ shouldHandleDeeplinking()

boolean io.flutter.embedding.android.FlutterFragment.shouldHandleDeeplinking ( )

inline

Whether to handle the deeplinking from the Intent automatically if the getInitialRoute returns null.

Implements io.flutter.embedding.android.FlutterActivityAndFragmentDelegate.Host.

Definition at line 1562 of file FlutterFragment.java.

                                           {
    return getArguments().getBoolean(ARG_HANDLE_DEEPLINKING);
  }

◆ shouldRestoreAndSaveState()

boolean io.flutter.embedding.android.FlutterFragment.shouldRestoreAndSaveState ( )

inline

Whether state restoration is enabled.

When this returns true, the instance state provided to onRestoreInstanceState(Bundle) will be forwarded to the framework via the RestorationChannel and during onSaveInstanceState(Bundle) the current framework instance state obtained from RestorationChannel will be stored in the provided bundle.

This defaults to true, unless a cached engine is used.

Implements io.flutter.embedding.android.FlutterActivityAndFragmentDelegate.Host.

Definition at line 1615 of file FlutterFragment.java.

                                             {
    if (getArguments().containsKey(ARG_ENABLE_STATE_RESTORATION)) {
      return getArguments().getBoolean(ARG_ENABLE_STATE_RESTORATION);
    }
    if (getCachedEngineId() != null) {
      return false;
    }
    return true;
  }

◆ updateSystemUiOverlays()

void io.flutter.embedding.android.FlutterFragment.updateSystemUiOverlays ( )

inline

Refreshes Android's window system UI (AKA system chrome) to match Flutter's desired system chrome style.

This is useful when using the splash screen API available in Android 12. SplashScreenView#remove resets the system UI colors to the values set prior to the execution of the Dart entrypoint. As a result, the values set from Dart are reverted by this API. To workaround this issue, call this method after removing the splash screen with SplashScreenView#remove.

Implements io.flutter.embedding.android.FlutterActivityAndFragmentDelegate.Host.

Definition at line 1626 of file FlutterFragment.java.

                                       {
    if (delegate != null) {
      delegate.updateSystemUiOverlays();
    }
  }

◆ withCachedEngine()

static CachedEngineFragmentBuilder io.flutter.embedding.android.FlutterFragment.withCachedEngine ( @NonNull String engineId )

inlinestatic

Returns a CachedEngineFragmentBuilder to create a FlutterFragment with a cached io.flutter.embedding.engine.FlutterEngine in io.flutter.embedding.engine.FlutterEngineCache.

An IllegalStateException will be thrown during the lifecycle of the FlutterFragment if a cached io.flutter.embedding.engine.FlutterEngine is requested but does not exist in the cache.

To create a FlutterFragment that uses a new io.flutter.embedding.engine.FlutterEngine, use createDefault() or withNewEngine().

Definition at line 514 of file FlutterFragment.java.

                                                                                       {
    return new CachedEngineFragmentBuilder(engineId);
  }

◆ withNewEngine()

static NewEngineFragmentBuilder io.flutter.embedding.android.FlutterFragment.withNewEngine ( )

inlinestatic

Returns a NewEngineFragmentBuilder to create a FlutterFragment with a new io.flutter.embedding.engine.FlutterEngine and a desired engine configuration.

Definition at line 210 of file FlutterFragment.java.

                                                         {
    return new NewEngineFragmentBuilder();
  }

◆ withNewEngineInGroup()

static NewEngineInGroupFragmentBuilder io.flutter.embedding.android.FlutterFragment.withNewEngineInGroup ( @NonNull String engineGroupId )

inlinestatic

Returns a NewEngineInGroupFragmentBuilder to create a FlutterFragment with a cached io.flutter.embedding.engine.FlutterEngineGroup in io.flutter.embedding.engine.FlutterEngineGroupCache.

An IllegalStateException will be thrown during the lifecycle of the FlutterFragment if a cached io.flutter.embedding.engine.FlutterEngineGroup is requested but does not exist in the io.flutter.embedding.engine.FlutterEngineGroupCache.

Definition at line 757 of file FlutterFragment.java.

                                     {
    return new NewEngineInGroupFragmentBuilder(engineGroupId);
  }

Member Data Documentation

◆ ARG_APP_BUNDLE_PATH

final String io.flutter.embedding.android.FlutterFragment.ARG_APP_BUNDLE_PATH = "app_bundle_path"

staticprotected

Path to Flutter's Dart code.

Definition at line 122 of file FlutterFragment.java.

◆ ARG_CACHED_ENGINE_GROUP_ID

final String io.flutter.embedding.android.FlutterFragment.ARG_CACHED_ENGINE_GROUP_ID = "cached_engine_group_id"

staticprotected

Definition at line 149 of file FlutterFragment.java.

◆ ARG_CACHED_ENGINE_ID

final String io.flutter.embedding.android.FlutterFragment.ARG_CACHED_ENGINE_ID = "cached_engine_id"

staticprotected

The ID of a io.flutter.embedding.engine.FlutterEngine cached in io.flutter.embedding.engine.FlutterEngineCache that will be used within the created FlutterFragment.

Definition at line 147 of file FlutterFragment.java.

◆ ARG_DART_ENTRYPOINT

final String io.flutter.embedding.android.FlutterFragment.ARG_DART_ENTRYPOINT = "dart_entrypoint"

staticprotected

The Dart entrypoint method name that is executed upon initialization.

Definition at line 112 of file FlutterFragment.java.

◆ ARG_DART_ENTRYPOINT_ARGS

final String io.flutter.embedding.android.FlutterFragment.ARG_DART_ENTRYPOINT_ARGS = "dart_entrypoint_args"

staticprotected

The Dart entrypoint arguments that is executed upon initialization.

Definition at line 116 of file FlutterFragment.java.

◆ ARG_DART_ENTRYPOINT_URI

final String io.flutter.embedding.android.FlutterFragment.ARG_DART_ENTRYPOINT_URI = "dart_entrypoint_uri"

staticprotected

The Dart entrypoint method's URI that is executed upon initialization.

Definition at line 114 of file FlutterFragment.java.

◆ ARG_DESTROY_ENGINE_WITH_FRAGMENT

final String io.flutter.embedding.android.FlutterFragment.ARG_DESTROY_ENGINE_WITH_FRAGMENT = "destroy_engine_with_fragment"

staticprotected

True if the io.flutter.embedding.engine.FlutterEngine in the created FlutterFragment should be destroyed when the FlutterFragment is destroyed, false if the io.flutter.embedding.engine.FlutterEngine should outlive the FlutterFragment.

Definition at line 157 of file FlutterFragment.java.

◆ ARG_ENABLE_STATE_RESTORATION

final String io.flutter.embedding.android.FlutterFragment.ARG_ENABLE_STATE_RESTORATION = "enable_state_restoration"

staticprotected

True if the framework state in the engine attached to this engine should be stored and restored when this fragment is created and destroyed.

Definition at line 162 of file FlutterFragment.java.

◆ ARG_FLUTTER_INITIALIZATION_ARGS

final String io.flutter.embedding.android.FlutterFragment.ARG_FLUTTER_INITIALIZATION_ARGS = "initialization_args"

staticprotected

Flutter shell arguments.

Definition at line 128 of file FlutterFragment.java.

◆ ARG_FLUTTERVIEW_RENDER_MODE

final String io.flutter.embedding.android.FlutterFragment.ARG_FLUTTERVIEW_RENDER_MODE = "flutterview_render_mode"

staticprotected

RenderMode to be used for the io.flutter.embedding.android.FlutterView in this FlutterFragment

Definition at line 133 of file FlutterFragment.java.

◆ ARG_FLUTTERVIEW_TRANSPARENCY_MODE

final String io.flutter.embedding.android.FlutterFragment.ARG_FLUTTERVIEW_TRANSPARENCY_MODE = "flutterview_transparency_mode"

staticprotected

TransparencyMode to be used for the io.flutter.embedding.android.FlutterView in this FlutterFragment

Definition at line 138 of file FlutterFragment.java.

◆ ARG_HANDLE_DEEPLINKING

final String io.flutter.embedding.android.FlutterFragment.ARG_HANDLE_DEEPLINKING = "handle_deeplinking"

staticprotected

Whether the activity delegate should handle the deeplinking request.

Definition at line 120 of file FlutterFragment.java.

◆ ARG_INITIAL_ROUTE

final String io.flutter.embedding.android.FlutterFragment.ARG_INITIAL_ROUTE = "initial_route"

staticprotected

Initial Flutter route that is rendered in a Navigator widget.

Definition at line 118 of file FlutterFragment.java.

◆ ARG_SHOULD_ATTACH_ENGINE_TO_ACTIVITY

final String io.flutter.embedding.android.FlutterFragment.ARG_SHOULD_ATTACH_ENGINE_TO_ACTIVITY

staticprotected

Initial value:

=

"should_attach_engine_to_activity"

See shouldAttachEngineToActivity().

Definition at line 140 of file FlutterFragment.java.

◆ ARG_SHOULD_AUTOMATICALLY_HANDLE_ON_BACK_PRESSED

final String io.flutter.embedding.android.FlutterFragment.ARG_SHOULD_AUTOMATICALLY_HANDLE_ON_BACK_PRESSED

staticprotected

Initial value:

=

"should_automatically_handle_on_back_pressed"

True if the fragment should receive onBackPressed() events automatically, without requiring an explicit activity call through.

Definition at line 167 of file FlutterFragment.java.

◆ ARG_SHOULD_DELAY_FIRST_ANDROID_VIEW_DRAW

final String io.flutter.embedding.android.FlutterFragment.ARG_SHOULD_DELAY_FIRST_ANDROID_VIEW_DRAW

staticprotected

Initial value:

=

"should_delay_first_android_view_draw"

Whether to delay the Android drawing pass till after the Flutter UI has been displayed.

Definition at line 124 of file FlutterFragment.java.

◆ delegate

FlutterActivityAndFragmentDelegate io.flutter.embedding.android.FlutterFragment.delegate

package

Definition at line 1002 of file FlutterFragment.java.

◆ FLUTTER_VIEW_ID

final int io.flutter.embedding.android.FlutterFragment.FLUTTER_VIEW_ID = View.generateViewId()

static

The ID of the FlutterView created by this activity.

This ID can be used to lookup FlutterView in the Android view hierarchy. For more, see android.view.View#findViewById.

Definition at line 107 of file FlutterFragment.java.

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

shell/platform/android/io/flutter/embedding/android/FlutterFragment.java

Classes

Public Member Functions

Static Public Member Functions

Static Public Attributes

Static Protected Attributes

Package Functions

Package Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FlutterFragment()

Member Function Documentation

◆ attachToEngineAutomatically()

◆ cleanUpFlutterEngine()

◆ configureFlutterEngine()

◆ createDefault()

◆ createDelegate()

◆ detachFromFlutterEngine()

◆ getAppBundlePath()

◆ getCachedEngineGroupId()

◆ getCachedEngineId()

◆ getDartEntrypointArgs()

◆ getDartEntrypointFunctionName()

◆ getDartEntrypointLibraryUri()

◆ getExclusiveAppComponent()

◆ getFlutterEngine()

◆ getFlutterShellArgs()

◆ getInitialRoute()

◆ getRenderMode()

◆ getTransparencyMode()

◆ isFlutterEngineInjected()

◆ onActivityResult()

◆ onAttach()

◆ onBackPressed()

◆ onCreate()

◆ onCreateView()

◆ onDestroyView()

◆ onDetach()

◆ onFlutterSurfaceViewCreated()

◆ onFlutterTextureViewCreated()

◆ onFlutterUiDisplayed()

◆ onFlutterUiNoLongerDisplayed()

◆ onNewIntent()

◆ onPause()

◆ onPostResume()

◆ onRequestPermissionsResult()

◆ onResume()

◆ onSaveInstanceState()

◆ onStart()

◆ onStop()

◆ onTrimMemory()

◆ onUserLeaveHint()

◆ onViewCreated()

◆ popSystemNavigator()

◆ provideFlutterEngine()

◆ providePlatformPlugin()

◆ setDelegateFactory()

◆ setFrameworkHandlesBack()

◆ shouldAttachEngineToActivity()

◆ shouldDelayFirstAndroidViewDraw()

◆ shouldDestroyEngineWithHost()

◆ shouldDispatchAppLifecycleState()

◆ shouldHandleDeeplinking()

◆ shouldRestoreAndSaveState()

◆ updateSystemUiOverlays()

◆ withCachedEngine()

◆ withNewEngine()

◆ withNewEngineInGroup()

Member Data Documentation

◆ ARG_APP_BUNDLE_PATH

◆ ARG_CACHED_ENGINE_GROUP_ID

◆ ARG_CACHED_ENGINE_ID

◆ ARG_DART_ENTRYPOINT

◆ ARG_DART_ENTRYPOINT_ARGS

◆ ARG_DART_ENTRYPOINT_URI

◆ ARG_DESTROY_ENGINE_WITH_FRAGMENT

◆ ARG_ENABLE_STATE_RESTORATION

◆ ARG_FLUTTER_INITIALIZATION_ARGS

◆ ARG_FLUTTERVIEW_RENDER_MODE

◆ ARG_FLUTTERVIEW_TRANSPARENCY_MODE

◆ ARG_HANDLE_DEEPLINKING