belongs to Maven artifact com.android.support:leanback-v17:28.0.0-alpha1
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 |
---|
![]() android.view.ViewGroup |
![]() android.view.View |
Inherited fields |
---|
![]() 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 |
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 |
void | initialize(boolean hasShadow, boolean hasColorDimOverlay, boolean roundedCorners) This method was deprecated in API level 24.1.0. use |
static void | prepareParentForShadow(ViewGroup parent)
|
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 |
void | useDynamicShadow() Sets the shadow type to |
void | useStaticShadow() Sets the shadow type to |
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 | |
---|---|
![]() android.widget.FrameLayout | |
![]() android.view.ViewGroup | |
![]() android.view.View | |
![]() java.lang.Object | |
![]() android.view.ViewParent | |
![]() android.view.ViewManager | |
![]() android.graphics.drawable.Drawable.Callback | |
![]() android.view.KeyEvent.Callback | |
![]() android.view.accessibility.AccessibilityEventSource |
Constants
SHADOW_DYNAMIC
int SHADOW_DYNAMIC
Shadows depend on the size, shape, and position of the view.
Constant Value: 3 (0x00000003)
SHADOW_STATIC
int SHADOW_STATIC
Shadows are fixed.
Constant Value: 2 (0x00000002)
Public constructors
ShadowOverlayContainer
ShadowOverlayContainer (Context context)
Create ShadowOverlayContainer and auto select shadow type.
Parameters | |
---|---|
context | Context |
ShadowOverlayContainer
ShadowOverlayContainer (Context context, AttributeSet attrs)
Create ShadowOverlayContainer and auto select shadow type.
Parameters | |
---|---|
context | Context |
attrs | AttributeSet |
ShadowOverlayContainer
ShadowOverlayContainer (Context context, AttributeSet attrs, int defStyle)
Create ShadowOverlayContainer and auto select shadow type.
Parameters | |
---|---|
context | Context |
attrs | AttributeSet |
defStyle | int |
Public methods
getShadowType
int getShadowType ()
Returns the shadow type, one of SHADOW_NONE
, SHADOW_STATIC
, or SHADOW_DYNAMIC
.
Returns | |
---|---|
int |
getWrappedView
View getWrappedView ()
Returns the wrapper view.
Returns | |
---|---|
View |
hasOverlappingRendering
boolean hasOverlappingRendering ()
Returns | |
---|---|
boolean |
initialize
void initialize (boolean hasShadow, boolean hasColorDimOverlay)
This method was deprecated in API level 22.1.0.
use createShadowOverlayContainer(Context)
instead.
Initialize shadows, color overlay.
Parameters | |
---|---|
hasShadow | boolean |
hasColorDimOverlay | boolean |
initialize
void initialize (boolean hasShadow, boolean hasColorDimOverlay, boolean roundedCorners)
This method was deprecated in API level 24.1.0.
use createShadowOverlayContainer(Context)
instead.
Initialize shadows, color overlay, and rounded corners. All are optional. Shadow type are auto-selected based on useStaticShadow()
and useDynamicShadow()
call.
Parameters | |
---|---|
hasShadow | boolean |
hasColorDimOverlay | boolean |
roundedCorners | boolean |
prepareParentForShadow
void prepareParentForShadow (ViewGroup parent)
prepareParentForShadow(ViewGroup)
must be called on parent of container before using shadow. Depending on sdk version, optical bounds might be applied to parent.
Parameters | |
---|---|
parent | ViewGroup |
setOverlayColor
void setOverlayColor (int overlayColor)
Set color (with alpha) of the overlay.
Parameters | |
---|---|
overlayColor | int |
setShadowFocusLevel
void setShadowFocusLevel (float level)
Set shadow focus level (0 to 1). 0 for unfocused, 1f for fully focused.
Parameters | |
---|---|
level | float |
supportsDynamicShadow
boolean supportsDynamicShadow ()
Returns true if the platform sdk supports dynamic shadows.
Returns | |
---|---|
boolean |
supportsShadow
boolean supportsShadow ()
Return true if the platform sdk supports shadow.
Returns | |
---|---|
boolean |
useDynamicShadow
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.
Parameters | |
---|---|
unfocusedZ | float |
focusedZ | float |
useDynamicShadow
void useDynamicShadow ()
Sets the shadow type to SHADOW_DYNAMIC
if supported.
useStaticShadow
void useStaticShadow ()
Sets the shadow type to SHADOW_STATIC
if supported.
wrap
void wrap (View view)
Inserts view into the wrapper.
Parameters | |
---|---|
view | View |
Protected methods
onLayout
void onLayout (boolean changed, int l, int t, int r, int b)
Parameters | |
---|---|
changed | boolean |
l | int |
t | int |
r | int |
b | int |
Interfaces
- BaseGridView.OnKeyInterceptListener
- BaseGridView.OnMotionInterceptListener
- BaseGridView.OnTouchInterceptListener
- BaseGridView.OnUnhandledKeyListener
- BaseOnItemViewClickedListener
- BaseOnItemViewSelectedListener
- BrowseFrameLayout.OnChildFocusListener
- BrowseFrameLayout.OnFocusSearchListener
- FacetProvider
- FacetProviderAdapter
- FocusHighlight
- FragmentAnimationProvider
- ImeKeyMonitor
- ImeKeyMonitor.ImeKeyListener
- MultiActionsProvider
- OnActionClickedListener
- OnChildLaidOutListener
- OnChildSelectedListener
- OnItemViewClickedListener
- OnItemViewSelectedListener
- PlaybackSeekUi
- SearchBar.SearchBarListener
- SearchBar.SearchBarPermissionListener
- SearchEditText.OnKeyboardDismissListener
- SpeechRecognitionCallback
- TitleViewAdapter.Provider
- ViewHolderTask
Classes
- AbstractDetailsDescriptionPresenter
- AbstractDetailsDescriptionPresenter.ViewHolder
- AbstractMediaItemPresenter
- AbstractMediaItemPresenter.ViewHolder
- AbstractMediaListHeaderPresenter
- AbstractMediaListHeaderPresenter.ViewHolder
- Action
- ArrayObjectAdapter
- BaseCardView
- BaseCardView.LayoutParams
- BaseGridView
- BrowseFrameLayout
- ClassPresenterSelector
- ControlButtonPresenterSelector
- CursorObjectAdapter
- DetailsOverviewLogoPresenter
- DetailsOverviewLogoPresenter.ViewHolder
- DetailsOverviewRow
- DetailsOverviewRow.Listener
- DetailsOverviewRowPresenter
- DetailsOverviewRowPresenter.ViewHolder
- DetailsParallax
- DiffCallback
- DividerPresenter
- DividerRow
- FocusHighlightHelper
- FullWidthDetailsOverviewRowPresenter
- FullWidthDetailsOverviewRowPresenter.Listener
- FullWidthDetailsOverviewRowPresenter.ViewHolder
- FullWidthDetailsOverviewRowPresenter.ViewHolder.DetailsOverviewRowListener
- FullWidthDetailsOverviewSharedElementHelper
- GuidanceStylist
- GuidanceStylist.Guidance
- GuidedAction
- GuidedAction.Builder
- GuidedAction.BuilderBase
- GuidedActionDiffCallback
- GuidedActionEditText
- GuidedActionsStylist
- GuidedActionsStylist.ViewHolder
- GuidedDatePickerAction
- GuidedDatePickerAction.Builder
- GuidedDatePickerAction.BuilderBase
- HeaderItem
- HorizontalGridView
- HorizontalHoverCardSwitcher
- ImageCardView
- ItemAlignmentFacet
- ItemAlignmentFacet.ItemAlignmentDef
- ItemBridgeAdapter
- ItemBridgeAdapter.AdapterListener
- ItemBridgeAdapter.ViewHolder
- ItemBridgeAdapter.Wrapper
- ItemBridgeAdapterShadowOverlayWrapper
- ListRow
- ListRowHoverCardView
- ListRowPresenter
- ListRowPresenter.SelectItemViewHolderTask
- ListRowPresenter.ViewHolder
- ListRowView
- MultiActionsProvider.MultiAction
- ObjectAdapter
- ObjectAdapter.DataObserver
- OnChildViewHolderSelectedListener
- PageRow
- Parallax
- Parallax.FloatProperty
- Parallax.IntProperty
- Parallax.PropertyMarkerValue
- ParallaxEffect
- ParallaxTarget
- ParallaxTarget.DirectPropertyTarget
- ParallaxTarget.PropertyValuesHolderTarget
- PlaybackControlsRow
- PlaybackControlsRow.ClosedCaptioningAction
- PlaybackControlsRow.FastForwardAction
- PlaybackControlsRow.HighQualityAction
- PlaybackControlsRow.MoreActions
- PlaybackControlsRow.MultiAction
- PlaybackControlsRow.OnPlaybackProgressCallback
- PlaybackControlsRow.PictureInPictureAction
- PlaybackControlsRow.PlayPauseAction
- PlaybackControlsRow.RepeatAction
- PlaybackControlsRow.RewindAction
- PlaybackControlsRow.ShuffleAction
- PlaybackControlsRow.SkipNextAction
- PlaybackControlsRow.SkipPreviousAction
- PlaybackControlsRow.ThumbsAction
- PlaybackControlsRow.ThumbsDownAction
- PlaybackControlsRow.ThumbsUpAction
- PlaybackControlsRowPresenter
- PlaybackControlsRowPresenter.ViewHolder
- PlaybackRowPresenter
- PlaybackRowPresenter.ViewHolder
- PlaybackSeekDataProvider
- PlaybackSeekDataProvider.ResultCallback
- PlaybackSeekUi.Client
- PlaybackTransportRowPresenter
- PlaybackTransportRowPresenter.ViewHolder
- Presenter
- Presenter.ViewHolder
- Presenter.ViewHolderTask
- PresenterSelector
- PresenterSwitcher
- RecyclerViewParallax
- RecyclerViewParallax.ChildPositionProperty
- Row
- RowHeaderPresenter
- RowHeaderPresenter.ViewHolder
- RowHeaderView
- RowPresenter
- RowPresenter.ViewHolder
- SearchBar
- SearchEditText
- SearchOrbView
- SearchOrbView.Colors
- SectionRow
- ShadowOverlayContainer
- ShadowOverlayHelper
- ShadowOverlayHelper.Builder
- ShadowOverlayHelper.Options
- SinglePresenterSelector
- SparseArrayObjectAdapter
- SpeechOrbView
- TitleHelper
- TitleView
- TitleViewAdapter
- VerticalGridPresenter
- VerticalGridPresenter.ViewHolder
- VerticalGridView