io.flutter.embedding.android.FlutterFragment.NewEngineFragmentBuilder Class Reference

Public Member Functions
	NewEngineFragmentBuilder ()
	NewEngineFragmentBuilder (@NonNull Class<? extends FlutterFragment > subclass)
NewEngineFragmentBuilder	dartEntrypoint (@NonNull String dartEntrypoint)
NewEngineFragmentBuilder	dartLibraryUri (@NonNull String dartLibraryUri)
NewEngineFragmentBuilder	dartEntrypointArgs (@NonNull List< String > dartEntrypointArgs)
NewEngineFragmentBuilder	initialRoute (@NonNull String initialRoute)
NewEngineFragmentBuilder	handleDeeplinking (@NonNull Boolean handleDeeplinking)
NewEngineFragmentBuilder	appBundlePath (@NonNull String appBundlePath)
NewEngineFragmentBuilder	flutterShellArgs (@NonNull FlutterShellArgs shellArgs)
NewEngineFragmentBuilder	renderMode (@NonNull RenderMode renderMode)
NewEngineFragmentBuilder	transparencyMode (@NonNull TransparencyMode transparencyMode)
NewEngineFragmentBuilder	shouldAttachEngineToActivity (boolean shouldAttachEngineToActivity)
NewEngineFragmentBuilder	shouldAutomaticallyHandleOnBackPressed (boolean shouldAutomaticallyHandleOnBackPressed)
NewEngineFragmentBuilder	shouldDelayFirstAndroidViewDraw (boolean shouldDelayFirstAndroidViewDraw)

Protected Member Functions
Bundle	createArgs ()

Package Functions
public< T extends FlutterFragment > T	build ()

Detailed Description

Builder that creates a new FlutterFragment with arguments that correspond to the values set on this NewEngineFragmentBuilder.

To create a FlutterFragment with default arguments, invoke createDefault().

Subclasses of FlutterFragment that do not introduce any new arguments can use this NewEngineFragmentBuilder to construct instances of the subclass without subclassing this NewEngineFragmentBuilder. MyFlutterFragment f = new
FlutterFragment.NewEngineFragmentBuilder(MyFlutterFragment.class) .someProperty(...)
.someOtherProperty(...) .build<MyFlutterFragment>();

Subclasses of FlutterFragment that introduce new arguments should subclass this NewEngineFragmentBuilder to add the new properties:

1. Ensure the FlutterFragment subclass has a no-arg constructor.
2. Subclass this NewEngineFragmentBuilder.
3. Override the new NewEngineFragmentBuilder's no-arg constructor and invoke the super constructor to set the FlutterFragment subclass: public MyBuilder()
{ super(MyFlutterFragment.class); }
4. Add appropriate property methods for the new properties.
5. Override NewEngineFragmentBuilder#createArgs(), call through to the super method, then add the new properties as arguments in the Bundle.

Once a NewEngineFragmentBuilder subclass is defined, the FlutterFragment subclass can be instantiated as follows. MyFlutterFragment f = new MyBuilder()
.someExistingProperty(...) .someNewProperty(...) .build<MyFlutterFragment>();

Definition at line 245 of file FlutterFragment.java.

Constructor & Destructor Documentation

NewEngineFragmentBuilder() [1/2]

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

inline

Constructs a NewEngineFragmentBuilder that is configured to construct an instance of FlutterFragment.

Definition at line 264 of file FlutterFragment.java.

                                      {
      fragmentClass = FlutterFragment.class;
    }

NewEngineFragmentBuilder() [2/2]

io.flutter.embedding.android.FlutterFragment.NewEngineFragmentBuilder.NewEngineFragmentBuilder ( @NonNull Class<? extends FlutterFragment >  subclass )

inline

Constructs a NewEngineFragmentBuilder that is configured to construct an instance of subclass, which extends FlutterFragment.

Definition at line 272 of file FlutterFragment.java.

                                                                                        {
      fragmentClass = subclass;
    }

Member Function Documentation

appBundlePath()

NewEngineFragmentBuilder io.flutter.embedding.android.FlutterFragment.NewEngineFragmentBuilder.appBundlePath ( @NonNull String  appBundlePath )

inline

The path to the app bundle which contains the Dart app to execute. Null when unspecified, which defaults to io.flutter.embedding.engine.loader.FlutterLoader#findAppBundlePath()

Definition at line 322 of file FlutterFragment.java.

                                                                                 {
      this.appBundlePath = appBundlePath;
      return this;
    }

build()

public< T extends FlutterFragment > T io.flutter.embedding.android.FlutterFragment.NewEngineFragmentBuilder.build ( )

inlinepackage

Constructs a new FlutterFragment (or a subclass) that is configured based on properties set on this Builder.

