WindowInsetsControllerCompat使用，新方式实现状态栏、导航栏、键盘控制

已于 2024-04-01 15:21:17 修改
阅读量1.9w 收藏 93
点赞数 42
分类专栏： Android Jetpack 文章标签： kotlin android studio android
于 2021-12-09 18:58:35 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/StjunF/article/details/121840122
版权

WindowInsetsControllerCompat使用

文章目录

添加依赖

从core-ktx的1.5.0版本开始就是可以使用这个了。
首先添加依赖

  implementation "androidx.core:core-ktx:1.7.0"

大概有以下类型

WindowInsetsCompat.Type.statusBars()
WindowInsetsCompat.Type.navigationBars()
WindowInsetsCompat.Type.captionBar()
WindowInsetsCompat.Type.ime()
WindowInsetsCompat.Type.systemGestures()
WindowInsetsCompat.Type.mandatorySystemGestures()
WindowInsetsCompat.Type.tappableElement()
WindowInsetsCompat.Type.displayCutout()  
WindowInsetsCompat.Type.systemBars()

这里讲到的是：

WindowInsetsCompat.Type.ime() //键盘
WindowInsetsCompat.Type.statusBars() //状态栏
WindowInsetsCompat.Type.navigationBars() //导航栏
WindowInsetsCompat.Type.systemBars()  //状态栏、导航栏和标题栏

一、状态栏、导航栏相关

1. 沉浸式设置

  WindowCompat.setDecorFitsSystemWindows(window, false)

第二参数decorFitsSystemWindows表示是否沉浸，false 表示沉浸，true表示不沉浸

示例，沉浸入状态栏，状态栏字体黑色、底色透明：

  //关键代码,沉浸
  WindowCompat.setDecorFitsSystemWindows(window, false)
  
  //设置专栏栏和导航栏的底色，透明
  window.statusBarColor = Color.TRANSPARENT
  window.navigationBarColor = Color.TRANSPARENT
  if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.P) {
       window.navigationBarDividerColor = Color.TRANSPARENT
  }
  
  //设置沉浸后专栏栏和导航字体的颜色，
  ViewCompat.getWindowInsetsController(findViewById<FrameLayout>(android.R.id.content))?.let { controller ->
                controller.isAppearanceLightStatusBars = isBlack
                controller.isAppearanceLightNavigationBars = isBlack
  }

update 2022年10月19日：
因为WindowCompat.setDecorFitsSystemWindows(window, false) 这个方法是直接沉浸入导航栏和状态栏，
所以新增一个方法用来设置：

  1. 沉浸入导航栏和状态栏，
  2. 只沉浸入状态栏
  3. 只沉浸入导航栏
/**
 * Immerse 沉浸。设置沉浸的方式
 *
 * @param type Type.systemBars(),Type.statusBars(),Type.navigationBars()
 * @param statusIsBlack 专栏文字 true 黑色,false 白色
 * @param navigationIsBlack 导航栏按钮 true 黑色,false 白色
 * @param color 状态和导航栏的背景颜色
 */
@JvmOverloads
fun Activity.immerse(
    @Type.InsetsType type: Int = Type.systemBars(),
    statusIsBlack: Boolean = true,
    navigationIsBlack: Boolean = true,
    @ColorInt color: Int = Color.TRANSPARENT
) {

    when (type) {
        Type.systemBars() -> { //沉浸入导航栏和状态栏
            WindowCompat.setDecorFitsSystemWindows(window, false)
            updateSystemUIColor(color)
            windowInsetsController.let { controller ->
                controller.isAppearanceLightStatusBars = statusIsBlack
                controller.isAppearanceLightNavigationBars = navigationIsBlack
            }
            findViewById<FrameLayout>(android.R.id.content).apply {
                setPadding(0, 0, 0, 0)
            }
        }
        Type.statusBars() -> {//只沉浸入状态栏
            WindowCompat.setDecorFitsSystemWindows(window, false)
            window.statusBarColor = color
            windowInsetsController.isAppearanceLightStatusBars = statusIsBlack
            findViewById<FrameLayout>(android.R.id.content).apply {
                post {
                    setPadding(0, 0, 0, getNavigationBarsHeight())
                }
            }
        }
        Type.navigationBars() -> {//只沉浸入导航栏
            WindowCompat.setDecorFitsSystemWindows(window, false)
            window.navigationBarColor = color
            windowInsetsController.isAppearanceLightNavigationBars = navigationIsBlack
            findViewById<FrameLayout>(android.R.id.content).apply {
                post {
                    setPadding(0, getStatusBarsHeight(), 0, 0)
                }
            }
        }
        else -> {
            // no work
        }
    }
}

