CircularRevealWidget

View Source

public interface CircularRevealWidget extends CircularRevealHelper.Delegate

Known direct subclasses

CircularRevealCardView, CircularRevealCoordinatorLayout, CircularRevealFrameLayout, CircularRevealGridLayout, CircularRevealLinearLayout, CircularRevealRelativeLayout

`CircularRevealCardView`	A CircularRevealWidget wrapper for `MaterialCardView`.
`CircularRevealCoordinatorLayout`	A CircularRevealWidget wrapper for CoordinatorLayout.
`CircularRevealFrameLayout`	A CircularRevealWidget wrapper for FrameLayout.
`CircularRevealGridLayout`	A CircularRevealWidget wrapper for GridLayout.
`CircularRevealLinearLayout`	A CircularRevealWidget wrapper for LinearLayout.
`CircularRevealRelativeLayout`	A CircularRevealWidget wrapper for RelativeLayout.

Known indirect subclasses

TransformationChildCard, TransformationChildLayout

TransformationChildCard

This class is deprecated.

Use com.google.android.material.transition.MaterialContainerTransform instead.

TransformationChildLayout

This class is deprecated.

Use com.google.android.material.transition.MaterialContainerTransform instead.

Interface which denotes that a View supports a circular clip and scrim color, even for pre-L APIs.

Usage

You should not have to interact with instances of this interface directly. To modify the circular clip, use CircularRevealCompat. To modify the scrim color, use .

Implementation

To support circular reveal for an arbitrary view, create a subclass of that view that implements the CircularRevealWidget interface. The subclass should instantiate a and pass itself into the helper's constructor.

All unimplemented methods should be implemented as directed in the javadoc.

Only Views should implement this interface. Callers may expect an instance of this interface to be a View.

Summary

Nested types
`public class CircularRevealWidget.CircularRevealEvaluator` A TypeEvaluator that performs type interpolation between two `RevealInfo`s.
`public class CircularRevealWidget.CircularRevealProperty` A Property wrapper around the compound `circularReveal` functionality on a .
`public class CircularRevealWidget.CircularRevealScrimColorProperty` A Property wrapper around the `circularRevealScrimColor` functionality on a .
`public class CircularRevealWidget.RevealInfo` RevealInfo holds three values for a circular reveal.

Public methods
`abstract void`	`buildCircularRevealCache()` Prepares the reveal info property to be modified.
`abstract void`	`destroyCircularRevealCache()` Cleans up after the reveal info property is reset.
`abstract void`	`draw(Canvas canvas)` Implementations should call the corresponding method in `CircularRevealHelper`.
`abstract Drawable`	`getCircularRevealOverlayDrawable()` Returns the circular reveal overlay drawable if one exists, or null.
`abstract int`	`getCircularRevealScrimColor()` Implementations should call the corresponding method in `CircularRevealHelper`.
`abstract CircularRevealWidget.RevealInfo`	`getRevealInfo()` Returns the current reveal info if one exists, or null.
`abstract boolean`	`isOpaque()` Implementations should call the corresponding method in `CircularRevealHelper`.
`abstract void`	`setCircularRevealOverlayDrawable(Drawable drawable)` Sets the circular reveal overlay drawable, which is an icon that's drawn above everything else, including the circular reveal scrim color.
`abstract void`	`setCircularRevealScrimColor(int color)` Sets the circular reveal scrim color, which is a color that's drawn above this widget's contents.
`abstract void`	`setRevealInfo(CircularRevealWidget.RevealInfo revealInfo)` Sets the current reveal info.

Inherited methods

From com.google.android.material.circularreveal.CircularRevealHelper.Delegate

`abstract void`	`actualDraw(Canvas canvas)` Calls super#draw(Canvas).
`abstract boolean`	`actualIsOpaque()` Calls super#isOpaque().