Join us on the livestream at Android Dev Summit on 7-8 November 2018, starting at 10AM PDT!

ViewOutlineProvider

public abstract class ViewOutlineProvider
extends Object

java.lang.Object
   ↳ android.view.ViewOutlineProvider


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

Summary

Fields

public static final ViewOutlineProvider BACKGROUND

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.

public static final ViewOutlineProvider BOUNDS

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

public static final ViewOutlineProvider PADDED_BOUNDS

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

Public constructors

ViewOutlineProvider()

Public methods

abstract void getOutline(View view, Outline outline)

Called to get the provider to populate the Outline.

Inherited methods

Fields

BACKGROUND

added in API level 21
public static final ViewOutlineProvider BACKGROUND

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
public static final ViewOutlineProvider BOUNDS

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
public static final ViewOutlineProvider PADDED_BOUNDS

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.

Public constructors

ViewOutlineProvider

added in API level 21
public ViewOutlineProvider ()

Public methods

getOutline

added in API level 21
public abstract void getOutline (View view, 
                Outline outline)

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.