SharedElementCallback - Android SDK

Summary: Nested Classes | Ctors | Methods | Inherited Methods | [Expand All]

Added in API level 21

public abstract class

SharedElementCallback

extends Object

java.lang.Object
↳	android.app.SharedElementCallback

Class Overview

Listener provided in setEnterSharedElementCallback(SharedElementCallback) and setExitSharedElementCallback(SharedElementCallback) as well as setEnterSharedElementCallback(SharedElementCallback) and setExitSharedElementCallback(SharedElementCallback) to monitor the Shared element transitions. The events can be used to customize Activity and Fragment Transition behavior.

Summary

Nested Classes
interface	SharedElementCallback.OnSharedElementsReadyListener	Listener to be called after `onSharedElementsArrived(List, List, OnSharedElementsReadyListener)` when the shared elements are ready to be hidden in the source Activity and shown in the destination Activity.

Public Constructors
	SharedElementCallback()

Public Methods
Parcelable	onCaptureSharedElementSnapshot(View sharedElement, Matrix viewToGlobalMatrix, RectF screenBounds) Creates a snapshot of a shared element to be used by the remote Activity and reconstituted with `onCreateSnapshotView(android.content.Context, android.os.Parcelable)`.
View	onCreateSnapshotView(Context context, Parcelable snapshot) Reconstitutes a snapshot View from a Parcelable returned in `onCaptureSharedElementSnapshot(android.view.View, android.graphics.Matrix, android.graphics.RectF)` to be used in `onSharedElementStart(java.util.List, java.util.List, java.util.List)` and `onSharedElementEnd(java.util.List, java.util.List, java.util.List)`.
void	onMapSharedElements(List<String> names, Map<String, View> sharedElements) Lets the SharedElementCallback adjust the mapping of shared element names to Views.
void	onRejectSharedElements(List<View> rejectedSharedElements) Called after `onMapSharedElements(java.util.List, java.util.Map)` when transferring shared elements in.
void	onSharedElementEnd(List<String> sharedElementNames, List<View> sharedElements, List<View> sharedElementSnapshots) In Activity Transitions, onSharedElementEnd is called immediately before capturing the end of the shared element state on enter and reenter transitions and immediately before capturing the start of the shared element state for exit and return transitions.
void	onSharedElementStart(List<String> sharedElementNames, List<View> sharedElements, List<View> sharedElementSnapshots) In Activity Transitions, onSharedElementStart is called immediately before capturing the start of the shared element state on enter and reenter transitions and immediately before capturing the end of the shared element state for exit and return transitions.
void	onSharedElementsArrived(List<String> sharedElementNames, List<View> sharedElements, SharedElementCallback.OnSharedElementsReadyListener listener) Called during an Activity Transition when the shared elements have arrived at the final location and are ready to be transferred.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Public Constructors

public SharedElementCallback ()

Added in API level 21

Public Methods

public Parcelable onCaptureSharedElementSnapshot (View sharedElement, Matrix viewToGlobalMatrix, RectF screenBounds)

Added in API level 21

Creates a snapshot of a shared element to be used by the remote Activity and reconstituted with onCreateSnapshotView(android.content.Context, android.os.Parcelable). A null return value will mean that the remote Activity will have a null snapshot View in onSharedElementStart(java.util.List, java.util.List, java.util.List) and onSharedElementEnd(java.util.List, java.util.List, java.util.List).

This is not called for Fragment Transitions.

Parameters

sharedElement	The shared element View to create a snapshot for.
viewToGlobalMatrix	A matrix containing a transform from the view to the screen coordinates.
screenBounds	The bounds of shared element in screen coordinate space. This is the bounds of the view with the viewToGlobalMatrix applied.

Returns

A snapshot to send to the remote Activity to be reconstituted with onCreateSnapshotView(android.content.Context, android.os.Parcelable) and passed into onSharedElementStart(java.util.List, java.util.List, java.util.List) and onSharedElementEnd(java.util.List, java.util.List, java.util.List).

public View onCreateSnapshotView (Context context, Parcelable snapshot)

Added in API level 21

Reconstitutes a snapshot View from a Parcelable returned in onCaptureSharedElementSnapshot(android.view.View, android.graphics.Matrix, android.graphics.RectF) to be used in onSharedElementStart(java.util.List, java.util.List, java.util.List) and onSharedElementEnd(java.util.List, java.util.List, java.util.List). The returned View will be sized and positioned after this call so that it is ready to be added to the decor View's overlay.

This is not called for Fragment Transitions.

Parameters

context	The Context used to create the snapshot View.
snapshot	The Parcelable returned by `onCaptureSharedElementSnapshot(android.view.View, android.graphics.Matrix, android.graphics.RectF)`.

Returns

A View to be sent in onSharedElementStart(java.util.List, java.util.List, java.util.List) and onSharedElementEnd(java.util.List, java.util.List, java.util.List). A null value will produce a null snapshot value for those two methods.

public void onMapSharedElements (List<String> names, Map<String, View> sharedElements)

Added in API level 21

Lets the SharedElementCallback adjust the mapping of shared element names to Views.

Parameters

