Added in API level 21

ViewOutlineProvider


abstract class ViewOutlineProvider
kotlin.Any
   ↳ android.view.ViewOutlineProvider

Interface by which a View builds its Outline, used for shadow casting and clipping.

Summary

Public constructors

Public methods
abstract Unit
getOutline(view: View!, outline: Outline!)

Called to get the provider to populate the Outline.

Properties
static ViewOutlineProvider!

Default outline provider for Views, which queries the Outline from the View's background, or generates a 0 alpha, rectangular Outline the size of the View if a background isn't present.

static ViewOutlineProvider!

Maintains the outline of the View to match its rectangular bounds, at 1.0f alpha.

static ViewOutlineProvider!

Maintains the outline of the View to match its rectangular padded bounds, at 1.0f alpha.

Public constructors

ViewOutlineProvider

ViewOutlineProvider()

Public methods

getOutline

Added in API level 21
abstract fun getOutline(
    view: View!,
    outline: Outline!
): Unit

Called to get the provider to populate the Outline. This method will be called by a View when its owned Drawables are invalidated, when the View's size changes, or if View#invalidateOutline() is called explicitly. The input outline is empty and has an alpha of 1.0f.

Parameters
view View!: The view building the outline.
outline Outline!: The empty outline to be populated.

Properties

BACKGROUND

Added in API level 21
static val BACKGROUND: ViewOutlineProvider!

Default outline provider for Views, which queries the Outline from the View's background, or generates a 0 alpha, rectangular Outline the size of the View if a background isn't present.

BOUNDS

Added in API level 21
static val BOUNDS: ViewOutlineProvider!

Maintains the outline of the View to match its rectangular bounds, at 1.0f alpha. This can be used to enable Views that are opaque but lacking a background cast a shadow.

PADDED_BOUNDS

Added in API level 21
static val PADDED_BOUNDS: ViewOutlineProvider!

Maintains the outline of the View to match its rectangular padded bounds, at 1.0f alpha. This can be used to enable Views that are opaque but lacking a background cast a shadow.