com.gtomato.android.ui.manager

Class CarouselLayoutManager

java.lang.Object

android.support.v7.widget.RecyclerView.LayoutManager

com.gtomato.android.ui.manager.CarouselLayoutManager

public class CarouselLayoutManager
extends android.support.v7.widget.RecyclerView.LayoutManager

Layout Manager used to help view layout in CarouselView. Normal users are not expected to access this class directly.

Field Summary

Fields

Modifier and Type	Field and Description
static CarouselView.Scroller	DEFAULT_SCROLLER
static CarouselView.ViewTransformer	DEFAULT_TRANSFORMER

Constructor Summary

Constructors

Constructor and Description
CarouselLayoutManager()

Method Summary

Modifier and Type	Method and Description
boolean	canScrollHorizontally()
boolean	canScrollVertically()
android.support.v7.widget.RecyclerView.LayoutParams	generateDefaultLayoutParams()
protected CarouselView	getCarouselView() Retrieve the underlying CarouselView.
float	getCurrentOffset() Returns the scrolling position in pixel.
int	getCurrentPosition() Returns the current position.
float	getCurrentPositionPoint() Returns the current position in floating points.
CarouselView.DrawOrder	getDrawOrder() Returns the drawing order of the centermost item.
int	getExtraVisibleChilds() Returns the number of extra children per side to be preserved and managed by transformations.
int	getGravity() Returns how itemviews are positioned.
CarouselView.Scroller	getScroller() Return the scroller currently in use.
int	getScrollX() Returns the current X-axis scrolling position in pixels.
CarouselView.ViewTransformer	getTransformer() Returns the transformer currently in use.
boolean	isInfinite() Returns whether the items are recurring.
boolean	isValidPosition(int position) Returns whether a given absolution position is valid, which the rules are also based on current value of isInfinite().
void	measureChildWithMargins(android.view.View child, int widthUsed, int heightUsed)
void	onAdapterChanged(android.support.v7.widget.RecyclerView.Adapter oldAdapter, android.support.v7.widget.RecyclerView.Adapter newAdapter)
void	onAttachedToWindow(android.support.v7.widget.RecyclerView view)
void	onDetachedFromWindow(android.support.v7.widget.RecyclerView view, android.support.v7.widget.RecyclerView.Recycler recycler)
void	onItemsAdded(android.support.v7.widget.RecyclerView recyclerView, int positionStart, int itemCount)
void	onItemsChanged(android.support.v7.widget.RecyclerView recyclerView)
void	onItemsMoved(android.support.v7.widget.RecyclerView recyclerView, int from, int to, int itemCount)
void	onItemsRemoved(android.support.v7.widget.RecyclerView recyclerView, int positionStart, int itemCount)
void	onItemsUpdated(android.support.v7.widget.RecyclerView recyclerView, int positionStart, int itemCount)
void	onLayoutChildren(android.support.v7.widget.RecyclerView.Recycler recycler, android.support.v7.widget.RecyclerView.State state) Major layout pass to layout children views.
void	onMeasure(android.support.v7.widget.RecyclerView.Recycler recycler, android.support.v7.widget.RecyclerView.State state, int widthSpec, int heightSpec)
void	onRestoreInstanceState(android.os.Parcelable state)
android.os.Parcelable	onSaveInstanceState()
protected float	pixelToPosition(int pixel) Returns a position based on a given pixel.
protected boolean	post(java.lang.Runnable action) Add a given runnable action to the underlying CarouselView.
void	resetOptions() Reset options that may be modified by built-in transformers.
int	scrollHorizontallyBy(int dx, android.support.v7.widget.RecyclerView.Recycler recycler, android.support.v7.widget.RecyclerView.State state)
void	scrollToPosition(int position)
CarouselLayoutManager	setDrawOrder(CarouselView.DrawOrder drawOrder) Set the drawing order of the centermost item.
CarouselLayoutManager	setExtraVisibleChilds(CarouselView carouselView, int num) Set the number of extra children per side to be preserved and managed by transformations.
void	setGravity(int gravity) Set how itemviews are positioned.
CarouselLayoutManager	setInfinite(boolean infinite) Set whether the items are recurring.
void	setMeasuredDimension(int widthSize, int heightSize)
CarouselLayoutManager	setOnItemClickListener(CarouselView.OnItemClickListener onItemClickListener) Set an OnItemClickListener.
CarouselLayoutManager	setScroller(CarouselView.Scroller scroller) Set the scrolling behaviour as the given implementation.
CarouselLayoutManager	setTransformer(CarouselView.ViewTransformer transformer) Provide a custom transformation implementation.
void	smoothScrollToPosition(android.support.v7.widget.RecyclerView recyclerView, android.support.v7.widget.RecyclerView.State state, int position)
int	translatePosition(int position) Returns an adapter position based on a given absolute position.

