CircularRevealWidget

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.

Inheritors

Types

Link copied to clipboard
A TypeEvaluator that performs type interpolation between two RevealInfos.
Link copied to clipboard
A Property wrapper around the compound circularReveal functionality on a .
Link copied to clipboard
A Property wrapper around the circularRevealScrimColor functionality on a .
Link copied to clipboard
open class RevealInfo
RevealInfo holds three values for a circular reveal.

Functions

Link copied to clipboard
Prepares the reveal info property to be modified.
Link copied to clipboard
Cleans up after the reveal info property is reset.
Link copied to clipboard
abstract fun draw(canvas: Canvas)
Implementations should call the corresponding method in CircularRevealHelper.
Link copied to clipboard
Returns the circular reveal overlay drawable if one exists, or null.
Link copied to clipboard
Implementations should call the corresponding method in CircularRevealHelper.
Link copied to clipboard
Returns the current reveal info if one exists, or null.
Link copied to clipboard
abstract fun isOpaque(): Boolean
Implementations should call the corresponding method in CircularRevealHelper.
Link copied to clipboard
Sets the circular reveal overlay drawable, which is an icon that's drawn above everything else, including the circular reveal scrim color.
Link copied to clipboard
Sets the circular reveal scrim color, which is a color that's drawn above this widget's contents.
Link copied to clipboard
Sets the current reveal info.