Definition at line 478 of file FlutterFragment.java.

                                                 {
      try {
        @SuppressWarnings("unchecked")
        T frag = (T) fragmentClass.getDeclaredConstructor().newInstance();
        if (frag == null) {
          throw new RuntimeException(
              "The FlutterFragment subclass sent in the constructor ("
                  + fragmentClass.getCanonicalName()
                  + ") does not match the expected return type.");
        }
 
        Bundle args = createArgs();
        frag.setArguments(args);
 
        return frag;
      } catch (Exception e) {
        throw new RuntimeException(
            "Could not instantiate FlutterFragment subclass (" + fragmentClass.getName() + ")", e);
      }
    }

createArgs()

Bundle io.flutter.embedding.android.FlutterFragment.NewEngineFragmentBuilder.createArgs ( )

inlineprotected

Creates a Bundle of arguments that are assigned to the new FlutterFragment.

Subclasses should override this method to add new properties to the Bundle. Subclasses must call through to the super method to collect all existing property values.

Definition at line 444 of file FlutterFragment.java.

                                  {
      Bundle args = new Bundle();
      args.putString(ARG_INITIAL_ROUTE, initialRoute);
      args.putBoolean(ARG_HANDLE_DEEPLINKING, handleDeeplinking);
      args.putString(ARG_APP_BUNDLE_PATH, appBundlePath);
      args.putString(ARG_DART_ENTRYPOINT, dartEntrypoint);
      args.putString(ARG_DART_ENTRYPOINT_URI, dartLibraryUri);
      args.putStringArrayList(
          ARG_DART_ENTRYPOINT_ARGS,
          dartEntrypointArgs != null ? new ArrayList(dartEntrypointArgs) : null);
      // TODO(mattcarroll): determine if we should have an explicit FlutterTestFragment instead of
      // conflating.
      if (null != shellArgs) {
        args.putStringArray(ARG_FLUTTER_INITIALIZATION_ARGS, shellArgs.toArray());
      }
      args.putString(
          ARG_FLUTTERVIEW_RENDER_MODE,
          renderMode != null ? renderMode.name() : RenderMode.surface.name());
      args.putString(
          ARG_FLUTTERVIEW_TRANSPARENCY_MODE,
          transparencyMode != null ? transparencyMode.name() : TransparencyMode.transparent.name());
      args.putBoolean(ARG_SHOULD_ATTACH_ENGINE_TO_ACTIVITY, shouldAttachEngineToActivity);
      args.putBoolean(ARG_DESTROY_ENGINE_WITH_FRAGMENT, true);
      args.putBoolean(
          ARG_SHOULD_AUTOMATICALLY_HANDLE_ON_BACK_PRESSED, shouldAutomaticallyHandleOnBackPressed);
      args.putBoolean(ARG_SHOULD_DELAY_FIRST_ANDROID_VIEW_DRAW, shouldDelayFirstAndroidViewDraw);
      return args;
    }

dartEntrypoint()

NewEngineFragmentBuilder io.flutter.embedding.android.FlutterFragment.NewEngineFragmentBuilder.dartEntrypoint ( @NonNull String  dartEntrypoint )

inline

The name of the initial Dart method to invoke, defaults to "main".

Definition at line 278 of file FlutterFragment.java.

                                                                                   {
      this.dartEntrypoint = dartEntrypoint;
      return this;
    }

dartEntrypointArgs()

NewEngineFragmentBuilder io.flutter.embedding.android.FlutterFragment.NewEngineFragmentBuilder.dartEntrypointArgs ( @NonNull List< String >  dartEntrypointArgs )

inline

Arguments passed as a list of string to Dart's entrypoint function.

Definition at line 291 of file FlutterFragment.java.

                                                                                                 {
      this.dartEntrypointArgs = dartEntrypointArgs;
      return this;
    }

dartLibraryUri()

NewEngineFragmentBuilder io.flutter.embedding.android.FlutterFragment.NewEngineFragmentBuilder.dartLibraryUri ( @NonNull String  dartLibraryUri )

inline

Definition at line 284 of file FlutterFragment.java.

                                                                                   {
      this.dartLibraryUri = dartLibraryUri;
      return this;
    }

flutterShellArgs()

NewEngineFragmentBuilder io.flutter.embedding.android.FlutterFragment.NewEngineFragmentBuilder.flutterShellArgs ( @NonNull FlutterShellArgs  shellArgs )

inline

Any special configuration arguments for the Flutter engine

Definition at line 329 of file FlutterFragment.java.

                                                                                          {
      this.shellArgs = shellArgs;
      return this;
    }

handleDeeplinking()

NewEngineFragmentBuilder io.flutter.embedding.android.FlutterFragment.NewEngineFragmentBuilder.handleDeeplinking ( @NonNull Boolean  handleDeeplinking )

inline

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

Definition at line 311 of file FlutterFragment.java.

                                                                                          {
      this.handleDeeplinking = handleDeeplinking;
      return this;
    }

initialRoute()

NewEngineFragmentBuilder io.flutter.embedding.android.FlutterFragment.NewEngineFragmentBuilder.initialRoute ( @NonNull String  initialRoute )

inline