Methods inherited from class android.support.v7.widget.RecyclerView.LayoutManager

addDisappearingView, addDisappearingView, addView, addView, assertInLayoutOrScroll, assertNotInLayoutOrScroll, attachView, attachView, attachView, calculateItemDecorationsForChild, checkLayoutParams, computeHorizontalScrollExtent, computeHorizontalScrollOffset, computeHorizontalScrollRange, computeVerticalScrollExtent, computeVerticalScrollOffset, computeVerticalScrollRange, detachAndScrapAttachedViews, detachAndScrapView, detachAndScrapViewAt, detachView, detachViewAt, endAnimation, findViewByPosition, generateLayoutParams, generateLayoutParams, getBottomDecorationHeight, getChildAt, getChildCount, getChildMeasureSpec, getClipToPadding, getColumnCountForAccessibility, getDecoratedBottom, getDecoratedLeft, getDecoratedMeasuredHeight, getDecoratedMeasuredWidth, getDecoratedRight, getDecoratedTop, getFocusedChild, getHeight, getItemCount, getItemViewType, getLayoutDirection, getLeftDecorationWidth, getMinimumHeight, getMinimumWidth, getPaddingBottom, getPaddingEnd, getPaddingLeft, getPaddingRight, getPaddingStart, getPaddingTop, getPosition, getRightDecorationWidth, getRowCountForAccessibility, getSelectionModeForAccessibility, getTopDecorationHeight, getWidth, hasFocus, ignoreView, isFocused, isLayoutHierarchical, isSmoothScrolling, layoutDecorated, measureChild, moveView, offsetChildrenHorizontal, offsetChildrenVertical, onAddFocusables, onDetachedFromWindow, onFocusSearchFailed, onInitializeAccessibilityEvent, onInitializeAccessibilityEvent, onInitializeAccessibilityNodeInfo, onInitializeAccessibilityNodeInfoForItem, onInterceptFocusSearch, onRequestChildFocus, onRequestChildFocus, onScrollStateChanged, performAccessibilityAction, performAccessibilityActionForItem, removeAllViews, removeAndRecycleAllViews, removeAndRecycleView, removeAndRecycleViewAt, removeDetachedView, removeView, removeViewAt, requestChildRectangleOnScreen, requestLayout, requestSimpleAnimationsInNextLayout, scrollVerticallyBy, startSmoothScroll, stopIgnoringView, supportsPredictiveItemAnimations

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_TRANSFORMER

public static final CarouselView.ViewTransformer DEFAULT_TRANSFORMER

DEFAULT_SCROLLER

public static final CarouselView.Scroller DEFAULT_SCROLLER

Constructor Detail

CarouselLayoutManager

public CarouselLayoutManager()

Method Detail

onSaveInstanceState

public android.os.Parcelable onSaveInstanceState()

Overrides:

onSaveInstanceState in class android.support.v7.widget.RecyclerView.LayoutManager

onRestoreInstanceState

public void onRestoreInstanceState(android.os.Parcelable state)

Overrides:

onRestoreInstanceState in class android.support.v7.widget.RecyclerView.LayoutManager

setTransformer

public CarouselLayoutManager setTransformer(CarouselView.ViewTransformer transformer)

Provide a custom transformation implementation.

Parameters:

transformer -

Returns:

resetOptions

public void resetOptions()

Reset options that may be modified by built-in transformers. Note: Other options, e.g. extraVisibleChilds, that possibly set by custom transformers may have to reset by developers manually.

getTransformer

public CarouselView.ViewTransformer getTransformer()

Returns the transformer currently in use.

Returns:

getExtraVisibleChilds

public int getExtraVisibleChilds()

Returns the number of extra children per side to be preserved and managed by transformations.

Returns:

setExtraVisibleChilds

public CarouselLayoutManager setExtraVisibleChilds(CarouselView carouselView,
                                                   int num)

Set the number of extra children per side to be preserved and managed by transformations.

Number of cached children views = (num + 2) * 2 + 1

Parameters:

carouselView -

num -

Returns:

isInfinite

public boolean isInfinite()

Returns whether the items are recurring.

Returns:

setInfinite

public CarouselLayoutManager setInfinite(boolean infinite)

Set whether the items are recurring.

Parameters:

infinite -

Returns:

getScroller

public CarouselView.Scroller getScroller()

Return the scroller currently in use.

Returns:

setScroller

public CarouselLayoutManager setScroller(CarouselView.Scroller scroller)

Set the scrolling behaviour as the given implementation.

Parameters:

scroller -

Returns:

setGravity

public void setGravity(int gravity)

Set how itemviews are positioned.

Parameters:

gravity -

getGravity

public int getGravity()

Returns how itemviews are positioned.

Returns:

getDrawOrder

public CarouselView.DrawOrder getDrawOrder()

Returns the drawing order of the centermost item.

Returns:

setDrawOrder

public CarouselLayoutManager setDrawOrder(CarouselView.DrawOrder drawOrder)

Set the drawing order of the centermost item.

Parameters:

drawOrder -

Returns:

setOnItemClickListener

public CarouselLayoutManager setOnItemClickListener(CarouselView.OnItemClickListener onItemClickListener)

Set an OnItemClickListener.

Parameters:

onItemClickListener -

Returns:

generateDefaultLayoutParams

public android.support.v7.widget.RecyclerView.LayoutParams generateDefaultLayoutParams()

Specified by:

generateDefaultLayoutParams in class android.support.v7.widget.RecyclerView.LayoutManager

canScrollHorizontally

public boolean canScrollHorizontally()

Overrides:

canScrollHorizontally in class android.support.v7.widget.RecyclerView.LayoutManager

Returns:

true

canScrollVertically

public boolean canScrollVertically()

Overrides:

canScrollVertically in class android.support.v7.widget.RecyclerView.LayoutManager

Returns:

false

getScrollX

public int getScrollX()

Returns the current X-axis scrolling position in pixels.

Returns:

getCurrentPosition

public int getCurrentPosition()

Returns the current position. It can be negative or very large if the items are repeating.

Returns:

getCurrentPositionPoint

public float getCurrentPositionPoint()

Returns the current position in floating points.

Returns:

getCurrentOffset

public float getCurrentOffset()

Returns the scrolling position in pixel.

Returns:

scrollHorizontallyBy

public int scrollHorizontallyBy(int dx,
                                android.support.v7.widget.RecyclerView.Recycler recycler,
                                android.support.v7.widget.RecyclerView.State state)

Overrides:

scrollHorizontallyBy in class android.support.v7.widget.RecyclerView.LayoutManager

pixelToPosition

protected float pixelToPosition(int pixel)

Returns a position based on a given pixel.

Parameters:

pixel -

Returns:

onMeasure

public void onMeasure(android.support.v7.widget.RecyclerView.Recycler recycler,
                      android.support.v7.widget.RecyclerView.State state,
                      int widthSpec,
                      int heightSpec)

