added in version 26.1.0
belongs to Maven artifact com.android.support:transition:28.0.0-alpha1

VisibilityPropagation

public abstract class VisibilityPropagation
extends TransitionPropagation

java.lang.Object
   ↳ android.support.transition.TransitionPropagation
     ↳ android.support.transition.VisibilityPropagation
Known Direct Subclasses


Base class for TransitionPropagations that care about View Visibility and the center position of the View.

Summary

Public constructors

VisibilityPropagation()

Public methods

void captureValues(TransitionValues values)

Captures the values in the start or end scene for the properties that this transition propagation monitors.

String[] getPropagationProperties()

Returns the set of property names stored in the TransitionValues object passed into captureValues(TransitionValues) that this transition propagation cares about for the purposes of preventing duplicate capturing of property values.

int getViewVisibility(TransitionValues values)

Returns getVisibility() for the View at the time the values were captured.

int getViewX(TransitionValues values)

Returns the View's center x coordinate, relative to the screen, at the time the values were captured.

int getViewY(TransitionValues values)

Returns the View's center y coordinate, relative to the screen, at the time the values were captured.

Inherited methods

From class android.support.transition.TransitionPropagation
From class java.lang.Object

Public constructors

VisibilityPropagation

added in version 26.1.0
VisibilityPropagation ()

Public methods

captureValues

added in version 26.1.0
void captureValues (TransitionValues values)

Captures the values in the start or end scene for the properties that this transition propagation monitors. These values are then passed as the startValues or endValues structure in a later call to getStartDelay(ViewGroup, Transition, TransitionValues, TransitionValues). 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 getStartDelay(ViewGroup, Transition, TransitionValues, TransitionValues). method to determine the start delay.

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
values TransitionValues: The holder for any values that the Transition wishes to store. Values are stored in the values field of this TransitionValues object and are keyed from a String value. For example, to store a view's rotation value, a transition might call transitionValues.values.put("appname:transitionname:rotation", view.getRotation()). The target view will already be stored in the transitionValues structure when this method is called.

getPropagationProperties

added in version 26.1.0
String[] getPropagationProperties ()

Returns the set of property names stored in the TransitionValues object passed into captureValues(TransitionValues) that this transition propagation cares about for the purposes of preventing duplicate capturing of property values.

A TransitionPropagation must override this method to prevent duplicate capturing of values and must contain at least one

Returns
String[] An array of property names as described in the class documentation for TransitionValues.

getViewVisibility

added in version 26.1.0
int getViewVisibility (TransitionValues values)

Returns getVisibility() for the View at the time the values were captured.

Parameters
values TransitionValues: The TransitionValues captured at the start or end of the Transition.

Returns
int getVisibility() for the View at the time the values were captured.

getViewX

added in version 26.1.0
int getViewX (TransitionValues values)

Returns the View's center x coordinate, relative to the screen, at the time the values were captured.

Parameters
values TransitionValues: The TransitionValues captured at the start or end of the Transition.

Returns
int the View's center x coordinate, relative to the screen, at the time the values were captured.

getViewY

added in version 26.1.0
int getViewY (TransitionValues values)

Returns the View's center y coordinate, relative to the screen, at the time the values were captured.

Parameters
values TransitionValues: The TransitionValues captured at the start or end of the Transition.

Returns
int the View's center y coordinate, relative to the screen, at the time the values were captured.