RecyclerView用ItemDecoration优雅实现StickyHeader

学自定义View之前怎么也搞不懂StickyHeader的绘制,今天总算是搞懂了,通过自己理解的方式把这玩意实现了一下


这篇文章主要是介绍一下StikeyHeader我自己的实现方式,至于RecyclerView自身的padding,item的margin等,有需要的话可以自己加上

先来几张图看看StickyHeader是怎么回事

这是初始化状态

初始状态

Item布局来自huanghaibin-dev/CalendarView


接着往下滑滑滑~
同一个组的标题始终显示在顶部
image



下一个标题把上一个标题顶上去
image

总结一下需要实现的核心内容

  • 同一个组的标题始终显示在顶部
  • 下一个组的标题到达顶部时,把上一个赖着不走的标题给顶走

介绍一下ItemDecoration

emm,很多文章都介绍得不错,那我就:好文,这篇好文最后也有实现StickyHeader,有兴趣额的小伙伴可以对比一下我们的实现方式

Header分析

先从简单的入手:实现Header,也就是没有Sticky效果,Header会始终跟着列表滑动而滑动


首先我们把同一个标题下的Items看作是一个组,那就是要实现组内的第一个Item增加一个Header,此时自然就想到需要重写getItemOffsets方法,给需要的Item增加额外空间,然后重写onDraw方法绘制Header

Header实现

class HeaderDecoration(
    private val callback: Callback
): RecyclerView.ItemDecoration() {

    var mHeight = dp2px(30f)

    private val mPaint = Paint().apply {
        color = 0xFFC5C5C5.toInt()
        style = Paint.Style.FILL
        isAntiAlias = true
    }
    private val mTextPaint = TextPaint().apply {
        color = 0xff353535.toInt()
        textSize = sp2dp(14f)
        isAntiAlias = true
        baselineShift = (textSize / 2 - descent()).toInt()
        textAlign = Paint.Align.CENTER
    }

    // 给组内第一个Item增加额外空间来绘制Header
    override fun getItemOffsets(
        outRect: Rect,
        view: View,
        parent: RecyclerView,
        state: RecyclerView.State
    ) {
        super.getItemOffsets(outRect, view, parent, state)
        val pos = parent.getChildAdapterPosition(view)
        if (isFirstInGroup(pos)) {
            outRect.top = mHeight
        }
    }

    // 绘制Header
    override fun onDraw(c: Canvas, parent: RecyclerView, state: RecyclerView.State) {
        super.onDraw(c, parent, state)

        val left = 0f
        val right = parent.width.toFloat()
        val childCount = parent.childCount
        
        for (i in 0 until childCount) {
            val child = parent.getChildAt(i)
            val pos = parent.getChildAdapterPosition(child)
            if (pos == RecyclerView.NO_POSITION || !isFirstInGroup(pos)) continue

            val top = child.top - mHeight.toFloat()
            val bottom = top + mHeight.toFloat()
            c.drawRect(left, top, right, bottom, mPaint)

            val title = callback.getGroupTitle(pos)
            c.drawText(title, left, top + mHeight / 2 + mTextPaint.baselineShift, mTextPaint)
        }
    }

    // 判断item是否所在组的内第一个item
    private fun isFirstInGroup(pos: Int): Boolean {
        if (pos < 0)
            return false
        val index = callback.getGroupIndex(pos)
        val preIndex = callback.getGroupIndex(pos - 1)
        return index != preIndex
    }

    // 回调获取item所在组的下标和标题
    interface Callback {
        fun getGroupIndex(pos: Int): Int
        fun getGroupTitle(pos: Int): String
    }
}

说明一下

代码说明:

  • 在getItemOffsets中判断当前需要增加空间的Item是否第组内第一个Item,是的话就增加一个mHeight的高度
  • 在onDraw中遍历布局中的itemView,判断这个itemView是不是组内第一个Item,是的话就把Header绘制到这个itemView的正上方,标题则通过回调获得

使用

    rv.addItemDecoration(HeaderDecoration(object : GroupDecoration.Callback {
            override fun getGroupIndex(pos: Int): Int {
                return findParent(pos) // 具体怎么找到GroupIndex自己实现
            }

            override fun getGroupTitle(pos: Int): String {
                return findParentTitle(pos) // 同上,自己实现
            }

        }))

StickyHeader分析

经过观察可以发现,StickyHeader是绘制在itemView之上的,所以需要在onDrawOver中绘制。另外通过观察发现,StickyHeader要么一直处于顶部不动,要么跟着组内最后一个Item滑走,所以只需要判断当前RecyclerView最顶部可见的item是不是在组中的最后一个item,是的话,StickyHeader的bottom就要与这个itemView的bottom重合,视觉上就是跟着这个itemView滑走,否则直接在顶部把StickyHeader绘制出来

StickyHeader实现

// 绘制StickyHeader
override fun onDrawOver(c: Canvas, parent: RecyclerView, state: RecyclerView.State) {
    super.onDrawOver(c, parent, state)
    val manager = parent.layoutManager as LinearLayoutManager
    // 找到RecyclerView第一个可见的itemView在adapter中的位置
    val firstPos = manager.findFirstVisibleItemPosition()
    if (firstPos == RecyclerView.NO_POSITION)
        return

    if (isLastInGroup(firstPos)) {
        // 标题要跟着组内最后一个滑走
        val child = parent.findViewHolderForAdapterPosition(firstPos)?.itemView ?: return
        val bottom = min(child.bottom, mHeight).toFloat()
        val top = bottom - mHeight.toFloat()
        val left = 0f
        val right = parent.width.toFloat()
        c.drawRect(left, top, right, bottom, mPaint)

        val title = callback.getGroupTitle(firstPos)
        c.drawText(title, left, top + mHeight / 2 + mTextPaint.baselineShift, mTextPaint)
    } else {
        // 直接绘制在顶部
        val top = 0f
        val bottom = mHeight.toFloat()
        val left = 0f
        val right = parent.width.toFloat()
        c.drawRect(left, top, right, bottom, mPaint)

        val title = callback.getGroupTitle(firstPos)
        c.drawText(title, left, top + mHeight / 2 + mTextPaint.baselineShift, mTextPaint)
    }
}

// 判断item是否所在组的内最后一个item
private fun isLastInGroup(pos: Int): Boolean {
    if (pos < 0)
        return false
    val index = callback.getGroupIndex(pos)
    val preIndex = callback.getGroupIndex(pos + 1)
    return index != preIndex
}

代码说明:

  • 如果item是组内最后一个item,需要用min函数确定StickyHeader的位置,保证StickyHeader能正确显示并随itemView滑出屏幕

另外可以发现,之前onDraw绘制的Header,在视觉上不会影响StickyHeader的显示,并且还能巧妙地和onDrawOver绘制的StickyHeader结合形成"下面标题把当前标题顶上去"的效果,所以onDraw的代码不用改变

以上就是我实现StickyHeader的实现方法

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,033评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,725评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,473评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,846评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,848评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,691评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,053评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,700评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,856评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,676评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,787评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,430评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,034评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,990评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,218评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,174评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,526评论 2 343

推荐阅读更多精彩内容