belongs to Maven artifact com.android.support:leanback-v17:28.0.0-alpha1
ParallaxEffect
public
abstract
class
ParallaxEffect
extends Object
java.lang.Object | |
↳ | android.support.v17.leanback.widget.ParallaxEffect |
ParallaxEffect class drives changes in ParallaxTarget
in response to changes in
variables defined in Parallax
.
ParallaxEffect has a list of Parallax.PropertyMarkerValue
s which represents the range of
values that source variables can take. The main function is
performMapping(Parallax)
which computes a fraction between 0 and 1
based on the current values of variables in Parallax
. As the parallax effect goes
on, the fraction increases from 0 at beginning to 1 at the end. Then the fraction is passed on
to update(float)
.
App use addEffect(PropertyMarkerValue)
to create a ParallaxEffect.
Summary
Public methods | |
---|---|
final
void
|
addTarget(ParallaxTarget target)
Add a ParallaxTarget to run parallax effect. |
final
List<PropertyMarkerValue>
|
getPropertyRanges()
Returns the list of |
final
List<ParallaxTarget>
|
getTargets()
Returns the list of |
final
void
|
performMapping(Parallax source)
Perform mapping from |
final
void
|
removeTarget(ParallaxTarget target)
Remove a |
final
void
|
setPropertyRanges(PropertyMarkerValue... markerValues)
Sets the list of |
final
<T, V extends Number>
ParallaxEffect
|
target(T targetObject, Property<T, V> targetProperty)
Creates a |
final
ParallaxEffect
|
target(Object targetObject, PropertyValuesHolder values)
Creates a |
final
ParallaxEffect
|
target(ParallaxTarget target)
Add a ParallaxTarget to run parallax effect. |
Inherited methods | |
---|---|
From
class
java.lang.Object
|
Public methods
addTarget
void addTarget (ParallaxTarget target)
Add a ParallaxTarget to run parallax effect.
Parameters | |
---|---|
target |
ParallaxTarget : ParallaxTarget to add.
|
getPropertyRanges
List<PropertyMarkerValue> getPropertyRanges ()
Returns the list of Parallax.PropertyMarkerValue
s, which represents the range of values that
source variables can take.
Returns | |
---|---|
List<PropertyMarkerValue> |
A list of Parallax.PropertyMarkerValue s. |
See also:
getTargets
List<ParallaxTarget> getTargets ()
Returns the list of ParallaxTarget
objects.
Returns | |
---|---|
List<ParallaxTarget> |
The list of ParallaxTarget objects.
|
performMapping
void performMapping (Parallax source)
Perform mapping from Parallax
to list of ParallaxTarget
.
Parameters | |
---|---|
source |
Parallax |
removeTarget
void removeTarget (ParallaxTarget target)
Remove a ParallaxTarget
object from the list.
Parameters | |
---|---|
target |
ParallaxTarget : The ParallaxTarget object to be removed.
|
setPropertyRanges
void setPropertyRanges (PropertyMarkerValue... markerValues)
Sets the list of Parallax.PropertyMarkerValue
s, which represents the range of values that
source variables can take.
Parameters | |
---|---|
markerValues |
PropertyMarkerValue : A list of Parallax.PropertyMarkerValue s. |
See also:
target
ParallaxEffect target (T targetObject, Property<T, V> targetProperty)
Creates a ParallaxTarget
using direct mapping from source property into target
property, the new ParallaxTarget
will be added to its list of targets.
Parameters | |
---|---|
targetObject |
T : Target object for property. |
targetProperty |
Property : The target property that will receive values. |
Returns | |
---|---|
ParallaxEffect |
This ParallaxEffect object, allowing calls to methods in this class to be chained. |
See also:
target
ParallaxEffect target (Object targetObject, PropertyValuesHolder values)
Creates a ParallaxTarget
from PropertyValuesHolder
and adds it to the list
of targets.
Parameters | |
---|---|
targetObject |
Object : Target object for PropertyValuesHolderTarget. |
values |
PropertyValuesHolder : PropertyValuesHolder for PropertyValuesHolderTarget. |
Returns | |
---|---|
ParallaxEffect |
This ParallaxEffect object, allowing calls to methods in this class to be chained. |
target
ParallaxEffect target (ParallaxTarget target)
Add a ParallaxTarget to run parallax effect.
Parameters | |
---|---|
target |
ParallaxTarget : ParallaxTarget to add. |
Returns | |
---|---|
ParallaxEffect |
This ParallaxEffect object, allowing calls to methods in this class to be chained. |
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