Class FlutterFragmentActivity.CachedEngineIntentBuilder
- java.lang.Object
-
- io.flutter.embedding.android.FlutterFragmentActivity.CachedEngineIntentBuilder
-
- Enclosing class:
- FlutterFragmentActivity
public static class FlutterFragmentActivity.CachedEngineIntentBuilder extends Object
Builder to create anIntent
that launches aFlutterFragmentActivity
with an existingFlutterEngine
that is cached inFlutterEngineCache
.
-
-
Constructor Summary
Constructors Constructor Description CachedEngineIntentBuilder(Class<? extends FlutterFragmentActivity> activityClass, String engineId)
Constructor that allows thisCachedEngineIntentBuilder
to be used by subclasses ofFlutterFragmentActivity
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FlutterFragmentActivity.CachedEngineIntentBuilder
backgroundMode(FlutterActivityLaunchConfigs.BackgroundMode backgroundMode)
The mode ofFlutterFragmentActivity
's background, eitherFlutterActivityLaunchConfigs.BackgroundMode.opaque
orFlutterActivityLaunchConfigs.BackgroundMode.transparent
.Intent
build(Context context)
Creates and returns anIntent
that will launch aFlutterFragmentActivity
with the desired configuration.FlutterFragmentActivity.CachedEngineIntentBuilder
destroyEngineWithActivity(boolean destroyEngineWithActivity)
Returns true if the cachedFlutterEngine
should be destroyed and removed from the cache when thisFlutterFragmentActivity
is destroyed.
-
-
-
Constructor Detail
-
CachedEngineIntentBuilder
public CachedEngineIntentBuilder(@NonNull Class<? extends FlutterFragmentActivity> activityClass, @NonNull String engineId)
Constructor that allows thisCachedEngineIntentBuilder
to be used by subclasses ofFlutterFragmentActivity
.Subclasses of
FlutterFragmentActivity
should provide their own static version ofFlutterFragmentActivity.withCachedEngine(String)
, which returns an instance ofCachedEngineIntentBuilder
constructed with aClass
reference to theFlutterFragmentActivity
subclass, e.g.:return new CachedEngineIntentBuilder(MyFlutterActivity.class, engineId);
-
-
Method Detail
-
destroyEngineWithActivity
public FlutterFragmentActivity.CachedEngineIntentBuilder destroyEngineWithActivity(boolean destroyEngineWithActivity)
Returns true if the cachedFlutterEngine
should be destroyed and removed from the cache when thisFlutterFragmentActivity
is destroyed.The default value is
false
.
-
backgroundMode
@NonNull public FlutterFragmentActivity.CachedEngineIntentBuilder backgroundMode(@NonNull FlutterActivityLaunchConfigs.BackgroundMode backgroundMode)
The mode ofFlutterFragmentActivity
's background, eitherFlutterActivityLaunchConfigs.BackgroundMode.opaque
orFlutterActivityLaunchConfigs.BackgroundMode.transparent
.The default background mode is
FlutterActivityLaunchConfigs.BackgroundMode.opaque
.Choosing a background mode of
FlutterActivityLaunchConfigs.BackgroundMode.transparent
will configure the innerFlutterView
of thisFlutterFragmentActivity
to be configured with aFlutterTextureView
to support transparency. This choice has a non-trivial performance impact. A transparent background should only be used if it is necessary for the app design being implemented.A
FlutterFragmentActivity
that is configured with a background mode ofFlutterActivityLaunchConfigs.BackgroundMode.transparent
must have a theme applied to it that includes the following property:<item name="android:windowIsTranslucent">true</item>
.
-
-