public abstract class SharedElementCallback extends Object
FragmentActivity.setEnterSharedElementCallback(SharedElementCallback)
and
FragmentActivity.setExitSharedElementCallback(SharedElementCallback)
to monitor the Activity transitions. The events can be used to customize Activity
Transition behavior.Modifier and Type | Class and Description |
---|---|
static 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. |
Constructor and Description |
---|
SharedElementCallback() |
Modifier and Type | Method and Description |
---|---|
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 |
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.
|
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.
|
public void onSharedElementStart(List<String> sharedElementNames, List<View> sharedElements, List<View> sharedElementSnapshots)
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 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.
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 onSharedElementEnd(List<String> sharedElementNames, List<View> sharedElements, List<View> sharedElementSnapshots)
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.
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 onRejectSharedElements(List<View> rejectedSharedElements)
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
SharedElementListener
.
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.
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 onMapSharedElements(List<String> names, Map<String,View> sharedElements)
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 Parcelable onCaptureSharedElementSnapshot(View sharedElement, Matrix viewToGlobalMatrix, RectF screenBounds)
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.
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.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)
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.
context
- The Context used to create the snapshot View.snapshot
- The Parcelable returned by onCaptureSharedElementSnapshot(
android.view.View, android.graphics.Matrix, android.graphics.RectF)
.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 onSharedElementsArrived(List<String> sharedElementNames, List<View> sharedElements, SharedElementCallback.OnSharedElementsReadyListener listener)
When the shared elements are ready to be transferred,
SharedElementCallback.OnSharedElementsReadyListener.onSharedElementsReady()
must be called to trigger the transfer.
The default behavior is to trigger the transfer immediately.
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.