ImmersionBar

项目地址:gyf-dev/ImmersionBar
简介:android 4.4 以上沉浸式状态栏和沉浸式导航栏管理,一句代码轻松实现,以及对 bar 的其他设置,详见 README,http://www.jianshu.com/p/2a884e211a62
更多:作者   提 Bug   
标签:

直接看效果图,最下面有各个版本的效果图

使用

android studio

   compile 'com.gyf.barlibrary:barlibrary:2.2.8'

eclipse

barlibrary-2.2.8.jar

版本说明

点我

下载 demo

下载

用法

初始化

  • 基础用法(已经可以满足日常沉浸式)

      ImmersionBar.with(this).init();
    
  • 高级用法(每个参数的意义)

       ImmersionBar.with(this)
                   .transparentStatusBar()  //透明状态栏,不写默认透明色
                   .transparentNavigationBar()  //透明导航栏,不写默认黑色(设置此方法,fullScreen()方法自动为 true)
                   .transparentBar()             //透明状态栏和导航栏,不写默认状态栏为透明色,导航栏为黑色(设置此方法,fullScreen()方法自动为 true)
                   .statusBarColor(R.color.colorPrimary)     //状态栏颜色,不写默认透明色
                   .navigationBarColor(R.color.colorPrimary) //导航栏颜色,不写默认黑色
                   .barColor(R.color.colorPrimary)  //同时自定义状态栏和导航栏颜色,不写默认状态栏为透明色,导航栏为黑色
                   .statusBarAlpha(0.3f)  //状态栏透明度,不写默认 0.0f
                   .navigationBarAlpha(0.4f)  //导航栏透明度,不写默认 0.0F
                   .barAlpha(0.3f)  //状态栏和导航栏透明度,不写默认 0.0f
                   .statusBarDarkFont(true)   //状态栏字体是深色,不写默认为亮色
                   .flymeOSStatusBarFontColor(R.color.btn3)  //修改 flyme OS 状态栏字体颜色
                   .fullScreen(true)      //有导航栏的情况下,activity 全屏显示,也就是 activity 最下面被导航栏覆盖,不写默认非全屏
                   .hideBar(BarHide.FLAG_HIDE_BAR)  //隐藏状态栏或导航栏或两者,不写默认不隐藏
                   .addViewSupportTransformColor(toolbar)  //设置支持 view 变色,可以添加多个 view,不指定颜色,默认和状态栏同色,还有两个重载方法
                   .titleBar(view)    //解决状态栏和布局重叠问题,任选其一
                   .titleBarMarginTop(view)     //解决状态栏和布局重叠问题,任选其一
                   .statusBarView(view)  //解决状态栏和布局重叠问题,任选其一
                   .fitsSystemWindows(true)    //解决状态栏和布局重叠问题,任选其一,默认为 false,当为 true 时一定要指定 statusBarColor(),不然状态栏为透明色
                   .supportActionBar(true) //支持 ActionBar 使用
                   .statusBarColorTransform(R.color.orange)  //状态栏变色后的颜色
                   .navigationBarColorTransform(R.color.orange) //导航栏变色后的颜色
                   .barColorTransform(R.color.orange)  //状态栏和导航栏变色后的颜色
                   .removeSupportView(toolbar)  //移除指定 view 支持
                   .removeSupportAllView() //移除全部 view 支持
                   .navigationBarEnable(true)   //是否可以修改导航栏颜色,默认为 true
                   .navigationBarWithKitkatEnable(true)  //是否可以修改安卓 4.4 和 emui3.1 手机导航栏颜色,默认为 true
                   .fixMarginAtBottom(true)   //已过时,当 xml 里使用 android:fitsSystemWindows="true"属性时,解决 4.4 和 emui3.1 手机底部有时会出现多余空白的问题,默认为 false,非必须
                   .addTag("tag")  //给以上设置的参数打标记
                   .getTag("tag")  //根据 tag 获得沉浸式参数
                   .reset()  //重置所以沉浸式参数
                   .keyboardEnable(true)  //解决软键盘与底部输入框冲突问题,默认为 false,还有一个重载方法,可以指定软键盘 mode
                   .init();  //必须调用方可沉浸式
    

关闭销毁

  • 在 activity 的 onDestroy 方法中执行

      ImmersionBar.with(this).destroy(); //不调用该方法,如果界面 bar 发生改变,在不关闭 app 的情况下,退出此界面再进入将记忆最后一次 bar 改变的状态
    

建议

  • 建议在 BaseActivity 中初始化和销毁,可以参看 demo 中BaseActivity

      public class BaseActivity extends AppCompatActivity {
    
           private ImmersionBar mImmersionBar;
           @Override
           protected void onCreate(@Nullable Bundle savedInstanceState) {
               super.onCreate(savedInstanceState);
             mImmersionBar = ImmersionBar.with(this);
             mImmersionBar.init();   //所有子类都将继承这些相同的属性
    
           }
    
           @Override
           protected void onDestroy() {
               super.onDestroy();
               if (mImmersionBar != null)
                  mImmersionBar.destroy();  //不调用该方法,如果界面 bar 发生改变,在不关闭 app 的情况下,退出此界面再进入将记忆最后一次 bar 改变的状态
           }
       }
    

