안드로이드 SwipeHelperCallback(with Kotlin)

Purang·2022년 10월 17일
0

Android Studio

목록 보기
18/28

현재 하고 있는 프로젝트에 리사이클러 뷰에 swipe와 drag기능을 넣고 싶어서 찾아본 내용을 공부하여 적용하도록 하였습니다.

공부한 블로그는 여기입니다. 여기서 배운 내용을 토대로 이해한 것을 주석으로 정리하고 아직은 배우는 단계인지라 코드를 거의 비슷하게 사용하였습니다.


먼저 새롭게 kotlin class를 만들어 adapter에 연결하는 방식을 사용하였습니다.

swipehelpercallback은 ItemTouchHelper를 통해 사용되는데 자세한 내용은 공식 홈페이지에서 볼 수 있습니다.

class SwipeHelperCallback(private val mAdapter : TodoAdapter) : ItemTouchHelper.Callback() {

    // swipebasiclayout(linearlayout)을 swipe 했을 때 삭제이미지 화면이 보이도록 고정하기 위한 변수들
    private var currentPosition: Int? = null    // 현재 선택된 recycler view의 position
    private var previousPosition: Int? = null   // 이전에 선택했던 recycler view의 position
    private var currentDx = 0f                  // 현재 x 값
    private var fixSize = 0f                      // 고정시킬 크기

    //이동 방향 결정
   override fun getMovementFlags(
        recyclerView: RecyclerView,
        viewHolder: RecyclerView.ViewHolder
    ): Int {
        //드래그 위아래, 스와이프 왼쪽만
        return makeMovementFlags(UP or DOWN, LEFT or RIGHT)
    }

    //드래그 동작(위 아래 위치 이동)
    override fun onMove(
        recyclerView: RecyclerView,
        viewHolder: RecyclerView.ViewHolder,
        target: RecyclerView.ViewHolder
    ): Boolean {
        //위 아래 위치 스왑(현재 선택 데이터와 드래그 위치에있는 데이터교환)
        //전 위치와 후 위치로 변환
        val beforePos = viewHolder.adapterPosition
        val afterPos = target.adapterPosition
        mAdapter.swapData(beforePos, afterPos)
        return true
    }

    //스와이프 동작(왼 오 이동)
    override fun onSwiped(viewHolder: RecyclerView.ViewHolder, direction: Int) {
        //아래와 같은 코드 시 그냥 스와이프 하면 삭제됨(고정 시킬 거니까 패스)
        //mAdapter.removeData(viewHolder.layoutPosition)
    }




    //getDefaultUIUtil : 사용자 상호 작용에 대한 응답으로 view의 시각적 변경을 위해 콜백 클래스에서 ItemTouchUIUtil사용하는 것을 반환합니다.

    //clearView : onSelectedChanged 등 여러 멤버에서 수행된 View의 모든 변경사항을 적용하기의 좋은 위치를 설정하는 함수로
    //요소와 사용자의 상호작용이 끝나고 애니메이션도 종료되면 ItemTouchHelper에 의해 호출됩니다.
    override fun clearView(recyclerView: RecyclerView, viewHolder: ViewHolder) {
        currentDx = 0f //초기화
        previousPosition = viewHolder.adapterPosition //드래그 or 스와이프가 끝난 view item의 위치를 가짐(기억)
        //clearview를 적용할 view를 호출
        getDefaultUIUtil().clearView((viewHolder as TodoAdapter.TodoViewHolder).itemView.findViewById(R.id.swipe_basic_layout))
    }


    //여기는 drag와 swipe 전부
    //ItemTouchHelper의 viewholder를 스와이프, 드래그 시 호출
    override fun onSelectedChanged(viewHolder: ViewHolder?, actionState: Int) {
        viewHolder?.let {
            currentPosition = viewHolder.adapterPosition //현재 스와이프, 드래그의 위치를 저장
            getDefaultUIUtil().onSelected((viewHolder as TodoAdapter.TodoViewHolder).itemView.findViewById(R.id.swipe_basic_layout))
        }
    }

    //아이템 터치 또는 스와이프 등 뷰의 변화를 감지 후 호출
   override fun onChildDraw(
        c: Canvas,
        recyclerView: RecyclerView,
        viewHolder: ViewHolder,
        dX: Float,
        dY: Float,
        actionState: Int, //행동상태 를 파악하기위한 변수
        isCurrentlyActive: Boolean
    ) {
        if (actionState == ItemTouchHelper.ACTION_STATE_SWIPE) {
            val view = getView(viewHolder)
            val isFixed = getTag(viewHolder) //고정할지 말지 결정하기 위한 변수 true-고정, false-고정x
            val newX = fixViewPositionHorizontal(dX, isFixed, isCurrentlyActive) //// newX 만큼 이동(고정 시 이동 위치/고정 해제 시 이동 위치 결정)

            //고정 애니메이션
            if (newX == -fixSize) {
                getView(viewHolder).animate().translationX(-fixSize).setDuration(100L)
                return
            }

            currentDx = newX
            getDefaultUIUtil().onDraw(
                c,
                recyclerView,
                view,
                newX,
                dY,
                actionState,
                isCurrentlyActive
            )
        }
    }