2. 全屏

WindowInsetsCompat.Type.systemBars() 表示状态栏、导航栏和标题栏

 fun Activity.hideSystemUI() {
     WindowCompat.setDecorFitsSystemWindows(window, false)
     ViewCompat.getWindowInsetsController(window.decorView)?.let { controller ->
         controller.hide(WindowInsetsCompat.Type.systemBars())
         controller.systemBarsBehavior =
               WindowInsetsControllerCompat.BEHAVIOR_SHOW_TRANSIENT_BARS_BY_SWIPE
     }
}

3. 退出全屏

 fun Activity.showSystemUI() {
      WindowCompat.setDecorFitsSystemWindows(window, true)			
	  	ViewCompat.getWindowInsetsController(findViewById<FrameLayout>(android.R.id.content))?.show(WindowInsetsCompat.Type.systemBars())
 }

4. 其他

状态栏和标题栏都是可以单独控制的。

1. 显示状态栏,字体黑色
 window.statusBarColor = Color.TRANSPARENT //设置底色
ViewCompat.getWindowInsetsController(findViewById<FrameLayout>(android.R.id.content))?.let { controller ->
         controller.show(WindowInsetsCompat.Type.statusBars())
          controller.isAppearanceLightStatusBars = true//true字体黑色,false白色
}
2. 关闭状态栏
ViewCompat.getWindowInsetsController(activity.findViewById<FrameLayout>(android.R.id.content))?.hide(WindowInsetsCompat.Type.statusBars())
3. 显示导航栏
ViewCompat.getWindowInsetsController(findViewById<FrameLayout>(android.R.id.content))?.let { controller ->
         controller.show(WindowInsetsCompat.Type.navigationBars())
         controller.isAppearanceLightNavigationBars = true//true icon黑色,false白色
   }
4. 隐藏导航栏
fun FragmentActivity.hideNavigationBars() {
    ViewCompat.getWindowInsetsController(findViewById<FrameLayout>(android.R.id.content))?.let { controller ->
        controller.hide(Type.navigationBars())
        controller.systemBarsBehavior =
            WindowInsetsControllerCompat.BEHAVIOR_SHOW_TRANSIENT_BARS_BY_SWIPE
    }
}
5. 判断是否显示导航栏
val FragmentActivity.windowInsetsCompat: WindowInsetsCompat?
    get() = ViewCompat.getRootWindowInsets(findViewById(android.R.id.content))

fun FragmentActivity.hasNavigationBars(): Boolean {
    val windowInsetsCompat = windowInsetsCompat ?: return false
    return windowInsetsCompat.isVisible(Type.navigationBars())
            && windowInsetsCompat.getInsets(Type.navigationBars()).bottom > 0
}
6. 获取导航栏的高度
val FragmentActivity.windowInsetsCompat: WindowInsetsCompat?
    get() = ViewCompat.getRootWindowInsets(findViewById(android.R.id.content))
    
fun FragmentActivity.getNavigationBarsHeight(): Int {
    val windowInsetsCompat = windowInsetsCompat ?: return 0
    return windowInsetsCompat.getInsets(Type.navigationBars()).bottom
}
7. 获取状态栏的高度
val FragmentActivity.windowInsetsCompat: WindowInsetsCompat?
    get() = ViewCompat.getRootWindowInsets(findViewById(android.R.id.content))
    
fun FragmentActivity.getStatusBarsHeight(): Int {
    val windowInsetsCompat = windowInsetsCompat ?: return 0
    return windowInsetsCompat.getInsets(Type.statusBars()).top
}
8. 沉浸相关：ComponentActivity.enableEdgeToEdge()

