Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)
Android APIs
public class

ActivityOptionsCompat

extends Object
java.lang.Object
   ↳ android.support.v4.app.ActivityOptionsCompat

Class Overview

Helper for accessing features in ActivityOptions introduced in API level 16 in a backwards compatible fashion.

Summary

Protected Constructors
ActivityOptionsCompat ()
Public Methods
static ActivityOptionsCompat makeCustomAnimation ( Context context, int enterResId, int exitResId)
Create an ActivityOptions specifying a custom animation to run when the activity is displayed.
static ActivityOptionsCompat makeScaleUpAnimation ( View source, int startX, int startY, int startWidth, int startHeight)
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.
static ActivityOptionsCompat makeThumbnailScaleUpAnimation ( View source, Bitmap thumbnail, int startX, int startY)
Create an ActivityOptions specifying an animation where a thumbnail is scaled from a given position to the new activity window that is being started.
Bundle toBundle ()
Returns the created options as a Bundle, which can be passed to startActivity(android.app.Activity, android.content.Intent, android.os.Bundle) .
void update ( ActivityOptionsCompat otherOptions)
Update the current values in this ActivityOptions from those supplied in otherOptions.
[Expand]
Inherited Methods
From class java.lang.Object

Protected Constructors

protected ActivityOptionsCompat ()

Public Methods

public static ActivityOptionsCompat makeCustomAnimation ( Context context, int enterResId, int exitResId)

Create an ActivityOptions specifying a custom animation to run when the activity is displayed.

Parameters
context Who is defining this. This is the application that the animation resources will be loaded from.
enterResId A resource ID of the animation resource to use for the incoming activity. Use 0 for no animation.
exitResId A resource ID of the animation resource to use for the outgoing activity. Use 0 for no animation.
Returns
  • Returns a new ActivityOptions object that you can use to supply these options as the options Bundle when starting an activity.

public static ActivityOptionsCompat makeScaleUpAnimation ( View source, int startX, int startY, int startWidth, int startHeight)

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 its setSourceBounds(android.graphics.Rect) , those bounds will be filled in for you based on the initial bounds passed in here.

Parameters
source The View that the new activity is animating from. This defines the coordinate space for startX and startY.
startX The x starting location of the new activity, relative to source.
startY The y starting location of the activity, relative to source.
startWidth The initial width of the new activity.
startHeight The initial height of the new activity.
Returns
  • Returns a new ActivityOptions object that you can use to supply these options as the options Bundle when starting an activity.

public static ActivityOptionsCompat makeThumbnailScaleUpAnimation ( View source, Bitmap thumbnail, int startX, int startY)

Create an ActivityOptions specifying an animation where a thumbnail is scaled from a given position to the new activity window that is being started.

If the Intent this is being used with has not set its setSourceBounds(android.graphics.Rect) , those bounds will be filled in for you based on the initial thumbnail location and size provided here.

Parameters
source The View that this thumbnail is animating from. This defines the coordinate space for startX and startY.
thumbnail The bitmap that will be shown as the initial thumbnail of the animation.
startX The x starting location of the bitmap, relative to source.
startY The y starting location of the bitmap, relative to source.
Returns
  • Returns a new ActivityOptions object that you can use to supply these options as the options Bundle when starting an activity.

public Bundle toBundle ()

Returns the created options as a Bundle, which can be passed to startActivity(android.app.Activity, android.content.Intent, android.os.Bundle) . Note that the returned Bundle is still owned by the ActivityOptions object; you must not modify it, but can supply it to the startActivity methods that take an options Bundle.

public void update ( ActivityOptionsCompat otherOptions)

Update the current values in this ActivityOptions from those supplied in otherOptions. Any values defined in otherOptions replace those in the base options.