Overrides:

onMeasure in class android.support.v7.widget.RecyclerView.LayoutManager

setMeasuredDimension

public void setMeasuredDimension(int widthSize,
                                 int heightSize)

Overrides:

setMeasuredDimension in class android.support.v7.widget.RecyclerView.LayoutManager

measureChildWithMargins

public void measureChildWithMargins(android.view.View child,
                                    int widthUsed,
                                    int heightUsed)

Overrides:

measureChildWithMargins in class android.support.v7.widget.RecyclerView.LayoutManager

onLayoutChildren

public void onLayoutChildren(android.support.v7.widget.RecyclerView.Recycler recycler,
                             android.support.v7.widget.RecyclerView.State state)

Major layout pass to layout children views.

Overrides:

onLayoutChildren in class android.support.v7.widget.RecyclerView.LayoutManager

Parameters:

recycler -

state -

translatePosition

public int translatePosition(int position)

Returns an adapter position based on a given absolute position.

Parameters:

position -

Returns:

isValidPosition

public boolean isValidPosition(int position)

Returns whether a given absolution position is valid, which the rules are also based on current value of isInfinite().

Parameters:

position -

Returns:

scrollToPosition

public void scrollToPosition(int position)

Overrides:

scrollToPosition in class android.support.v7.widget.RecyclerView.LayoutManager

smoothScrollToPosition

public void smoothScrollToPosition(android.support.v7.widget.RecyclerView recyclerView,
                                   android.support.v7.widget.RecyclerView.State state,
                                   int position)

Overrides:

smoothScrollToPosition in class android.support.v7.widget.RecyclerView.LayoutManager

onAdapterChanged

public void onAdapterChanged(android.support.v7.widget.RecyclerView.Adapter oldAdapter,
                             android.support.v7.widget.RecyclerView.Adapter newAdapter)

Overrides:

onAdapterChanged in class android.support.v7.widget.RecyclerView.LayoutManager

onItemsChanged

public void onItemsChanged(android.support.v7.widget.RecyclerView recyclerView)

Overrides:

onItemsChanged in class android.support.v7.widget.RecyclerView.LayoutManager

onItemsUpdated

public void onItemsUpdated(android.support.v7.widget.RecyclerView recyclerView,
                           int positionStart,
                           int itemCount)

Overrides:

onItemsUpdated in class android.support.v7.widget.RecyclerView.LayoutManager

onItemsAdded

public void onItemsAdded(android.support.v7.widget.RecyclerView recyclerView,
                         int positionStart,
                         int itemCount)

Overrides:

onItemsAdded in class android.support.v7.widget.RecyclerView.LayoutManager

onItemsRemoved

public void onItemsRemoved(android.support.v7.widget.RecyclerView recyclerView,
                           int positionStart,
                           int itemCount)

Overrides:

onItemsRemoved in class android.support.v7.widget.RecyclerView.LayoutManager

onItemsMoved

public void onItemsMoved(android.support.v7.widget.RecyclerView recyclerView,
                         int from,
                         int to,
                         int itemCount)

Overrides:

onItemsMoved in class android.support.v7.widget.RecyclerView.LayoutManager

onAttachedToWindow

public void onAttachedToWindow(android.support.v7.widget.RecyclerView view)

Overrides:

onAttachedToWindow in class android.support.v7.widget.RecyclerView.LayoutManager

onDetachedFromWindow

public void onDetachedFromWindow(android.support.v7.widget.RecyclerView view,
                                 android.support.v7.widget.RecyclerView.Recycler recycler)

Overrides:

onDetachedFromWindow in class android.support.v7.widget.RecyclerView.LayoutManager

getCarouselView

protected CarouselView getCarouselView()

Retrieve the underlying CarouselView.

Returns:

post

protected boolean post(java.lang.Runnable action)

Add a given runnable action to the underlying CarouselView.

Parameters:

action -

Returns:

whether the given action is successfully queued

See Also:

View.post(Runnable)