App沉浸状态栏和导航栏设置官方 ComponentActivity 提供了 enableEdgeToEdge()，可以直接使用，就不需要自己处理下列的版本兼容问题。
可以自行看下源码，后使用

fun ComponentActivity.enableEdgeToEdge(
    statusBarStyle: SystemBarStyle = SystemBarStyle.auto(Color.TRANSPARENT, Color.TRANSPARENT),
    navigationBarStyle: SystemBarStyle = SystemBarStyle.auto(DefaultLightScrim, DefaultDarkScrim)
)

二、键盘操作

1. 显示和隐藏键盘

   @JvmStatic
   fun hideSoftKeyboard(activity: Activity) {
        ViewCompat.getWindowInsetsController(activity.findViewById<FrameLayout>(android.R.id.content))
                ?.hide(WindowInsetsCompat.Type.ime())
    }

    @JvmStatic
    fun showSoftKeyboard(activity: Activity) {
        ViewCompat.getWindowInsetsController(activity.findViewById<FrameLayout>(android.R.id.content))
                ?.show(WindowInsetsCompat.Type.ime())
     }

2. 存在的问题

只在dialog、fragment好像好像调用上面的打开键盘的方法没有效果,也有可能是我用错了。

所以当需要配合EditText打开的时候还是用老的方法

  @JvmStatic
  fun focusEditShowKeyBoard(editText: EditText) {
            editText.isEnabled = true
            editText.isFocusable = true
            editText.isFocusableInTouchMode = true
            editText.requestFocus()
            val inputManager = editText.context.getSystemService(Context.INPUT_METHOD_SERVICE) as InputMethodManager
            editText.setSelection(editText.text.length)
            inputManager.showSoftInput(editText, 0)
  }

3. 监听键盘高度变化

fun addKeyBordHeightChangeCallBack(view: View, onAction:(height:Int) ->Unit){
    var posBottom: Int
    if (VERSION.SDK_INT >= VERSION_CODES.R) {
        val cb = object : WindowInsetsAnimation.Callback(DISPATCH_MODE_STOP) {
            override fun onProgress(
                insets: WindowInsets,
                animations: MutableList<WindowInsetsAnimation>
            ): WindowInsets {
                posBottom = insets.getInsets(WindowInsetsCompat.Type.ime()).bottom +
                        insets.getInsets(WindowInsetsCompat.Type.systemBars()).bottom
                onAction.invoke(posBottom)
                return insets
            }
        }
        view.setWindowInsetsAnimationCallback(cb)
    } else {
        ViewCompat.setOnApplyWindowInsetsListener(view) { _, insets ->
            posBottom = insets.getInsets(WindowInsetsCompat.Type.ime()).bottom +
                    insets.getInsets(WindowInsetsCompat.Type.systemBars()).bottom
            onAction.invoke(posBottom)
            insets
        }
    }
}

