SESL Material/com.google.android.material.carousel/CarouselLayoutManager

CarouselLayoutManager

open class CarouselLayoutManager : RecyclerView.LayoutManager, Carousel, RecyclerView.SmoothScroller.ScrollVectorProvider

A LayoutManager that can mask and offset items along the scrolling axis, creating a unique list optimized for a stylized viewing experience.

CarouselLayoutManager requires all children to use MaskableFrameLayout as their root ViewGroup.

Note that when Carousel measures and lays out items, the first item in the adapter will be measured and it's desired size will be used to determine an appropriate size for all items in the carousel.

For more information, see the component developer guidance and design guidelines.

Constructors

CarouselLayoutManager

constructor()

constructor(@NonNull strategy: CarouselStrategy)

constructor(@NonNull strategy: CarouselStrategy, orientation: Int)

constructor(context: Context, attrs: AttributeSet, defStyleAttr: Int, defStyleRes: Int)

Properties

ALIGNMENT_CENTER

val ALIGNMENT_CENTER: Int = 1

Aligns large items to the center of the carousel.

ALIGNMENT_START

val ALIGNMENT_START: Int = 0

Aligns large items to the start of the carousel.

carouselAlignment

open var carouselAlignment: Int

HORIZONTAL

val HORIZONTAL: Int = 0

Horizontal orientation for Carousel.

VERTICAL

val VERTICAL: Int = 1

Vertical orientation for Carousel.

Functions

canScrollHorizontally

open fun canScrollHorizontally(): Boolean

canScrollVertically

open fun canScrollVertically(): Boolean

computeHorizontalScrollExtent

open fun computeHorizontalScrollExtent(@NonNull state: RecyclerView.State): Int

Compute the extent of the horizontal scrollbar thumb.

computeHorizontalScrollOffset

open fun computeHorizontalScrollOffset(@NonNull state: RecyclerView.State): Int

Calculate the offset of the horizontal scrollbar thumb within the horizontal range.

computeHorizontalScrollRange

open fun computeHorizontalScrollRange(@NonNull state: RecyclerView.State): Int

Compute the horizontal range represented by the horizontal scroll bars.

computeScrollVectorForPosition

@Nullable

open fun computeScrollVectorForPosition(targetPosition: Int): PointF

computeVerticalScrollExtent

open fun computeVerticalScrollExtent(@NonNull state: RecyclerView.State): Int

computeVerticalScrollOffset

open fun computeVerticalScrollOffset(@NonNull state: RecyclerView.State): Int

computeVerticalScrollRange

open fun computeVerticalScrollRange(@NonNull state: RecyclerView.State): Int

generateDefaultLayoutParams

open fun generateDefaultLayoutParams(): RecyclerView.LayoutParams

getContainerHeight

open fun getContainerHeight(): Int

Gets the height of the carousel container.

getContainerWidth

open fun getContainerWidth(): Int

Gets the width of the carousel container.

getDecoratedBoundsWithMargins

open fun getDecoratedBoundsWithMargins(@NonNull view: View, @NonNull outBounds: Rect)

Returns the masked, decorated bounds with margins for view.

getOrientation

open fun getOrientation(): Int

Returns the current orientation of the layout.

isAutoMeasureEnabled

open fun isAutoMeasureEnabled(): Boolean

isHorizontal

open fun isHorizontal(): Boolean

Whether or not the orientation is horizontal.

measureChildWithMargins

open fun measureChildWithMargins(@NonNull child: View, widthUsed: Int, heightUsed: Int)

onAttachedToWindow

open fun onAttachedToWindow(view: RecyclerView)

onDetachedFromWindow

open fun onDetachedFromWindow(view: RecyclerView, recycler: RecyclerView.Recycler)

onFocusSearchFailed

@Nullable

open fun onFocusSearchFailed(@NonNull focused: View, focusDirection: Int, @NonNull recycler: RecyclerView.Recycler, @NonNull state: RecyclerView.State): View

onInitializeAccessibilityEvent

open fun onInitializeAccessibilityEvent(@NonNull event: AccessibilityEvent)

onItemsAdded

open fun onItemsAdded(@NonNull recyclerView: RecyclerView, positionStart: Int, itemCount: Int)

onItemsRemoved

open fun onItemsRemoved(@NonNull recyclerView: RecyclerView, positionStart: Int, itemCount: Int)

onLayoutChildren

open fun onLayoutChildren(recycler: RecyclerView.Recycler, state: RecyclerView.State)

onLayoutCompleted

open fun onLayoutCompleted(state: RecyclerView.State)

requestChildRectangleOnScreen

open fun requestChildRectangleOnScreen(@NonNull parent: RecyclerView, @NonNull child: View, @NonNull rect: Rect, immediate: Boolean, focusedChildVisible: Boolean): Boolean

scrollHorizontallyBy

open fun scrollHorizontallyBy(dx: Int, recycler: RecyclerView.Recycler, state: RecyclerView.State): Int

scrollToPosition

open fun scrollToPosition(position: Int)

scrollVerticallyBy

open fun scrollVerticallyBy(dy: Int, recycler: RecyclerView.Recycler, state: RecyclerView.State): Int

setCarouselStrategy

open fun setCarouselStrategy(@NonNull carouselStrategy: CarouselStrategy)

Sets the CarouselStrategy used by this layout manager to mask and offset child views as they move along the scrolling axis.

setDebuggingEnabled

@RestrictTo(value = Scope.LIBRARY_GROUP)

open fun setDebuggingEnabled(@NonNull recyclerView: RecyclerView, enabled: Boolean)

Enables features to help debug keylines and other internal layout manager logic.

setOrientation

open fun setOrientation(orientation: Int)

Sets the orientation of the layout.

smoothScrollToPosition

open fun smoothScrollToPosition(recyclerView: RecyclerView, state: RecyclerView.State, position: Int)