Stay organized with collections Save and categorize content based on your preferences.
added in version 22.1.0
belongs to Maven artifact com.android.support:leanback-v17:28.0.0-alpha1
Summary: Constants | Inherited Constants | Inherited Fields | Ctors | Methods | Protected Methods | Inherited Methods | [Expand All]

ShadowOverlayContainer

public class ShadowOverlayContainer
extends FrameLayout

java.lang.Object
   ↳ android.view.View
     ↳ android.view.ViewGroup
       ↳ android.widget.FrameLayout
         ↳ android.support.v17.leanback.widget.ShadowOverlayContainer

Provides an SDK version-independent wrapper to support shadows, color overlays, and rounded corners. It's not always preferred to create a ShadowOverlayContainer, use ShadowOverlayHelper instead.

prepareParentForShadow(ViewGroup) must be called on parent of container before using shadow. Depending on sdk version, optical bounds might be applied to parent.

If shadows can appear outside the bounds of the parent view, setClipChildren(false) must be called on the grandparent view.

initialize(boolean, boolean, boolean) must be first called on the container. Then call wrap(View) to insert the wrapped view into the container.

Call setShadowFocusLevel(float) to control the strength of the shadow (focused shadows cast stronger shadows).

Call setOverlayColor(int) to control overlay color.

Summary

Constants

int SHADOW_DYNAMIC

Shadows depend on the size, shape, and position of the view.

int SHADOW_NONE

No shadow.

int SHADOW_STATIC

Shadows are fixed.

Inherited constants

From class android.view.ViewGroup
From class android.view.View

Inherited fields

From class android.view.View

Public constructors

ShadowOverlayContainer(Context context)

Create ShadowOverlayContainer and auto select shadow type.

ShadowOverlayContainer(Context context, AttributeSet attrs)

Create ShadowOverlayContainer and auto select shadow type.

ShadowOverlayContainer(Context context, AttributeSet attrs, int defStyle)

Create ShadowOverlayContainer and auto select shadow type.

Public methods

void draw(Canvas canvas)
int getShadowType()

Returns the shadow type, one of SHADOW_NONE, SHADOW_STATIC, or SHADOW_DYNAMIC.

View getWrappedView()

Returns the wrapper view.

boolean hasOverlappingRendering()
void initialize(boolean hasShadow, boolean hasColorDimOverlay)

This method was deprecated in API level 22.1.0. use createShadowOverlayContainer(Context) instead.

void initialize(boolean hasShadow, boolean hasColorDimOverlay, boolean roundedCorners)

This method was deprecated in API level 24.1.0. use createShadowOverlayContainer(Context) instead.

static void prepareParentForShadow(ViewGroup parent)

prepareParentForShadow(ViewGroup) must be called on parent of container before using shadow.

void setOverlayColor(int overlayColor)

Set color (with alpha) of the overlay.

void setShadowFocusLevel(float level)

Set shadow focus level (0 to 1).

static boolean supportsDynamicShadow()

Returns true if the platform sdk supports dynamic shadows.

static boolean supportsShadow()

Return true if the platform sdk supports shadow.

void useDynamicShadow(float unfocusedZ, float focusedZ)

Sets the shadow type to SHADOW_DYNAMIC if supported and sets the elevation/Z values to the given parameters.

void useDynamicShadow()

Sets the shadow type to SHADOW_DYNAMIC if supported.

void useStaticShadow()

Sets the shadow type to SHADOW_STATIC if supported.

void wrap(View view)

Inserts view into the wrapper.

Protected methods

void onLayout(boolean changed, int l, int t, int r, int b)

Inherited methods

From class android.widget.FrameLayout
From class android.view.ViewGroup