ChangeBounds
public class ChangeBounds extends Transition
This transition captures the layout bounds of target views before and after the scene change and animates those changes during the transition.
A ChangeBounds transition can be described in a resource file by using the tag changeBounds, along with the other standard attributes of Transition.
Summary
Public constructors |
|---|
ChangeBounds(@NonNull Context context, @NonNull AttributeSet attrs) |
Public methods |
|
|---|---|
void |
captureEndValues(@NonNull TransitionValues transitionValues)Captures the values in the end scene for the properties that this transition monitors. |
void |
captureStartValues(@NonNull TransitionValues transitionValues)Captures the values in the start scene for the properties that this transition monitors. |
@Nullable Animator |
createAnimator(This method creates an animation that will be run for this transition given the information in the startValues and endValues structures captured earlier for the start and end scenes. |
boolean |
Returns true when the ChangeBounds will resize by changing the clip bounds during the view animation or false when bounds are changed. |
@NonNull String[] |
Returns the set of property names used stored in the |
boolean |
Returns |
void |
setResizeClip(boolean resizeClip)When |
Inherited Constants |
||||||||
|---|---|---|---|---|---|---|---|---|
|
Inherited methods |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Public constructors
ChangeBounds
public ChangeBounds(@NonNull Context context, @NonNull AttributeSet attrs)
Public methods
captureEndValues
public void captureEndValues(@NonNull TransitionValues transitionValues)
Captures the values in the end scene for the properties that this transition monitors. These values are then passed as the endValues structure in a later call to createAnimator. The main concern for an implementation is what the properties are that the transition cares about and what the values are for all of those properties. The start and end values will be compared later during the createAnimator method to determine what, if any, animations, should be run.
Subclasses must implement this method. The method should only be called by the transition system; it is not intended to be called from external classes.
| Parameters | |
|---|---|
@NonNull TransitionValues transitionValues |
The holder for any values that the Transition wishes to store. Values are stored in the |
| See also | |
|---|---|
captureStartValues |
|
createAnimator |
captureStartValues
public void captureStartValues(@NonNull TransitionValues transitionValues)
Captures the values in the start scene for the properties that this transition monitors. These values are then passed as the startValues structure in a later call to createAnimator. The main concern for an implementation is what the properties are that the transition cares about and what the values are for all of those properties. The start and end values will be compared later during the createAnimator method to determine what, if any, animations, should be run.
Subclasses must implement this method. The method should only be called by the transition system; it is not intended to be called from external classes.
| Parameters | |
|---|---|
@NonNull TransitionValues transitionValues |
The holder for any values that the Transition wishes to store. Values are stored in the |
| See also | |
|---|---|
captureEndValues |
|
createAnimator |
createAnimator
public @Nullable Animator createAnimator(
@NonNull ViewGroup sceneRoot,
@Nullable TransitionValues startValues,
@Nullable TransitionValues endValues
)
This method creates an animation that will be run for this transition given the information in the startValues and endValues structures captured earlier for the start and end scenes. Subclasses of Transition should override this method. The method should only be called by the transition system; it is not intended to be called from external classes.
This method is called by the transition's parent (all the way up to the topmost Transition in the hierarchy) with the sceneRoot and start/end values that the transition may need to set up initial target values and construct an appropriate animation. For example, if an overall Transition is a TransitionSet consisting of several child transitions in sequence, then some of the child transitions may want to set initial values on target views prior to the overall Transition commencing, to put them in an appropriate state for the delay between that start and the child Transition start time. For example, a transition that fades an item in may wish to set the starting alpha value to 0, to avoid it blinking in prior to the transition actually starting the animation. This is necessary because the scene change that triggers the Transition will automatically set the end-scene on all target views, so a Transition that wants to animate from a different value should set that value prior to returning from this method.
Additionally, a Transition can perform logic to determine whether the transition needs to run on the given target and start/end values. For example, a transition that resizes objects on the screen may wish to avoid running for views which are not present in either the start or end scenes.
If there is an animator created and returned from this method, the transition mechanism will apply any applicable duration, startDelay, and interpolator to that animation and start it. A return value of null indicates that no animation should run. The default implementation returns null.
The method is called for every applicable target object, which is stored in the view field.
| Parameters | |
|---|---|
@NonNull ViewGroup sceneRoot |
The root of the transition hierarchy. |
@Nullable TransitionValues startValues |
The values for a specific target in the start scene. |
@Nullable TransitionValues endValues |
The values for the target in the end scene. |
getResizeClip
public boolean getResizeClip()
Returns true when the ChangeBounds will resize by changing the clip bounds during the view animation or false when bounds are changed. The default value is false.
| Returns | |
|---|---|
boolean |
true when the ChangeBounds will resize by changing the clip bounds during the view animation or false when bounds are changed. The default value is false. |
getTransitionProperties
public @NonNull String[] getTransitionProperties()
Returns the set of property names used stored in the TransitionValues object passed into captureStartValues that this transition cares about for the purposes of canceling overlapping animations. When any transition is started on a given scene root, all transitions currently running on that same scene root are checked to see whether the properties on which they based their animations agree with the end values of the same properties in the new transition. If the end values are not equal, then the old animation is canceled since the new transition will start a new animation to these new values. If the values are equal, the old animation is allowed to continue and no new animation is started for that transition.
A transition does not need to override this method. However, not doing so will mean that the cancellation logic outlined in the previous paragraph will be skipped for that transition, possibly leading to artifacts as old transitions and new transitions on the same targets run in parallel, animating views toward potentially different end values.
| Returns | |
|---|---|
@NonNull String[] |
An array of property names as described in the class documentation for |
isSeekingSupported
public boolean isSeekingSupported()
Returns true if the Transition can be used by controlDelayedTransition. This means that any the state must be ready before any Animator returned by createAnimator has started and if the Animator has ended, it must be able to restore the state when starting in reverse. If a Transition must know when the entire transition has ended, a TransitionListener can be added to getRootTransition and it can listen for onTransitionEnd.
setResizeClip
public void setResizeClip(boolean resizeClip)
When resizeClip is true, ChangeBounds resizes the view using the clipBounds instead of changing the dimensions of the view during the animation. When resizeClip is false, ChangeBounds resizes the View by changing its dimensions.
When resizeClip is set to true, the clip bounds is modified by ChangeBounds. Therefore, android.transition.ChangeClipBounds is not compatible with ChangeBounds in this mode.
| Parameters | |
|---|---|
boolean resizeClip |
Used to indicate whether the view bounds should be modified or the clip bounds should be modified by ChangeBounds. |
| See also | |
|---|---|
setClipBounds |