    //사용자가 스와이프 동작으로 간주할 최소 속도를 정의
    override fun getSwipeEscapeVelocity(defaultValue: Float): Float {
        return defaultValue * 10
    }

    //사용자가 스와이프 동작으로 간주하기 위해 이동해야하는 거리반환
    override fun getSwipeThreshold(viewHolder: ViewHolder): Float {
        //-clamp 이상 스와이프 동작 시 isClamped를 true 아니면 false
        setTag(viewHolder, currentDx <= -fixSize)
        return 2f
    }

    //스와이프 시 삭제imageview가 보이도록 고정
    private fun fixViewPositionHorizontal(
        dX: Float,
        isFixed: Boolean,
        isCurrentlyActive: Boolean
    ) : Float {
        //오른쪽으로 swipe 막기 위한 변수
        val max = 0f

        //고정이 가능하면
        val newX = if (isFixed) {
            //현재 스와이프 중이면 영역 제한
            if (isCurrentlyActive) {
                //오른쪽 스와이프일때
                if (dX < 0) {
                    dX/3 - fixSize
                } else {
                    //왼쪽
                    dX - fixSize
                }

            } else { //스와이프 중이 아니면 그냥 고정
                -fixSize
            }
        } else {
            //고정할 수 없으면 newX는 스와이프로 움직인 만큼
            dX/2
        }
        //newX가 0보다 작은지 확인
        return min(newX,max)
    }

    //View에게 Tag를 달아 식별할 수 있게 만들어 주는 방법 입니다. 바코드와 같은 형식
    private fun setTag(viewHolder: RecyclerView.ViewHolder, isFixed: Boolean) {
        //viewholder의 adapter내부 클래스 view의 tag를 달아 식별할 수 있도록합니다.
        viewHolder.itemView.tag = isFixed
    }

    //위에서 tag로 식별하기 위해 setTag는 object로 매개변수를 받기 때문에 get으로 받을 때 형변환 하여 사용해줍니다.
    private fun getTag(viewHolder: RecyclerView.ViewHolder) : Boolean =  viewHolder.itemView.tag as? Boolean ?: false

    private fun getView(viewHolder: RecyclerView.ViewHolder) : View = viewHolder.itemView.findViewById(R.id.swipe_basic_layout)

    //view가 스와이프되었을 때 고정될 크기 설정
    fun setFix(fixSize : Float) {this.fixSize = fixSize}

    //다른 view를 스와이프할 때 그 전꺼는 닫혀있어야하니 터치나, 스와이프 중이였을 시 고정해제
    fun removePreviousFix(recyclerView: RecyclerView) {

        if (currentPosition == previousPosition) {
            return
        }

        previousPosition?.let {
            val viewHolder = recyclerView.findViewHolderForAdapterPosition(it) ?: return

            getView(viewHolder).animate().x(0f).setDuration(100L).start()

            //해제
            setTag(viewHolder,false)

            previousPosition = null
        }
    }
}

위 블로그에서 배운 코드로 주석을 통해 쉽게 알 수 있습니다.

//리사이클러뷰에 스와이프 드래그달기
        val swipeHelperCallback = SwipeHelperCallback(todoAdapter!!).apply {
            //스와이프 후 고정위치 지정
            setFix(resources.displayMetrics.widthPixels.toFloat() / 4)
        }
        ItemTouchHelper(swipeHelperCallback).attachToRecyclerView(homeBinding.recyclerView)

        //다른 곳 터치 시 선택 뷰 닫기
        homeBinding.recyclerView.setOnTouchListener { _,_ ->
            swipeHelperCallback.removePreviousFix(homeBinding.recyclerView)
            false
        }

위와 같이 적용하여 adapter와 연결하여 리사이클러뷰에서 잘 사용되는 것을 확인할 수 있었습니다.

이번에 고정하는 방식과 다양한 메소드의 사용법을 공부해 보았습니다. 다음번에는 위의 것을 토대로 다양한 기능을 추가하여 까먹지 않고 열심히 공부하겠습니다.

profile
몰입의 즐거움

0개의 댓글