在 Fragment 中实现沉浸式

注意:2.2.6 版本已将ImmersionFragment这个类标记为过时,请用户自行使用懒加载方式实现

  • 在 Fragment 使用 ImmersionBar

    第一种,当结合 viewpager 使用的时候,请使用懒加载的形式,参考 demo 中的BaseLazyFragment这个类

    第二种,当使用 show()和 hide()来控制 Fragment 显示隐藏的时候,参考 demo 中的BaseTwoFragment这个类

    注意:

    • 2.2.7 版本以后别忘了在 Fragment 的 onDestroy 方法里销毁沉浸式了,2.2.7 版本之前不需要调用
       @Override
       protected void onDestroy() {
           super.onDestroy();
           if (mImmersionBar != null)
              mImmersionBar.destroy();  
       }
    
    • 以 show()和 hide()方式控制 Fragment 显示隐藏,别忘了重写 onHiddenChanged 方法,如下
         @Override
         public void onHiddenChanged(boolean hidden) {
             super.onHiddenChanged(hidden);
             if (!hidden && mImmersionBar != null)
                mImmersionBar.init();
         }
    
  • 在 Activity 使用 ImmersionBar

    第一种,当结合 viewpager 使用的时候,请使用 viewpager 的 addOnPageChangeListener 的方法监听沉浸式,参考 demo 中FragmentThreeActivity这个类

    第二种,当使用 show()和 hide()来控制 Fragment 显示隐藏的时候,请在 tab 切换的时候使用 ImmersionBar,参考 demo 中FragmentFourActivity这个类

  • 使用 Fragment 第三方框架Fragmentation实现沉浸式

    参考 demo 中FragmentFiveActivityBaseFiveFragment这个类

    在 Dialog 中实现沉浸式,具体实现参考 demo

           ImmersionBar.with(this, dialog, "flag")   //第三个参数是为当前 Dialog 加上标记,多个 Dialog 之间不可相同
                       .init();
    

    注意:在 dialog 使用,当销毁 dialog 同时,别忘了调用 ImmersionBar 的 destroy 方法了

状态栏与布局顶部重叠解决方案,六种方案任选其一

  • ① 使用 dimen 自定义状态栏高度,不建议使用,因为设备状态栏高度并不是固定的

    在 values-v19/dimens.xml 文件下

          <dimen name="status_bar_height">25dp</dimen>
    

    在 values/dimens.xml 文件下

          <dimen name="status_bar_height">0dp</dimen>
    

    然后在布局界面添加 view 标签,高度指定为 status_bar_height

         <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
             xmlns:app="http://schemas.android.com/apk/res-auto"
             android:layout_width="match_parent"
             android:layout_height="match_parent"
             android:background="@color/darker_gray"
             android:orientation="vertical">
    
             <View
                 android:layout_width="match_parent"
                 android:layout_height="@dimen/status_bar_height"
                 android:background="@color/colorPrimary" />
    
             <android.support.v7.widget.Toolbar
                 android:layout_width="match_parent"
                 android:layout_height="wrap_content"
                 android:background="@color/colorPrimary"
                 app:title="方法一"
                 app:titleTextColor="@android:color/white" />
         </LinearLayout>
    
  • ② 使用系统的 fitsSystemWindows 属性,使用该属性不会导致输入框与软键盘冲突问题,不要再 Fragment 使用该属性

         <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
             android:layout_width="match_parent"
             android:layout_height="match_parent"
             android:orientation="vertical"
             android:fitsSystemWindows="true">
         </LinearLayout>
    

    然后使用 ImmersionBar 时候必须指定状态栏颜色

         ImmersionBar.with(this)
              .statusBarColor(R.color.colorPrimary)
              .init();
    
  • ③ 使用 ImmersionBar 的 fitsSystemWindows(boolean fits)方法

          ImmersionBar.with(this)
              .fitsSystemWindows(true)  //使用该属性,必须指定状态栏颜色
              .statusBarColor(R.color.colorPrimary)
              .init();
    
  • ④ 使用 ImmersionBar 的 statusBarView(View view)方法

    在标题栏的上方增加 View 标签,高度指定为 0dp

          <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
                 xmlns:app="http://schemas.android.com/apk/res-auto"
                 android:layout_width="match_parent"
                 android:layout_height="match_parent"
                 android:background="@color/darker_gray"
                 android:orientation="vertical">
    
                 <View
                     android:layout_width="match_parent"
                     android:layout_height="0dp"
                     android:background="@color/colorPrimary" />
    
                 <android.support.v7.widget.Toolbar
                     android:layout_width="match_parent"
                     android:layout_height="wrap_content"
                     android:background="@color/colorPrimary"
                     app:title="方法四"
                     app:titleTextColor="@android:color/white" />
          </LinearLayout>
    

    然后使用 ImmersionBar 的 statusBarView 方法,指定 view 就可以啦

           ImmersionBar.with(this)
                 .statusBarView(view)
                 .init();
           //或者
           //ImmersionBar.setStatusBarView(this,view);
    
  • ⑤ 使用 ImmersionBar 的 titleBar(View view)方法,原理是设置 paddingTop
               ImmersionBar.with(this)
                     .titleBar(view) //可以为任意 view,如果是自定义 xml 实现标题栏的话,最外层节点不能为 RelativeLayout
                     .init();
               //或者
               //ImmersionBar.setTitleBar(this, view);
    
  • ⑥ 使用 ImmersionBar 的 titleBarMarginTop(View view)方法,原理是设置 marginTop
               ImmersionBar.with(this)
                     .titleBarMarginTop(view)  //可以为任意 view
                     .statusBarColor(R.color.colorPrimary)  //指定状态栏颜色,根据情况是否设置
                     .init();
               //或者使用静态方法设置
               //ImmersionBar.setTitleBarMarginTop(this,view);
    

