SplashScreen
interface SplashScreen
android.window.SplashScreen |
The interface that apps use to talk to the splash screen.
Each splash screen instance is bound to a particular Activity
. To obtain a SplashScreen
for an Activity, use Activity.getSplashScreen()
to get the SplashScreen.
Summary
Nested classes | |
---|---|
abstract |
Listens for the splash screen exit event. |
Constants | |
---|---|
static Int |
Flag to be used with |
static Int |
Flag to be used with |
Public methods | |
---|---|
abstract Unit |
Clear exist listener |
abstract Unit |
Specifies whether an |
abstract Unit |
setSplashScreenTheme(themeId: Int) Overrides the theme used for the |
Constants
SPLASH_SCREEN_STYLE_ICON
static val SPLASH_SCREEN_STYLE_ICON: Int
Flag to be used with ActivityOptions.setSplashScreenStyle
, to show the splash screen icon of the launched activity.
Value: 1
SPLASH_SCREEN_STYLE_SOLID_COLOR
static val SPLASH_SCREEN_STYLE_SOLID_COLOR: Int
Flag to be used with ActivityOptions.setSplashScreenStyle
, to avoid showing the splash screen icon of the launched activity
Value: 0
Public methods
clearOnExitAnimationListener
abstract fun clearOnExitAnimationListener(): Unit
Clear exist listener
See Also
setOnExitAnimationListener
abstract fun setOnExitAnimationListener(listener: SplashScreen.OnExitAnimationListener): Unit
Specifies whether an Activity
wants to handle the splash screen animation on its own. Normally the splash screen will show on screen before the content of the activity has been drawn, and disappear when the activity is showing on the screen. With this listener set, the activity will receive OnExitAnimationListener.onSplashScreenExit
callback if splash screen is showed, then the activity can create its own exit animation based on the SplashScreenView.
Note that this method must be called before splash screen leave, so it only takes effect during or before Activity.onResume
.
Parameters | |
---|---|
listener |
SplashScreen.OnExitAnimationListener: the listener for receive the splash screen with This value cannot be null . |
setSplashScreenTheme
abstract fun setSplashScreenTheme(themeId: Int): Unit
Overrides the theme used for the SplashScreen
s of this application.
By default, the SplashScreen
uses the theme set in the manifest. This method overrides and persists the theme used for the SplashScreen
of this application.
To reset to the default theme, set this the themeId to Resources.ID_NULL
.
Note: Internally, the theme name is resolved and persisted. This means that the theme name must be stable across versions, otherwise it won't be found after your application is updated.
Parameters | |
---|---|
themeId |
Int: The ID of the splashscreen theme to be used in place of the one defined in the manifest. |