names	The names of all shared elements transferred from the calling Activity or Fragment in the order they were provided.
sharedElements	The mapping of shared element names to Views. The best guess will be filled into sharedElements based on the transitionNames.

public void onRejectSharedElements (List<View> rejectedSharedElements)

Added in API level 21

Called after onMapSharedElements(java.util.List, java.util.Map) when transferring shared elements in. Any shared elements that have no mapping will be in rejectedSharedElements. The elements remaining in rejectedSharedElements will be transitioned out of the Scene. If a View is removed from rejectedSharedElements, it must be handled by the SharedElementCallback.

Views in rejectedSharedElements will have their position and size set to the position of the calling shared element, relative to the Window decor View and contain snapshots of the View from the calling Activity or Fragment. This view may be safely added to the decor View's overlay to remain in position.

This method is not called for Fragment Transitions. All rejected shared elements will be handled by the exit transition.

Parameters

rejectedSharedElements	Views containing visual information of shared elements that are not part of the entering scene. These Views are positioned relative to the Window decor View. A View removed from this list will not be transitioned automatically.

public void onSharedElementEnd (List<String> sharedElementNames, List<View> sharedElements, List<View> sharedElementSnapshots)

Added in API level 21

In Activity Transitions, onSharedElementEnd is called immediately before capturing the end of the shared element state on enter and reenter transitions and immediately before capturing the start of the shared element state for exit and return transitions.

In Fragment Transitions, onSharedElementEnd is called immediately before capturing the end state of all shared element transitions.

This call can be used to adjust the transition end state by modifying the shared element Views. Note that no layout step will be executed between onSharedElementEnd and the transition state capture.

Any changes made in onSharedElementStart(List, List, List) that are not updated during layout should be corrected in onSharedElementEnd. For example, rotation or scale will not be affected by layout and if changed in onSharedElementStart(List, List, List), it will also have to be reset in onSharedElementEnd again to correct the end state.

Parameters

sharedElementNames	The names of the shared elements that were accepted into the View hierarchy.
sharedElements	The shared elements that are part of the View hierarchy.
sharedElementSnapshots	The Views containing snap shots of the shared element from the launching Window. These elements will not be part of the scene, but will be positioned relative to the Window decor View. This list will be null for Fragment Transitions.

public void onSharedElementStart (List<String> sharedElementNames, List<View> sharedElements, List<View> sharedElementSnapshots)

Added in API level 21

In Activity Transitions, onSharedElementStart is called immediately before capturing the start of the shared element state on enter and reenter transitions and immediately before capturing the end of the shared element state for exit and return transitions.

In Fragment Transitions, onSharedElementStart is called immediately before capturing the start state of all shared element transitions.

This call can be used to adjust the transition start state by modifying the shared element Views. Note that no layout step will be executed between onSharedElementStart and the transition state capture.

For Activity Transitions, any changes made in onSharedElementEnd(List, List, List) that are not updated during by layout should be corrected in onSharedElementStart for exit and return transitions. For example, rotation or scale will not be affected by layout and if changed in onSharedElementEnd(List, List, List), it will also have to be reset in onSharedElementStart again to correct the end state.

Parameters

sharedElementNames	The names of the shared elements that were accepted into the View hierarchy.
sharedElements	The shared elements that are part of the View hierarchy.
sharedElementSnapshots	The Views containing snap shots of the shared element from the launching Window. These elements will not be part of the scene, but will be positioned relative to the Window decor View. This list is null for Fragment Transitions.

public void onSharedElementsArrived (List<String> sharedElementNames, List<View> sharedElements, SharedElementCallback.OnSharedElementsReadyListener listener)

Added in API level 23

Called during an Activity Transition when the shared elements have arrived at the final location and are ready to be transferred. This method is called for both the source and destination Activities.

When the shared elements are ready to be transferred, onSharedElementsReady() must be called to trigger the transfer.

The default behavior is to trigger the transfer immediately.

Parameters

sharedElementNames	The names of the shared elements that are being transferred..
sharedElements	The shared elements that are part of the View hierarchy.
listener	The listener to call when the shared elements are ready to be hidden in the source Activity or shown in the destination Activity.

Results

Interfaces

Classes

Exceptions

SharedElementCallback

Class Overview

Summary

Public Constructors

public SharedElementCallback ()

Public Methods

public Parcelable onCaptureSharedElementSnapshot (View sharedElement, Matrix viewToGlobalMatrix, RectF screenBounds)

Parameters

Returns

public View onCreateSnapshotView (Context context, Parcelable snapshot)

Parameters

Returns

public void onMapSharedElements (List<String> names, Map<String, View> sharedElements)

Parameters

public void onRejectSharedElements (List<View> rejectedSharedElements)

Parameters

public void onSharedElementEnd (List<String> sharedElementNames, List<View> sharedElements, List<View> sharedElementSnapshots)

Parameters

public void onSharedElementStart (List<String> sharedElementNames, List<View> sharedElements, List<View> sharedElementSnapshots)

Parameters

public void onSharedElementsArrived (List<String> sharedElementNames, List<View> sharedElements, SharedElementCallback.OnSharedElementsReadyListener listener)

Parameters