BoardView.java

/*
 * Copyright 2014 Magnus Woxblom
 * <p/>
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * <p/>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p/>
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.woxthebox.draglistview;

import static androidx.recyclerview.widget.RecyclerView.NO_POSITION;

import android.animation.Animator;
import android.animation.AnimatorListenerAdapter;
import android.content.Context;
import android.content.res.Configuration;
import android.content.res.Resources;
import android.content.res.TypedArray;
import android.graphics.drawable.Drawable;
import android.os.Parcel;
import android.os.Parcelable;
import android.util.AttributeSet;
import android.view.GestureDetector;
import android.view.LayoutInflater;
import android.view.MotionEvent;
import android.view.View;
import android.view.animation.DecelerateInterpolator;
import android.widget.FrameLayout;
import android.widget.HorizontalScrollView;
import android.widget.LinearLayout;
import android.widget.Scroller;

import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.core.view.ViewCompat;
import androidx.recyclerview.widget.DefaultItemAnimator;
import androidx.recyclerview.widget.LinearLayoutManager;
import androidx.recyclerview.widget.RecyclerView;

import java.util.ArrayList;
import java.util.List;

public class BoardView extends HorizontalScrollView implements AutoScroller.AutoScrollListener {

    public interface BoardCallback {
        boolean canDragItemAtPosition(int column, int row);

        boolean canDropItemAtPosition(int oldColumn, int oldRow, int newColumn, int newRow);

        boolean canDragColumnAtPosition(int index);

        boolean canDropColumnAtPosition(int oldIndex, int newIndex);
    }

    public interface BoardListener {
        void onItemDragStarted(int column, int row);

        void onItemDragEnded(int fromColumn, int fromRow, int toColumn, int toRow);

        void onItemChangedPosition(int oldColumn, int oldRow, int newColumn, int newRow);

        void onItemChangedColumn(int oldColumn, int newColumn);

        void onFocusedColumnChanged(int oldColumn, int newColumn);

        void onColumnDragStarted(int position);

        void onColumnDragChangedPosition(int oldPosition, int newPosition);

        void onColumnDragEnded(int fromPosition, int toPosition);
    }

    public static abstract class BoardListenerAdapter implements BoardListener {
        @Override
        public void onItemDragStarted(int column, int row) {
        }

        @Override
        public void onItemDragEnded(int fromColumn, int fromRow, int toColumn, int toRow) {
        }

        @Override
        public void onItemChangedPosition(int oldColumn, int oldRow, int newColumn, int newRow) {
        }

        @Override
        public void onItemChangedColumn(int oldColumn, int newColumn) {
        }

        @Override
        public void onFocusedColumnChanged(int oldColumn, int newColumn) {
        }

        @Override
        public void onColumnDragStarted(int position) {
        }

        @Override
        public void onColumnDragChangedPosition(int oldPosition, int newPosition) {
        }

        @Override
        public void onColumnDragEnded(int fromPosition, int toPosition) {
        }
    }

    public enum ColumnSnapPosition {
        LEFT, CENTER, RIGHT
    }

    private static final int SCROLL_ANIMATION_DURATION = 325;
    private Scroller mScroller;
    private AutoScroller mAutoScroller;
    private GestureDetector mGestureDetector;
    private FrameLayout mRootLayout;
    private LinearLayout mColumnLayout;
    private ArrayList<DragItemRecyclerView> mLists = new ArrayList<>();
    private ArrayList<View> mHeaders = new ArrayList<>();
    private ArrayList<View> mFooters = new ArrayList<>();
    private DragItemRecyclerView mCurrentRecyclerView;
    private DragItem mDragItem;
    private DragItem mDragColumn;
    private BoardListener mBoardListener;
    private BoardCallback mBoardCallback;
    private boolean mSnapToColumnWhenScrolling = true;
    private boolean mSnapToColumnWhenDragging = true;
    private boolean mSnapToColumnInLandscape = false;
    private ColumnSnapPosition mSnapPosition = ColumnSnapPosition.CENTER;
    private int mCurrentColumn;
    private float mTouchX;
    private float mTouchY;
    private float mDragColumnStartScrollX;
    private int mColumnWidth;
    private int mColumnSpacing = 0;
    private int mBoardEdge = 0;
    private int mDragStartColumn;
    private int mDragStartRow;
    private boolean mHasLaidOut;
    private boolean mDragEnabled = true;
    private int mLastDragColumn = NO_POSITION;
    private int mLastDragRow = NO_POSITION;
    private int mDragColumnStartPosition;
    private SavedState mSavedState;

    public BoardView(Context context) {
        super(context);
    }

    public BoardView(Context context, AttributeSet attrs) {
        super(context, attrs);
        init(attrs);
    }

    public BoardView(Context context, AttributeSet attrs, int defStyleAttr) {
        super(context, attrs, defStyleAttr);
        init(attrs);
    }

    private void init(AttributeSet attrs) {
        TypedArray a = getContext().obtainStyledAttributes(attrs, R.styleable.BoardView);

        mColumnSpacing = a.getDimensionPixelSize(R.styleable.BoardView_columnSpacing, 0);
        mBoardEdge = a.getDimensionPixelSize(R.styleable.BoardView_boardEdges, 0);

        a.recycle();
    }

    @Override
    protected void onFinishInflate() {
        super.onFinishInflate();
        Resources res = getResources();
        boolean isPortrait = res.getConfiguration().orientation == Configuration.ORIENTATION_PORTRAIT;
        if (isPortrait) {
            mColumnWidth = (int) (res.getDisplayMetrics().widthPixels * 0.87);
        } else {
            mColumnWidth = (int) (res.getDisplayMetrics().density * 320);
        }

        mGestureDetector = new GestureDetector(getContext(), new GestureListener());
        mScroller = new Scroller(getContext(), new DecelerateInterpolator(1.1f));
        mAutoScroller = new AutoScroller(getContext(), this);
        mAutoScroller.setAutoScrollMode(snapToColumnWhenDragging() ? AutoScroller.AutoScrollMode.COLUMN : AutoScroller.AutoScrollMode
                .POSITION);
        mDragItem = new DragItem(getContext());
        mDragColumn = new DragItem(getContext());
        mDragColumn.setSnapToTouch(false);

        mRootLayout = new FrameLayout(getContext());
        mRootLayout.setLayoutParams(new LayoutParams(LayoutParams.WRAP_CONTENT, LayoutParams.MATCH_PARENT));

        mColumnLayout = new LinearLayout(getContext());
        mColumnLayout.setOrientation(LinearLayout.HORIZONTAL);
        mColumnLayout.setLayoutParams(new LayoutParams(LayoutParams.WRAP_CONTENT, LayoutParams.MATCH_PARENT));
        mColumnLayout.setMotionEventSplittingEnabled(false);

        mRootLayout.addView(mColumnLayout);
        mRootLayout.addView(mDragItem.getDragItemView());
        addView(mRootLayout);
    }

    @Override
    protected void onLayout(boolean changed, int l, int t, int r, int b) {
        super.onLayout(changed, l, t, r, b);
        updateBoardSpaces();
        // Snap to closes column after first layout.
        // This is needed so correct column is scrolled to after a rotation.
        if (!mHasLaidOut && mSavedState != null) {
            mCurrentColumn = mSavedState.currentColumn;
            mSavedState = null;
            post(new Runnable() {
                @Override
                public void run() {
                    scrollToColumn(mCurrentColumn, false);
                }
            });
        }
        mHasLaidOut = true;
    }

    @Override
    protected void onRestoreInstanceState(Parcelable state) {
        SavedState ss = (SavedState) state;
        super.onRestoreInstanceState(ss.getSuperState());
        mSavedState = ss;
        requestLayout();
    }

    @Override
    protected Parcelable onSaveInstanceState() {
        Parcelable superState = super.onSaveInstanceState();
        return new SavedState(superState, snapToColumnWhenScrolling() ? mCurrentColumn : getClosestSnapColumn());
    }

    @Override
    public boolean onInterceptTouchEvent(MotionEvent event) {
        boolean retValue = handleTouchEvent(event);
        return retValue || super.onInterceptTouchEvent(event);
    }

    @Override
    public boolean onTouchEvent(MotionEvent event) {
        boolean retValue = handleTouchEvent(event);
        return retValue || super.onTouchEvent(event);
    }

    private boolean handleTouchEvent(MotionEvent event) {
        if (mLists.size() == 0) {
            return false;
        }

        mTouchX = event.getX();
        mTouchY = event.getY();
        if (isDragging()) {
            switch (event.getAction()) {
                case MotionEvent.ACTION_MOVE:
                    if (!mAutoScroller.isAutoScrolling()) {
                        updateScrollPosition();
                    }
                    break;
                case MotionEvent.ACTION_UP:
                case MotionEvent.ACTION_CANCEL:
                    mAutoScroller.stopAutoScroll();
                    if (isDraggingColumn()) {
                        endDragColumn();
                    } else {
                        mCurrentRecyclerView.onDragEnded();
                    }
                    if (snapToColumnWhenScrolling()) {
                        scrollToColumn(getColumnOfList(mCurrentRecyclerView), true);
                    }
                    invalidate();
                    break;
            }
            return true;
        } else {
            if (snapToColumnWhenScrolling() && mGestureDetector.onTouchEvent(event)) {
                // A page fling occurred, consume event
                return true;
            }
            switch (event.getAction()) {
                case MotionEvent.ACTION_DOWN:
                    if (!mScroller.isFinished()) {
                        // View was grabbed during animation
                        mScroller.forceFinished(true);
                    }
                    break;
                case MotionEvent.ACTION_UP:
                case MotionEvent.ACTION_CANCEL:
                    if (snapToColumnWhenScrolling()) {
                        scrollToColumn(getClosestSnapColumn(), true);
                    }
                    break;
            }
            return false;
        }
    }

    @Override
    public void computeScroll() {
        if (!mScroller.isFinished() && mScroller.computeScrollOffset()) {
            int x = mScroller.getCurrX();
            int y = mScroller.getCurrY();
            if (getScrollX() != x || getScrollY() != y) {
                scrollTo(x, y);
            }

            // If auto scrolling at the same time as the scroller is running,
            // then update the drag item position to prevent stuttering item
            if (mAutoScroller.isAutoScrolling() && isDragging()) {
                if (isDraggingColumn()) {
                    mDragColumn.setPosition(mTouchX + getScrollX() - mDragColumnStartScrollX, mTouchY);
                } else {
                    mDragItem.setPosition(getRelativeViewTouchX((View) mCurrentRecyclerView.getParent()), getRelativeViewTouchY(mCurrentRecyclerView));
                }
            }

            ViewCompat.postInvalidateOnAnimation(this);
        } else if (!snapToColumnWhenScrolling()) {
            super.computeScroll();
        }
    }

    @Override
    public void onAutoScrollPositionBy(int dx, int dy) {
        if (isDragging()) {
            scrollBy(dx, dy);
            updateScrollPosition();
        } else {
            mAutoScroller.stopAutoScroll();
        }
    }

    @Override
    public void onAutoScrollColumnBy(int columns) {
        if (isDragging()) {
            int newColumn = mCurrentColumn + columns;
            if (columns != 0 && newColumn >= 0 && newColumn < mLists.size()) {
                scrollToColumn(newColumn, true);
            }
            updateScrollPosition();
        } else {
            mAutoScroller.stopAutoScroll();
        }
    }

    private void updateScrollPosition() {
        if (isDraggingColumn()) {
            DragItemRecyclerView currentList = getCurrentRecyclerView(mTouchX + getScrollX());
            if (mCurrentRecyclerView != currentList) {
                int oldIndex = getColumnOfList(mCurrentRecyclerView);
                int newIndex = getColumnOfList(currentList);
                if (mBoardCallback == null || mBoardCallback.canDropColumnAtPosition(oldIndex, newIndex)) {
                    moveColumn(oldIndex, newIndex);
                }
            }
            // Need to subtract with scrollX at the beginning of the column drag because of how drag item position is calculated
            mDragColumn.setPosition(mTouchX + getScrollX() - mDragColumnStartScrollX, mTouchY);
        } else {
            // Updated event to scrollview coordinates
            DragItemRecyclerView currentList = getCurrentRecyclerView(mTouchX + getScrollX());
            if (mCurrentRecyclerView != currentList) {
                int oldColumn = getColumnOfList(mCurrentRecyclerView);
                int newColumn = getColumnOfList(currentList);
                long itemId = mCurrentRecyclerView.getDragItemId();

                // Check if it is ok to drop the item in the new column first
                int newPosition = currentList.getDragPositionForY(getRelativeViewTouchY(currentList));
                if (mBoardCallback == null || mBoardCallback.canDropItemAtPosition(mDragStartColumn, mDragStartRow, newColumn, newPosition)) {
                    Object item = mCurrentRecyclerView.removeDragItemAndEnd();
                    if (item != null) {
                        mCurrentRecyclerView = currentList;
                        mCurrentRecyclerView.addDragItemAndStart(getRelativeViewTouchY(mCurrentRecyclerView), item, itemId);
                        mDragItem.setOffset(((View) mCurrentRecyclerView.getParent()).getLeft(), mCurrentRecyclerView.getTop());

                        if (mBoardListener != null) {
                            mBoardListener.onItemChangedColumn(oldColumn, newColumn);
                        }
                    }
                }
            }

            // Updated event to list coordinates
            mCurrentRecyclerView.onDragging(getRelativeViewTouchX((View) mCurrentRecyclerView.getParent()), getRelativeViewTouchY(mCurrentRecyclerView));
        }

        boolean isPortrait = getResources().getConfiguration().orientation == Configuration.ORIENTATION_PORTRAIT;
        float scrollEdge = getResources().getDisplayMetrics().widthPixels * (isPortrait ? 0.06f : 0.14f);
        if (mTouchX > getWidth() - scrollEdge && getScrollX() < mColumnLayout.getWidth()) {
            mAutoScroller.startAutoScroll(AutoScroller.ScrollDirection.LEFT);
        } else if (mTouchX < scrollEdge && getScrollX() > 0) {
            mAutoScroller.startAutoScroll(AutoScroller.ScrollDirection.RIGHT);
        } else {
            mAutoScroller.stopAutoScroll();
        }
        invalidate();
    }

    private float getRelativeViewTouchX(View view) {
        return mTouchX + getScrollX() - view.getLeft();
    }

    private float getRelativeViewTouchY(View view) {
        return mTouchY - view.getTop();
    }

    private DragItemRecyclerView getCurrentRecyclerView(float x) {
        for (DragItemRecyclerView list : mLists) {
            View parent = (View) list.getParent();
            if (parent.getLeft() <= x && parent.getRight() > x) {
                return list;
            }
        }
        return mCurrentRecyclerView;
    }

    private int getColumnOfList(DragItemRecyclerView list) {
        int column = 0;
        for (int i = 0; i < mLists.size(); i++) {
            RecyclerView tmpList = mLists.get(i);
            if (tmpList == list) {
                column = i;
            }
        }
        return column;
    }

    private int getCurrentColumn(float posX) {
        for (int i = 0; i < mLists.size(); i++) {
            RecyclerView list = mLists.get(i);
            View parent = (View) list.getParent();
            if (parent.getLeft() <= posX && parent.getRight() > posX) {
                return i;
            }
        }
        return 0;
    }

    private int getClosestSnapColumn() {
        int column = 0;
        int minDiffX = Integer.MAX_VALUE;
        for (int i = 0; i < mLists.size(); i++) {
            View listParent = (View) mLists.get(i).getParent();

            int diffX = 0;
            switch (mSnapPosition) {
                case LEFT:
                    int leftPosX = getScrollX();
                    diffX = Math.abs(listParent.getLeft() - leftPosX);
                    break;
                case CENTER:
                    int middlePosX = getScrollX() + getMeasuredWidth() / 2;
                    diffX = Math.abs(listParent.getLeft() + mColumnWidth / 2 - middlePosX);
                    break;
                case RIGHT:
                    int rightPosX = getScrollX() + getMeasuredWidth();
                    diffX = Math.abs(listParent.getRight() - rightPosX);
                    break;
            }

            if (diffX < minDiffX) {
                minDiffX = diffX;
                column = i;
            }
        }
        return column;
    }

    private boolean snapToColumnWhenScrolling() {
        boolean isPortrait = getResources().getConfiguration().orientation == Configuration.ORIENTATION_PORTRAIT;
        return mSnapToColumnWhenScrolling && (isPortrait || mSnapToColumnInLandscape);
    }

    private boolean snapToColumnWhenDragging() {
        boolean isPortrait = getResources().getConfiguration().orientation == Configuration.ORIENTATION_PORTRAIT;
        return mSnapToColumnWhenDragging && (isPortrait || mSnapToColumnInLandscape);
    }

    private boolean isDraggingColumn() {
        return mCurrentRecyclerView != null && mDragColumn.isDragging();
    }

    private boolean isDragging() {
        return mCurrentRecyclerView != null && (mCurrentRecyclerView.isDragging() || isDraggingColumn());
    }

    public RecyclerView getRecyclerView(int column) {
        if (column >= 0 && column < mLists.size()) {
            return mLists.get(column);
        }
        return null;
    }

    public DragItemAdapter getAdapter(int column) {
        if (column >= 0 && column < mLists.size()) {
            return (DragItemAdapter) mLists.get(column).getAdapter();
        }
        return null;
    }

    public int getItemCount() {
        int count = 0;
        for (DragItemRecyclerView list : mLists) {
            count += list.getAdapter().getItemCount();
        }
        return count;
    }

    public int getItemCount(int column) {
        if (mLists.size() > column) {
            return mLists.get(column).getAdapter().getItemCount();
        }
        return 0;
    }

    public int getColumnCount() {
        return mLists.size();
    }

    public View getHeaderView(int column) {
        return mHeaders.get(column);
    }

    public View getFooterView(int column) {
        return mFooters.get(column);
    }

    /**
     * @return The index of the column with a specific header. If the header can't be found -1 is returned.
     */
    public int getColumnOfHeader(View header) {
        for (int i = 0; i < mHeaders.size(); i++) {
            if (mHeaders.get(i) == header) {
                return i;
            }
        }
        return -1;
    }

    /**
     * @return The index of the column with a specific footer. If the footer can't be found -1 is returned.
     */
    public int getColumnOfFooter(View footer) {
        for (int i = 0; i < mFooters.size(); i++) {
            if (mFooters.get(i) == footer) {
                return i;
            }
        }
        return -1;
    }

    public void removeItem(int column, int row) {
        if (!isDragging() && mLists.size() > column && mLists.get(column).getAdapter().getItemCount() > row) {
            DragItemAdapter adapter = (DragItemAdapter) mLists.get(column).getAdapter();
            adapter.removeItem(row);
        }
    }

    public void addItem(int column, int row, Object item, boolean scrollToItem) {
        if (!isDragging() && mLists.size() > column && mLists.get(column).getAdapter().getItemCount() >= row) {
            DragItemAdapter adapter = (DragItemAdapter) mLists.get(column).getAdapter();
            adapter.addItem(row, item);
            if (scrollToItem) {
                scrollToItem(column, row, false);
            }
        }
    }

    public void moveItem(int fromColumn, int fromRow, int toColumn, int toRow, boolean scrollToItem) {
        if (!isDragging() && mLists.size() > fromColumn && mLists.get(fromColumn).getAdapter().getItemCount() > fromRow
                && mLists.size() > toColumn && mLists.get(toColumn).getAdapter().getItemCount() >= toRow) {
            DragItemAdapter adapter = (DragItemAdapter) mLists.get(fromColumn).getAdapter();
            Object item = adapter.removeItem(fromRow);
            adapter = (DragItemAdapter) mLists.get(toColumn).getAdapter();
            adapter.addItem(toRow, item);
            if (scrollToItem) {
                scrollToItem(toColumn, toRow, false);
            }
        }
    }

    public void moveItem(long itemId, int toColumn, int toRow, boolean scrollToItem) {
        for (int i = 0; i < mLists.size(); i++) {
            RecyclerView.Adapter adapter = mLists.get(i).getAdapter();
            final int count = adapter.getItemCount();
            for (int j = 0; j < count; j++) {
                long id = adapter.getItemId(j);
                if (id == itemId) {
                    moveItem(i, j, toColumn, toRow, scrollToItem);
                    return;
                }
            }
        }
    }

    public void replaceItem(int column, int row, Object item, boolean scrollToItem) {
        if (!isDragging() && mLists.size() > column && mLists.get(column).getAdapter().getItemCount() > row) {
            DragItemAdapter adapter = (DragItemAdapter) mLists.get(column).getAdapter();
            adapter.removeItem(row);
            adapter.addItem(row, item);
            if (scrollToItem) {
                scrollToItem(column, row, false);
            }
        }
    }

    public void scrollToItem(int column, int row, boolean animate) {
        if (!isDragging() && mLists.size() > column && mLists.get(column).getAdapter().getItemCount() > row) {
            mScroller.forceFinished(true);
            scrollToColumn(column, animate);
            if (animate) {
                mLists.get(column).smoothScrollToPosition(row);
            } else {
                mLists.get(column).scrollToPosition(row);
            }
        }
    }

    public void scrollToColumn(int column, boolean animate) {
        if (mLists.size() <= column) {
            return;
        }

        View parent = (View) mLists.get(column).getParent();
        MarginLayoutParams parentLayoutParams = (MarginLayoutParams) parent.getLayoutParams();
        int newX = 0;
        switch (mSnapPosition) {
            case LEFT:
                newX = parent.getLeft() - parentLayoutParams.leftMargin;
                break;
            case CENTER:
                int indent = (getMeasuredWidth() - parent.getMeasuredWidth() - parentLayoutParams.leftMargin - parentLayoutParams.rightMargin) / 2;
                newX = parent.getLeft() - parentLayoutParams.leftMargin - indent;
                break;
            case RIGHT:
                newX = parent.getRight() + parentLayoutParams.rightMargin - getMeasuredWidth();
                break;
        }

        int maxScroll = mRootLayout.getMeasuredWidth() - getMeasuredWidth();
        newX = newX < 0 ? 0 : newX;
        newX = newX > maxScroll ? maxScroll : newX;
        if (getScrollX() != newX) {
            mScroller.forceFinished(true);
            if (animate) {
                mScroller.startScroll(getScrollX(), getScrollY(), newX - getScrollX(), 0, SCROLL_ANIMATION_DURATION);
                ViewCompat.postInvalidateOnAnimation(this);
            } else {
                scrollTo(newX, getScrollY());
            }
        }

        int oldColumn = mCurrentColumn;
        mCurrentColumn = column;
        if (mBoardListener != null && oldColumn != mCurrentColumn) {
            mBoardListener.onFocusedColumnChanged(oldColumn, mCurrentColumn);
        }
    }

    public void clearBoard() {
        int count = mLists.size();
        for (int i = count - 1; i >= 0; i--) {
            mColumnLayout.removeViewAt(i);
            mHeaders.remove(i);
            mFooters.remove(i);
            mLists.remove(i);
        }
    }

    public void removeColumn(int column) {
        if (column >= 0 && mLists.size() > column) {
            mColumnLayout.removeViewAt(column);
            mHeaders.remove(column);
            mFooters.remove(column);
            mLists.remove(column);
            updateBoardSpaces();
        }
    }

    public boolean isDragEnabled() {
        return mDragEnabled;
    }

    public void setDragEnabled(boolean enabled) {
        mDragEnabled = enabled;
        if (mLists.size() > 0) {
            for (DragItemRecyclerView list : mLists) {
                list.setDragEnabled(mDragEnabled);
            }
        }
    }

    /**
     * @return The index of the currently focused column. If column snapping is not enabled this will always return 0.
     */
    public int getFocusedColumn() {
        if (!snapToColumnWhenScrolling()) {
            return 0;
        }
        return mCurrentColumn;
    }

    /**
     * @param width the width of columns in both portrait and landscape. This must be called before {@link #addColumn} is
     *              called for the width to take effect.
     */
    public void setColumnWidth(int width) {
        mColumnWidth = width;
    }

    /**
     * @param columnSpacing the interval between columns in pixels.
     */
    public void setColumnSpacing(int columnSpacing) {
        mColumnSpacing = columnSpacing;
        updateBoardSpaces();
    }

    /**
     * @param boardEdge the extra space in pixels on the start and on the end of columns.
     */
    public void setBoardEdge(int boardEdge) {
        mBoardEdge = boardEdge;
        updateBoardSpaces();
    }

    /**
     * @param snapToColumn true if scrolling should snap to columns. Only applies to portrait mode.
     */
    public void setSnapToColumnsWhenScrolling(boolean snapToColumn) {
        mSnapToColumnWhenScrolling = snapToColumn;
    }

    /**
     * @param snapToColumn true if dragging should snap to columns when dragging towards the edge. Only applies to portrait mode.
     */
    public void setSnapToColumnWhenDragging(boolean snapToColumn) {
        mSnapToColumnWhenDragging = snapToColumn;
        mAutoScroller.setAutoScrollMode(snapToColumnWhenDragging() ? AutoScroller.AutoScrollMode.COLUMN : AutoScroller.AutoScrollMode
                .POSITION);
    }

    /**
     * @param snapToColumnInLandscape true if dragging should snap to columns when dragging towards the edge also in landscape mode.
     */
    public void setSnapToColumnInLandscape(boolean snapToColumnInLandscape) {
        mSnapToColumnInLandscape = snapToColumnInLandscape;
        mAutoScroller.setAutoScrollMode(snapToColumnWhenDragging() ? AutoScroller.AutoScrollMode.COLUMN : AutoScroller.AutoScrollMode
                .POSITION);
    }

    /**
     * @param snapPosition determines what position a column will snap to. LEFT, CENTER or RIGHT.
     */
    public void setColumnSnapPosition(ColumnSnapPosition snapPosition) {
        mSnapPosition = snapPosition;
    }

    /**
     * @param snapToTouch true if the drag item should snap to touch position when a drag is started.
     */
    public void setSnapDragItemToTouch(boolean snapToTouch) {
        mDragItem.setSnapToTouch(snapToTouch);
    }

    public void setBoardListener(BoardListener listener) {
        mBoardListener = listener;
    }

    public void setBoardCallback(BoardCallback callback) {
        mBoardCallback = callback;
    }

    /**
     * Set a custom drag item to control the visuals and animations when dragging a list item.
     */
    public void setCustomDragItem(DragItem dragItem) {
        DragItem newDragItem = dragItem != null ? dragItem : new DragItem(getContext());
        if (dragItem == null) {
            newDragItem.setSnapToTouch(true);
        }
        mDragItem = newDragItem;
        mRootLayout.removeViewAt(1);
        mRootLayout.addView(mDragItem.getDragItemView());
    }

    /**
     * Set a custom drag item to control the visuals and animations when dragging a column.
     */
    public void setCustomColumnDragItem(DragItem dragItem) {
        DragItem newDragItem = dragItem != null ? dragItem : new DragItem(getContext());
        if (dragItem == null) {
            newDragItem.setSnapToTouch(false);
        }
        mDragColumn = newDragItem;
    }

    private void startDragColumn(DragItemRecyclerView recyclerView, float posX, float posY) {
        mDragColumnStartScrollX = getScrollX();
        mCurrentRecyclerView = recyclerView;

        View columnView = mColumnLayout.getChildAt(getColumnOfList(recyclerView));
        mDragColumn.startDrag(columnView, posX, posY);
        mRootLayout.addView(mDragColumn.getDragItemView());
        columnView.setAlpha(0);

        if (mBoardListener != null) {
            mDragColumnStartPosition = getColumnOfList(mCurrentRecyclerView);
            mBoardListener.onColumnDragStarted(mDragColumnStartPosition);
        }
    }

    private void endDragColumn() {
        mDragColumn.endDrag(mDragColumn.getRealDragView(), new AnimatorListenerAdapter() {
            @Override
            public void onAnimationEnd(Animator animation) {
                mDragColumn.getRealDragView().setAlpha(1);
                mDragColumn.hide();
                mRootLayout.removeView(mDragColumn.getDragItemView());

                if (mBoardListener != null) {
                    mBoardListener.onColumnDragEnded(mDragColumnStartPosition,
                            getColumnOfList(mCurrentRecyclerView));
                }
            }
        });
    }

    private void moveColumn(final int fromIndex, final int toIndex) {
        DragItemRecyclerView list = mLists.remove(fromIndex);
        mLists.add(toIndex, list);

        View header = mHeaders.remove(fromIndex);
        mHeaders.add(toIndex, header);
        View footer = mFooters.remove(fromIndex);
        mFooters.add(toIndex, footer);

        final View column1 = mColumnLayout.getChildAt(fromIndex);
        final View column2 = mColumnLayout.getChildAt(toIndex);
        mColumnLayout.removeViewAt(fromIndex);
        mColumnLayout.addView(column1, toIndex);

        updateBoardSpaces();

        mColumnLayout.addOnLayoutChangeListener(new OnLayoutChangeListener() {
            @Override
            public void onLayoutChange(View v, int left, int top, int right, int bottom, int oldLeft, int oldTop, int oldRight, int oldBottom) {
                mColumnLayout.removeOnLayoutChangeListener(this);
                column2.setTranslationX(column2.getTranslationX() + column1.getLeft() - column2.getLeft());
                column2.animate().translationX(0).setDuration(350).start();
            }
        });

        if (mBoardListener != null) {
            mBoardListener.onColumnDragChangedPosition(fromIndex, toIndex);
        }
    }

    /**
     * Inserts a column to the board at a specific index.
     *
     * @param adapter          Adapter with the items for the column.
     * @param index            Index where on the board to add the column.
     * @param header           Header view that will be positioned above the column. Can be null.
     * @param columnDragView   View that will act as handle to drag and drop columns. Can be null.
     * @param hasFixedItemSize If the items will have a fixed or dynamic size.
     *
     * @return The created DragItemRecyclerView.
     *
     * @deprecated use {@link #insertColumn(int, ColumnProperties)}
     */
    public DragItemRecyclerView insertColumn(final DragItemAdapter adapter, int index, final @Nullable View header, @Nullable View columnDragView, boolean hasFixedItemSize) {
        return insertColumn(adapter, index, header, columnDragView, hasFixedItemSize, new LinearLayoutManager(getContext()));
    }

    /**
     *
     * @deprecated use {@link #insertColumn(int, ColumnProperties)}
     */
    public DragItemRecyclerView insertColumn(final DragItemAdapter adapter, int index, final @Nullable View header, @Nullable View columnDragView, boolean hasFixedItemSize, @NonNull RecyclerView.LayoutManager layoutManager) {
        ColumnProperties columnProperties = ColumnProperties.Builder.newBuilder(adapter)
                .setHeader(header)
                .setColumnDragView(columnDragView)
                .setHasFixedItemSize(hasFixedItemSize)
                .setLayoutManager(layoutManager)
                .build();
        return addColumnTo(index, columnProperties);
    }

    /**
     * Inserts a column to the board at a specific index.
     *
     * @param index            Index where on the board to add the column.
     * @param columnProperties Properties of the column to be added.
     */
    public void insertColumn(int index, @NonNull ColumnProperties columnProperties) {
        addColumnTo(index, columnProperties);
    }

    /**
     * Adds a column at the last index of the board.
     *
     * @param adapter          Adapter with the items for the column.
     * @param header           Header view that will be positioned above the column. Can be null.
     * @param columnDragView   View that will act as handle to drag and drop columns. Can be null.
     * @param hasFixedItemSize If the items will have a fixed or dynamic size.
     *
     * @return The created DragItemRecyclerView.
     *
     * @deprecated use {@link #addColumn(ColumnProperties)}
     */
    public DragItemRecyclerView addColumn(final DragItemAdapter adapter, final @Nullable View header, @Nullable View columnDragView, boolean hasFixedItemSize) {
        return addColumn(adapter, header, columnDragView, hasFixedItemSize, new LinearLayoutManager(getContext()));
    }

    /**
     * @deprecated use {@link #addColumn(ColumnProperties)}
     */
    public DragItemRecyclerView addColumn(final DragItemAdapter adapter, final @Nullable View header, @Nullable View columnDragView, boolean hasFixedItemSize, @NonNull RecyclerView.LayoutManager layoutManager) {
        ColumnProperties columnProperties = ColumnProperties.Builder.newBuilder(adapter)
                .setHeader(header)
                .setColumnDragView(columnDragView)
                .setHasFixedItemSize(hasFixedItemSize)
                .setLayoutManager(layoutManager)
                .build();

        return addColumnTo(getColumnCount(), columnProperties);
    }

    /**
     * Adds a column at the last index of the board.
     *
     * @param columnProperties Properties of the column to be added.
     */
    public void addColumn(@NonNull ColumnProperties columnProperties) {
        addColumnTo(getColumnCount(), columnProperties);
    }

    private DragItemRecyclerView addColumnTo(int index, @NonNull ColumnProperties columnProperties) {
        if (index > getColumnCount()) {
            throw new IllegalArgumentException("Index is out of bounds");
        }

        final DragItemRecyclerView recyclerView = (DragItemRecyclerView) LayoutInflater.from(getContext()).inflate(R.layout.drag_item_recycler_view, this, false);
        recyclerView.setId(getColumnCount());
        recyclerView.setHorizontalScrollBarEnabled(false);
        recyclerView.setVerticalScrollBarEnabled(false);
        recyclerView.setMotionEventSplittingEnabled(false);
        recyclerView.setDragItem(mDragItem);
        recyclerView.setLayoutParams(new LinearLayout.LayoutParams(LayoutParams.MATCH_PARENT, 0, 1));

        RecyclerView.LayoutManager layoutManager = columnProperties.getLayoutManager();
        recyclerView.setLayoutManager(layoutManager != null ? layoutManager : new LinearLayoutManager(getContext()));
        recyclerView.setBackgroundColor(columnProperties.getItemsSectionBackgroundColor());
        recyclerView.setHasFixedSize(columnProperties.hasFixedItemSize());

        List<RecyclerView.ItemDecoration> itemDecorations = columnProperties.getItemDecorations();
        for (int i = 0; i < itemDecorations.size(); i++) {
            recyclerView.addItemDecoration(itemDecorations.get(i));
        }

        recyclerView.setItemAnimator(new DefaultItemAnimator());
        recyclerView.setDragItemListener(new DragItemRecyclerView.DragItemListener() {
            @Override
            public void onDragStarted(int itemPosition, float x, float y) {
                mDragStartColumn = getColumnOfList(recyclerView);
                mDragStartRow = itemPosition;
                mCurrentRecyclerView = recyclerView;
                mDragItem.setOffset(((View) mCurrentRecyclerView.getParent()).getX(), mCurrentRecyclerView.getY());
                if (mBoardListener != null) {
                    mBoardListener.onItemDragStarted(mDragStartColumn, mDragStartRow);
                }
                invalidate();
            }

            @Override
            public void onDragging(int itemPosition, float x, float y) {
                int column = getColumnOfList(recyclerView);
                boolean positionChanged = column != mLastDragColumn || itemPosition != mLastDragRow;
                if (mBoardListener != null && positionChanged) {
                    mLastDragColumn = column;
                    mLastDragRow = itemPosition;
                    mBoardListener.onItemChangedPosition(mDragStartColumn, mDragStartRow, column, itemPosition);
                }
            }

            @Override
            public void onDragEnded(int newItemPosition) {
                mLastDragColumn = NO_POSITION;
                mLastDragRow = NO_POSITION;
                if (mBoardListener != null) {
                    mBoardListener.onItemDragEnded(mDragStartColumn, mDragStartRow, getColumnOfList(recyclerView), newItemPosition);
                }
            }
        });
        recyclerView.setDragItemCallback(new DragItemRecyclerView.DragItemCallback() {
            @Override
            public boolean canDragItemAtPosition(int dragPosition) {
                int column = getColumnOfList(recyclerView);
                return mBoardCallback == null || mBoardCallback.canDragItemAtPosition(column, dragPosition);
            }

            @Override
            public boolean canDropItemAtPosition(int dropPosition) {
                int column = getColumnOfList(recyclerView);
                return mBoardCallback == null || mBoardCallback.canDropItemAtPosition(mDragStartColumn, mDragStartRow, column, dropPosition);
            }
        });

        DragItemAdapter adapter = columnProperties.getDragItemAdapter();
        adapter.setDragStartedListener(new DragItemAdapter.DragStartCallback() {
            @Override
            public boolean startDrag(View itemView, long itemId) {
                return recyclerView.startDrag(itemView, itemId, getRelativeViewTouchX((View) recyclerView.getParent()), getRelativeViewTouchY(recyclerView));
            }

            @Override
            public boolean isDragging() {
                return recyclerView.isDragging();
            }
        });
        recyclerView.setAdapter(adapter);
        recyclerView.setDragEnabled(mDragEnabled);

        Drawable columnBackgroundDrawable = columnProperties.getColumnBackgroundDrawable();
        recyclerView.setBackgroundDrawable(columnBackgroundDrawable);

        Integer specificColumnWidth = columnProperties.getColumnWidth();
        specificColumnWidth = specificColumnWidth != null ? specificColumnWidth : mColumnWidth;

        LinearLayout layout = new LinearLayout(getContext());
        layout.setBackgroundColor(columnProperties.getColumnBackgroundColor());
        layout.setOrientation(LinearLayout.VERTICAL);
        layout.setLayoutParams(new LayoutParams(specificColumnWidth, LayoutParams.MATCH_PARENT));

        View columnHeader = columnProperties.getHeader();
        if (columnHeader == null) {
            columnHeader = new View(getContext());
            columnHeader.setVisibility(View.GONE);
        }
        layout.addView(columnHeader);
        mHeaders.add(columnHeader);

        layout.addView(recyclerView);
        mLists.add(index, recyclerView);

        View columnFooter = columnProperties.getFooter();
        if (columnFooter == null) {
            columnFooter = new View(getContext());
            columnFooter.setVisibility(View.GONE);
        }
        layout.addView(columnFooter);
        mFooters.add(columnFooter);

        mColumnLayout.addView(layout, index);

        updateBoardSpaces();
        setupColumnDragListener(columnProperties.getColumnDragView(), recyclerView);

        return recyclerView;
    }

    private void setupColumnDragListener(View columnDragView, final DragItemRecyclerView recyclerView ) {
        if (columnDragView != null) {
            columnDragView.setOnLongClickListener(new OnLongClickListener() {
                @Override
                public boolean onLongClick(View v) {
                    if (mBoardCallback == null || mBoardCallback.canDragColumnAtPosition(getColumnOfList(recyclerView))) {
                        startDragColumn(recyclerView, mTouchX, mTouchY);
                        return true;
                    } else {
                        return false;
                    }
                }
            });
        }
    }

    private void updateBoardSpaces() {
        int columnCount = getColumnCount();
        int oneSideIntervalSpace = mColumnSpacing / 2;

        for (int childPosition = 0; childPosition < columnCount; childPosition++) {
            View child = mColumnLayout.getChildAt(childPosition);
            MarginLayoutParams layoutParams = (LinearLayout.LayoutParams) child.getLayoutParams();

            if (childPosition == 0) {
                layoutParams.leftMargin = mBoardEdge;
                layoutParams.rightMargin = oneSideIntervalSpace;
            } else if (childPosition == columnCount - 1) {
                layoutParams.leftMargin = oneSideIntervalSpace;
                layoutParams.rightMargin = mBoardEdge;
            } else {
                layoutParams.leftMargin = oneSideIntervalSpace;
                layoutParams.rightMargin = oneSideIntervalSpace;
            }
        }
    }

    private class GestureListener extends GestureDetector.SimpleOnGestureListener {
        private float mStartScrollX;
        private int mStartColumn;

        @Override
        public boolean onDown(MotionEvent e) {
            mStartScrollX = getScrollX();
            mStartColumn = mCurrentColumn;
            return super.onDown(e);
        }

        @Override
        public boolean onFling(MotionEvent e1, MotionEvent e2, float velocityX, float velocityY) {
            // Calc new column to scroll to
            int closestColumn = getClosestSnapColumn();
            int newColumn = closestColumn;

            // This can happen if you start to drag in one direction and then fling in the other direction.
            // We should then switch column in the fling direction.
            boolean wrongSnapDirection = newColumn > mStartColumn && velocityX > 0 || newColumn < mStartColumn && velocityX < 0;

            if (mStartScrollX == getScrollX()) {
                newColumn = mStartColumn;
            } else if (mStartColumn == closestColumn || wrongSnapDirection) {
                if (velocityX < 0) {
                    newColumn = closestColumn + 1;
                } else {
                    newColumn = closestColumn - 1;
                }
            }

            if (newColumn < 0 || newColumn > mLists.size() - 1) {
                newColumn = newColumn < 0 ? 0 : mLists.size() - 1;
            }

            // Calc new scrollX position
            scrollToColumn(newColumn, true);
            return true;
        }
    }

    @SuppressWarnings("WeakerAccess")
    static class SavedState extends BaseSavedState {
        public int currentColumn;

        private SavedState(Parcelable superState, int currentColumn) {
            super(superState);
            this.currentColumn = currentColumn;
        }

        public SavedState(Parcel source) {
            super(source);
            currentColumn = source.readInt();
        }

        @Override
        public int describeContents() {
            return 0;
        }

        @Override
        public void writeToParcel(Parcel dest, int flags) {
            super.writeToParcel(dest, flags);
            dest.writeInt(currentColumn);
        }

        public static final Parcelable.Creator<SavedState> CREATOR = new Parcelable.Creator<SavedState>() {
            public SavedState createFromParcel(Parcel in) {
                return new SavedState(in);
            }

            public SavedState[] newArray(int size) {
                return new SavedState[size];
            }
        };
    }
}