ActivityOptionsCompat
open class ActivityOptionsCompat
kotlin.Any | |
↳ | androidx.core.app.ActivityOptionsCompat |
Helper for accessing features in android.app.ActivityOptions
in a backwards compatible fashion.
Summary
Constants | |
---|---|
static String |
A long in the extras delivered by |
static String |
A Bundle in the extras delivered by |
Protected constructors | |
---|---|
<init>() |
Public methods | |
---|---|
open Rect? |
Returns the bounds that should be used to launch the activity. |
open static ActivityOptionsCompat |
Create a basic ActivityOptions that has no special animation associated with it. |
open static ActivityOptionsCompat |
Create an ActivityOptions specifying an animation where the new activity is revealed from a small originating area of the screen to its final full representation. |
open static ActivityOptionsCompat |
makeCustomAnimation(@NonNull context: Context, enterResId: Int, exitResId: Int) Create an ActivityOptions specifying a custom animation to run when the activity is displayed. |
open static ActivityOptionsCompat |
makeScaleUpAnimation(@NonNull source: View, startX: Int, startY: Int, startWidth: Int, startHeight: Int) Create an ActivityOptions specifying an animation where the new activity is scaled from a small originating area of the screen to its final full representation. |
open static ActivityOptionsCompat |
makeSceneTransitionAnimation(@NonNull activity: Activity, @NonNull : View, @NonNull : String) Create an ActivityOptions to transition between Activities using cross-Activity scene animations. |
open static ActivityOptionsCompat |
makeSceneTransitionAnimation(@NonNull activity: Activity, vararg : Pair<View!, String!>!) Create an ActivityOptions to transition between Activities using cross-Activity scene animations. |
open static ActivityOptionsCompat |
If set along with Intent. |
open static ActivityOptionsCompat |
makeThumbnailScaleUpAnimation(@NonNull source: View, @NonNull thumbnail: Bitmap, startX: Int, startY: Int) Create an ActivityOptions specifying an animation where a thumbnail is scaled from a given position to the new activity window that is being started. |
open Unit |
requestUsageTimeReport(@NonNull receiver: PendingIntent) Ask the the system track that time the user spends in the app being launched, and report it back once done. |
open ActivityOptionsCompat |
setLaunchBounds(@Nullable screenSpacePixelRect: Rect?) Sets the bounds (window size) that the activity should be launched in. |
open Bundle? |
toBundle() Returns the created options as a Bundle, which can be passed to |
open Unit |
update(@NonNull otherOptions: ActivityOptionsCompat) Update the current values in this ActivityOptions from those supplied in otherOptions. |
Constants
EXTRA_USAGE_TIME_REPORT
static val EXTRA_USAGE_TIME_REPORT: String
A long in the extras delivered by requestUsageTimeReport
that contains the total time (in ms) the user spent in the app flow.
Value: "android.activity.usage_time"
EXTRA_USAGE_TIME_REPORT_PACKAGES
static val EXTRA_USAGE_TIME_REPORT_PACKAGES: String
A Bundle in the extras delivered by requestUsageTimeReport
that contains detailed information about the time spent in each package associated with the app; each key is a package name, whose value is a long containing the time (in ms).
Value: "android.usage_time_packages"
Protected constructors
<init>
protected ActivityOptionsCompat()
Public methods
getLaunchBounds
@Nullable open fun getLaunchBounds(): Rect?
Returns the bounds that should be used to launch the activity.
Return | |
---|---|
Rect? |
Bounds used to launch the activity. |
See Also
makeBasic
@NonNull open static fun makeBasic(): ActivityOptionsCompat
Create a basic ActivityOptions that has no special animation associated with it. Other options can still be set.
makeClipRevealAnimation
@NonNull open static fun makeClipRevealAnimation(
@NonNull source: View,
startX: Int,
startY: Int,
width: Int,
height: Int
): ActivityOptionsCompat
Create an ActivityOptions specifying an animation where the new activity is revealed from a small originating area of the screen to its final full representation.
Parameters | |
---|---|
source |
View: The View that the new activity is animating from. This defines the coordinate space for startX and startY. |
startX |
Int: The x starting location of the new activity, relative to source. |
startY |
Int: The y starting location of the activity, relative to source. |
width |
Int: The initial width of the new activity. |
height |
Int: The initial height of the new activity. |
Return | |
---|---|
ActivityOptionsCompat |
Returns a new ActivityOptions object that you can use to supply these options as the options Bundle when starting an activity. |
makeCustomAnimation
@NonNull open static fun makeCustomAnimation(
@NonNull context: Context,
enterResId: Int,
exitResId: Int
): ActivityOptionsCompat
Create an ActivityOptions specifying a custom animation to run when the activity is displayed.
Parameters | |
---|---|
context |
Context: Who is defining this. This is the application that the animation resources will be loaded from. |
enterResId |
Int: A resource ID of the animation resource to use for the incoming activity. Use 0 for no animation. |
exitResId |
Int: A resource ID of the animation resource to use for the outgoing activity. Use 0 for no animation. |
Return | |
---|---|
ActivityOptionsCompat |
Returns a new ActivityOptions object that you can use to supply these options as the options Bundle when starting an activity. |
makeScaleUpAnimation
@NonNull open static fun makeScaleUpAnimation(
@NonNull source: View,
startX: Int,
startY: Int,
startWidth: Int,
startHeight: Int
): ActivityOptionsCompat
Create an ActivityOptions specifying an animation where the new activity is scaled from a small originating area of the screen to its final full representation.
If the Intent this is being used with has not set itsandroid.content.Intent#setSourceBounds(android.graphics.Rect)
, those bounds will be filled in for you based on the initial bounds passed in here.
Parameters | |
---|---|
source |
View: The View that the new activity is animating from. This defines the coordinate space for startX and startY. |
startX |
Int: The x starting location of the new activity, relative to source. |
startY |
Int: The y starting location of the activity, relative to source. |
startWidth |
Int: The initial width of the new activity. |
startHeight |
Int: The initial height of the new activity. |
Return | |
---|---|
ActivityOptionsCompat |
Returns a new ActivityOptions object that you can use to supply these options as the options Bundle when starting an activity. |
makeSceneTransitionAnimation
@NonNull open static fun makeSceneTransitionAnimation(
@NonNull activity: Activity,
@NonNull : View,
@NonNull : String
): ActivityOptionsCompat
Create an ActivityOptions to transition between Activities using cross-Activity scene animations. This method carries the position of one shared element to the started Activity. The position of sharedElement
will be used as the epicenter for the exit Transition. The position of the shared element in the launched Activity will be the epicenter of its entering Transition.
This requires android.view.Window#FEATURE_CONTENT_TRANSITIONS
to be enabled on the calling Activity to cause an exit transition. The same must be in the called Activity to get an entering transition.
Parameters | |
---|---|
activity |
Activity: The Activity whose window contains the shared elements. |
sharedElement |
View: The View to transition to the started Activity. sharedElement must have a non-null shar |