The initial route that a Flutter app will render in this FlutterFragment, defaults to "/".

Definition at line 301 of file FlutterFragment.java.

                                                                               {
      this.initialRoute = initialRoute;
      return this;
    }

renderMode()

NewEngineFragmentBuilder io.flutter.embedding.android.FlutterFragment.NewEngineFragmentBuilder.renderMode ( @NonNull RenderMode  renderMode )

inline

Render Flutter either as a RenderMode#surface or a RenderMode#texture. You should use surface unless you have a specific reason to use texture.
texture comes with a significant performance impact, but texture can be displayed beneath other Android Views and animated, whereas surface cannot.

Definition at line 341 of file FlutterFragment.java.

                                                                               {
      this.renderMode = renderMode;
      return this;
    }

shouldAttachEngineToActivity()

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

inline

Whether or not this FlutterFragment should automatically attach its Activity as a control surface for its io.flutter.embedding.engine.FlutterEngine.

Control surfaces are used to provide Android resources and lifecycle events to plugins that are attached to the io.flutter.embedding.engine.FlutterEngine. If
shouldAttachEngineToActivity is true then this FlutterFragment will connect its io.flutter.embedding.engine.FlutterEngine to the surrounding Activity, along with any plugins that are registered with that FlutterEngine. This allows plugins to access the Activity, as well as receive Activity-specific calls, e.g., android.app.Activity#onNewIntent(Intent). If shouldAttachEngineToActivity is false, then this FlutterFragment will not automatically manage the connection between its io.flutter.embedding.engine.FlutterEngine and the surrounding Activity. The Activity will need to be manually connected to this FlutterFragment's io.flutter.embedding.engine.FlutterEngine by the app developer. See FlutterEngine#getActivityControlSurface().

One reason that a developer might choose to manually manage the relationship between the Activity and io.flutter.embedding.engine.FlutterEngine is if the developer wants to move the FlutterEngine somewhere else. For example, a developer might want the io.flutter.embedding.engine.FlutterEngine to outlive the surrounding
Activity so that it can be used later in a different Activity. To accomplish this, the io.flutter.embedding.engine.FlutterEngine will need to be disconnected from the surrounding Activity at an unusual time, preventing this FlutterFragment from correctly managing the relationship between the io.flutter.embedding.engine.FlutterEngine and the surrounding Activity.

Another reason that a developer might choose to manually manage the relationship between the Activity and io.flutter.embedding.engine.FlutterEngine is if the developer wants to prevent, or explicitly control when the io.flutter.embedding.engine.FlutterEngine's plugins have access to the surrounding
Activity. For example, imagine that this FlutterFragment only takes up part of the screen and the app developer wants to ensure that none of the Flutter plugins are able to manipulate the surrounding Activity. In this case, the developer would not want the io.flutter.embedding.engine.FlutterEngine to have access to the Activity, which can be accomplished by setting shouldAttachEngineToActivity to false.

Definition at line 397 of file FlutterFragment.java.

                                              {
      this.shouldAttachEngineToActivity = shouldAttachEngineToActivity;
      return this;
    }

shouldAutomaticallyHandleOnBackPressed()

NewEngineFragmentBuilder io.flutter.embedding.android.FlutterFragment.NewEngineFragmentBuilder.shouldAutomaticallyHandleOnBackPressed ( boolean  shouldAutomaticallyHandleOnBackPressed )

inline

Whether or not this FlutterFragment should automatically receive onBackPressed() events, rather than requiring an explicit activity call through. Disabled by default.

When enabled, the activity will automatically dispatch back-press events to the fragment's OnBackPressedCallback, instead of requiring the activity to manually call onBackPressed() in client code. If enabled, do not invoke onBackPressed() manually.

This behavior relies on the implementation of popSystemNavigator(). It's not recommended to override that method when enabling this attribute, but if you do, you should always fall back to calling super.popSystemNavigator() when not relying on custom behavior.

Definition at line 419 of file FlutterFragment.java.

                                                        {
      this.shouldAutomaticallyHandleOnBackPressed = shouldAutomaticallyHandleOnBackPressed;
      return this;
    }

shouldDelayFirstAndroidViewDraw()

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

inline

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

See {#link FlutterActivityAndFragmentDelegate::onCreateView} for more details.

Definition at line 431 of file FlutterFragment.java.

                                                 {
      this.shouldDelayFirstAndroidViewDraw = shouldDelayFirstAndroidViewDraw;
      return this;
    }

transparencyMode()

NewEngineFragmentBuilder io.flutter.embedding.android.FlutterFragment.NewEngineFragmentBuilder.transparencyMode ( @NonNull TransparencyMode  transparencyMode )

inline

Support a TransparencyMode#transparent background within io.flutter.embedding.android.FlutterView, or force an TransparencyMode#opaque background.

See TransparencyMode for implications of this selection.

Definition at line 354 of file FlutterFragment.java.

                                                                                                 {
      this.transparencyMode = transparencyMode;
      return this;
    }

---

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

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