使用：

    var posBottom = 0
    var maxBottom = 0
    
    addKeyBordHeightChangeCallBack(mViewBinding.root) {
            posBottom = it
            maxBottom = max(maxBottom,posBottom)
            mViewBinding.guideline2.updateLayoutParams<ConstraintLayout.LayoutParams> {
                guidePercent = 1 - posBottom.toFloat() / screenHeight
            }
            mViewBinding.guideline.updateLayoutParams<ConstraintLayout.LayoutParams> {
                guidePercent =lastPercent - ((lastPercent-0.5f) * (posBottom.toFloat() / maxBottom)
            }
        }

请添加图片描述

更新-2022年4月1日

  1. 为了兼容低版本获取到WindowInsetsControllerCompat
    需要：
    ViewCompat.getWindowInsetsController(window.decorView) 变更成 ViewCompat.getWindowInsetsController(findViewById<FrameLayout>(android.R.id.content))
  2. 新增获取状态栏的高度和导航栏高度，
  3. 判断是否有导航栏

更新-2022年10月19日

  1. 新增一个方法来控制沉浸：
    1. 沉浸入导航栏和状态栏，Type.systemBars()
    2. 只沉浸入状态栏:Type.statusBars()
    3. 只沉浸入导航栏:Type.navigationBars()
fun Activity.immerse(
    @Type.InsetsType type: Int = Type.systemBars(),  //Type.systemBars(),Type.statusBars(),Type.navigationBars()
    statusIsBlack: Boolean = true,
    navigationIsBlack: Boolean = true,
    @ColorInt color: Int = Color.TRANSPARENT
)
  1. 注意事项：获取windowInsets时，在oncreate等一些类似场景中直接调用，需要post 一下，否则会返回null
    eg:
xxView.post{
  ViewCompat.getRootWindowInsets(findViewById(android.R.id.content))
}

或者

   ViewCompat.setOnApplyWindowInsetsListener(findViewById(R.id.main)) { v, insets ->
            val systemBars = insets.getInsets(WindowInsetsCompat.Type.systemBars())
            v.setPadding(systemBars.left, systemBars.top, systemBars.right, systemBars.bottom)
            insets
        }

更新-2024年4月1日

App沉浸状态栏和导航栏设置，好像去年官方就已经给 ComponentActivity 提供了 enableEdgeToEdge()，可以直接使用，就不需要自己处理下列的版本兼容问题。

fun ComponentActivity.enableEdgeToEdge(
    statusBarStyle: SystemBarStyle = SystemBarStyle.auto(Color.TRANSPARENT, Color.TRANSPARENT),
    navigationBarStyle: SystemBarStyle = SystemBarStyle.auto(DefaultLightScrim, DefaultDarkScrim)
)

文章内容不一定的最新~有些API,我也可能没有用到，建议多看看官方文档。

TieJun~
关注
专栏目录
Qt之实现动效导航栏
草上爬的博客
06-26 8872
一.效果 二.实现现在随便点开一个应用，都会有侧边导航栏的身影，比如clash目前，侧边导航栏设计已经成为一种持续更新中的设计趋势。现在很多应用，特别是设置页面都会包含侧边导航栏，网页中更是常见，在网页设计中侧边导航栏设计会使用单一的纯色打底，包含较少的选项，导航栏顶端通常会包括logo，文字链接，以及带有小图标的社交媒体账号链接。 想要侧边导航栏发挥最大的作用，秘诀在于控制好侧边栏本身和右侧内容的对比度，要包含足够清晰可见的导航条目，还要能在移动端上良好地运作。另外，要注意的是，不要因为屏幕侧边够长，就企
【VS Code插件开发】状态栏（五）
编码世界
08-28 1万+
状态栏位于VS Code **工作台底部的水平区域**，显示与工作区相关的信息和操作。主要分为左右两个区域。
Android 12系统源码_SystemUI（九）WindowInsetsController源码解析
AfinalStone的专栏
04-06 3147
通过Android12系统源码，解析WindowInsetsController源码调用流程。
WindowInsetsControllerCompat简单使用
chuyouyinghe的专栏
01-06 856
WindowInsetsControllerCompat，主要可以用来控制界面中导航栏，状态栏，键盘等这些地方的显示，大概有以下的类型。版权声明：本文为CSDN博主「东东旭huster」的原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接及本声明。原文链接：https://blog.csdn.net/qq_41818873/article/details/126036927。
屏幕尺寸的获取与变更（Android 12）
最新发布
chuyouyinghe的专栏
09-26 214
总结而言，getMaximumWindowMetrics()方法用于获取设备屏幕的完整度量信息，而windowManager.getCurrentWindowMetrics()方法用于获取当前窗口的度量信息。Android 11 中引入了 WindowMetrics，可让开发者轻松查询与窗口相关的指标，例如，窗口的位置和大小，以及任何系统边衬区。需要注意的是，这些方法的返回值是WindowMetrics对象，可以通过该对象获取有关窗口的详细度量信息，如窗口大小、位置和可见区域等。
insetter：Insetter是一个库，可帮助应用程序更轻松地处理WindowInsets
02-27
插入者 Insetter是一个库，可帮助应用程序更轻松地处理 。 请访问该以获取更多信息。 会费 请贡献！ 我们将很乐意审查任何拉动要求。 不过，请务必先阅读“页面。 执照 Copyright 2019 Google LLC. 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 https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software
Android经典实战之用WindowInsetsControllerCompat方便的显示和隐藏状态栏和导航栏
AntDream的程序世界
08-13 1322
为开发者提供了一种建议使用的方式来处理和控制 Android 系统的窗口插入。与传统方法相比，它更现代、更灵活，同时也更兼容不同的 Android 版本。因此，在处理状态栏、导航栏的显示和样式时，建议使用。欢迎关注我的公众号AntDream查看更多精彩文章！
WindowInsetsController简单使用
热门推荐
jingzz1的博客
12-21 2万+
WindowInsetsController是android官方在api30之后提供，用于控制window的控制类，实现window控件的简单化 要使用WindowInsetsController,需要先将core版本提高到1.5.0以上: implementation 'androidx.core:core:1.5.0-alpha05' 实例化WindowInsetsController: val controller = ViewCompat.getWindowInsetsControlle
Android 沉浸式状态栏的实现方法、状态栏透明的实现方法
06-07
首先，为了实现沉浸式状态栏，我们需要理解Android系统对状态栏的处理方式。在Android 5.0（API级别21）及以上版本，系统提供了`android:windowTranslucentStatus`属性来实现状态栏的透明效果。在AndroidManifest....
Android 4.4修改状态栏、导航栏颜色、透明度
03-05
通过`SystemBarTint`库，开发者可以轻松地控制Android 4.4及更高版本的状态栏和导航栏的外观，提升应用的整体视觉效果。这个库不仅提供了基本的颜色设置，还支持自定义透明度，从而实现了更丰富的界面设计。同时，...
android 隐藏状态栏 不起作用,android 隐藏状态栏／底部导航栏个人总结
weixin_26833205的博客
05-25 1947
本文根据google文档整理而来，强烈建议阅读google文档.本文如有疏漏，欢迎批评指正。一：Dimming the System Bars:# 要求显示系统uipublic static final int SYSTEM_UI_FLAG_VISIBLE = 0;# 变淡系统uipublic static final int SYSTEM_UI_FLAG_LOW_PROFILE = 0x0000...
WindowInsetsCompat的浅识
SOHU_TECH的博客
07-14 2249
1.什么是window了解WindowInsets之前,我们先复习一下什么是Window?那么由一个问题开始:请问一个android APP 一定要有Activity才能展示界面吗? Five minutes later~~~ 答案是不一定的(可以百度一下”如何创建没有activity的app” 会有很多搜索结果告诉你怎么做……),那么我们就得知了Android 中 Activity 不是显示 U...
Android WindowInsetsController 设置状态栏、导航栏
打渔还是晒网 —— stone
01-18 3521
底部的三个按键就是导航栏 (navigation bar): back / home / recent。高版本系统，recent，可能没有图标了，需要在那个位置"上滑"
Android通过WindowInsetsController设置系统栏颜色、Behavior、显示隐藏等
小马快跑的博客
12-19 3262
隐藏后，从隐藏栏的屏幕边缘滑动，系统栏会再次显示且会在一段时间后再次自动隐藏。隐藏后，从隐藏栏的屏幕边缘滑动，系统栏会再次显示且。隐藏后，从隐藏栏的屏幕边缘滑动，系统栏会。：默认设置，当系统栏通过。设置的有两个值，一个是。方法获取，还可以通过。
WindowInsetsController的简单使用
xlk_1996的博客
12-18 1575
WindowInsetsController简单记录
android inset 管理
april_12345的博客
02-04 3182
android 11上新增一套inset管理方法。Insets 是指系统边衬区的窗口， 包括statusbar, navigation bar, 输入法等， 都在insets管理中。下面说的这些insets即为这些窗口。通过insets相关的接口， app可以控制insets窗口的显示， 隐藏， 沉浸式等。inset 最基本的控制是show 和hide。在inset 不同的状态下， 应用区的位置也会发生变化， 这部分的计算也是inset控制的重要内容之一。
评论 15
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

TieJun~

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值