解决 EditText 和软键盘的问题

  • 第一种方案
        ImmersionBar.with(this)
                    .keyboardEnable(true)  //解决软键盘与底部输入框冲突问题
                //  .keyboardEnable(true, WindowManager.LayoutParams.SOFT_INPUT_STATE_ALWAYS_VISIBLE
                //                        | WindowManager.LayoutParams.SOFT_INPUT_ADJUST_RESIZE)  //软键盘自动弹出
                    .init();
        或者
        // KeyboardPatch.patch(this).enable();
        或者,layout 指的是当前布局的根节点
        // KeyboardPatch.patch(this, layout).enable();
    
  • 第二种方案 不使用 keyboardEnable 方法,只需要在布局的根节点(最外层节点)加上 android:fitsSystemWindows="true"属性即可,只适合纯色状态栏

当白色背景状态栏遇到不能改变状态栏字体为深色的设备时,解决方案

         ImmersionBar.with(this)
                     .statusBarDarkFont(true, 0.2f) //原理:如果当前设备支持状态栏字体变色,会设置状态栏字体为黑色,如果当前设备不支持状态栏字体变色,会使当前状态栏加上透明度,否则不执行透明度
                     .init();

解决华为 emui3.0 或者 3.1 手机手动隐藏导航栏按钮时,导航栏背景未被隐藏的问题

什么叫做手动隐藏,就是下图中标红的向下隐藏按钮

  • 第一种解决方案,监听华为虚拟按钮,建议在 baseActivity 里使用

    
    @Override
        protected void onCreate(@Nullable Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);
            immersionBar = ImmersionBar.with(this);
            immersionBar.init();
            if (OSUtils.isEMUI3_1())  //解决华为 emui3.0 与 3.1 手机手动隐藏底部导航栏时,导航栏背景色未被隐藏的问题
                getContentResolver().registerContentObserver(Settings.System.getUriFor
                        ("navigationbar_is_min"), true, mNavigationStatusObserver);
        }
    
        private ContentObserver mNavigationStatusObserver = new ContentObserver(new Handler()) {
            @Override
            public void onChange(boolean selfChange) {
                int navigationBarIsMin = Settings.System.getInt(getContentResolver(),
                        "navigationbar_is_min", 0);
                if (navigationBarIsMin == 1) {
                    //导航键隐藏了
                    immersionBar
                            .transparentNavigationBar()
                            .init();
                } else {
                    //导航键显示了
                    immersionBar
                            .navigationBarColor(android.R.color.black)
                            .fullScreen(false)
                            .init();
                }
            }
        };
    
  • 第二种解决方案,禁止对导航栏相关设置
           ImmersionBar.with(this)
                       .navigationBarEnable(false)   //禁止对导航栏相关设置
                     //或者
                     // .navigationBarWithKitkatEnable(false)  //禁止对 4.4 设备或者 emui3.1 手机导航栏相关设置
                       .init();
    

状态栏和导航栏其它方法

  • public static boolean hasNavigationBar(Activity activity)

    判断是否存在导航栏

  • public static int getNavigationBarHeight(Activity activity)

    获得导航栏的高度

  • public static int getNavigationBarWidth(Activity activity)

    获得导航栏的宽度

  • public static boolean isNavigationAtBottom(Activity activity)

    判断导航栏是否在底部

  • public static int getStatusBarHeight(Activity activity)

    获得状态栏的高度

  • public static int getActionBarHeight(Activity activity)

    获得 ActionBar 的高度

  • public static boolean isSupportStatusBarDarkFont()

    判断当前设备支不支持状态栏字体设置为黑色

  • public static void hideStatusBar(Window window)

    隐藏状态栏

混淆规则(proguard-rules.pro)

    -keep class com.gyf.barlibrary.* {*;}

效果图

说明

  • 这是状态栏 image
  • 这是导航栏(有些手机没有导航栏) image

    动态图

  • android 6.0 有导航栏效果

  • android 4.4 有导航栏效果

  • android 4.4 没有导航栏效果

特别鸣谢

联系我

  • QQ 群 314360549(问题交流)
  • WeChat(微信)
Android 开发经验分享
用了一年多的理财推荐
Android 开发经验分享
用了一年多的理财推荐