您的位置:首页 > 移动开发 > Android开发

从源码剖析PopupWindow 兼容Android 6.0以上版本点击外部不消失

2017-06-30 12:01 501 查看

前言

PopupWindow可以说是Google坑最多的一个控件,使用PopupWindow的时候没有遇到几个坑你都不好意思说你用过它,说一个可能大多数人都遇到过的一个坑:那就是我们想触摸PopupWindow 以外区域就隐藏PopupWindow,理论上我们只需要调用 setOutsideTouchable(ture)设置为ture就可以了,但是实际上只设置这个属性是不行的,必须设置背景,也就是说要和setBackgroundDrawable(Drawable background)同时使用才有效,不然,点击PopupWindow以外区域是不能隐藏掉的。

当时遇到这个坑的时候也是一脸懵逼,设不设背景跟我点击外面消失有啥关系?看了源码才知道,它是根据
mBackground
这个值来判断的,如果没设置这个值,那么就不会走到dispatchEvent 方法,就处理不了dismiss事件。在Android 6.0 以上,Google源码进行了更改,去掉了
mBackground
是否为null 的这个判断条件,并且在构造方法中初始化了
mBackground
这个值,因此在Android 6.0以上,不用调

setBackgroundDrawable(Drawable background)


这个方法,就可以dismiss 了。那么本篇文章将从源码的角度,分析Android 6.0以上和Android 6.0 以下,如何控制点击外部PopupWindow消失/不消失。

1 . 为何Android 6.0 以下要设置BackgroundDrawable 才能dismiss

这个问题在上面已经描述,在Android 6.0 以前,我们显示出来的PopupWindow,在只设置
setOutsideTouchable(ture)
的情况下,触摸PopupWindow以外区域是不能dismiss掉的(6.0以后已经可以了)。必须同时设置BackgroundDrawable,才能dismiss掉,以前可能我们找到了解决办法,我们就没有管造成它的原因,那么今天就一起看一下源码为什么会这样。从显示PopupWindow的方法为入口,源码分析如下(源码为API 21 版本):

在showAsDropDown()方法 中调用了一个
preparePopup(p)
方法,我们看一下这个方法中做了什么,如下:




注意这个方法中,有一个判断条件是
mBackground != null
,在里面包装了一个
PopupViewContainer
,我在再去看一下这个
PopupViewContainer
又干了什么,如下:(部分源码)



PopupViewContainer
其实就处理了PopupWindow的事件分发,在
onTouch
方法里面,如果点击PopupWindow之外的区域,先dismiss,然后消费掉了事件。

重点就在这儿了,前面在
preparePopup
方法中,判断了,只有当mBackground不为null,才包装了PopupViewContainer,处理了事件,在点击 popupWindow外部的时候,会dismiss。而
mBackground
这个值只有在setBackgroundDrawable()这一个地方初始化的,因此必须调用setBackgroundDrawable方法设置了
mBackground
不为null,才能点击PopupWindow外部关闭PopupWindow。这就解释了为何Android 6.0 以下要设置BackgroundDrawable 才能dismiss


2 . 点击PopupWindow以外区域不让其消失

在我们使用PopupWindow的时候,我们可能有这样一种需求:点击PopupWindow以外的区域,不让其消失(只能通过返回键和PopupWindow中的其他事件来DisMiss),但也不能响应页面的其他事件,也就是模态,像AlertDialog一样,只有当PopupWindow消失之后才能响应其他事件。

开始做这个需求的时候想得很简单:

想到了2种方法:

1,设置
setOutsideTouchable(false)
,测试过后,这种方法无效。

2,既然上面说了mBackground 这个属性为null的时候,点击popupWindow以外区域是取消不了的,那么直接调用
setBackgroundDrawable(null)
不就行了?这种方式在Android 6.0以下是取消不了,但是,页面的其他事件可以响应,也就是说没有关闭弹出的 PopupWindow的情况下,还可以响应页面其他事件。这当然不是我们想要的效果。如下图:



上面是我开始想到2种方式,测试过后都不行,那么我们就得找其他方法。

2.1 Android6.0以下 点击PopupWindow以外区域不让其消失

试了一下上面两种方式都不行之后,于是就找其他方法,第一时间进行了Google,嘿,还真找到了一种方法,代码如下:

LayoutInflater inflater = (LayoutInflater)getSystemService(Context.LAYOUT_INFLATER_SERVICE);
View contentview = inflater.inflate(R.layout.pop_layout1, null);
final PopupWindow popupWindow = new PopupWindow(contentview, ViewGroup.LayoutParams.WRAP_CONTENT, ViewGroup.LayoutParams.WRAP_CONTENT);
//popupWindow
popupWindow.setFocusable(true);
popupWindow.setOutsideTouchable(false);
popupWindow.setBackgroundDrawable(null);

popupWindow.getContentView().setFocusable(true); // 这个很重要
popupWindow.getContentView().setFocusableInTouchMode(true);
popupWindow.getContentView().setOnKeyListener(new View.OnKeyListener() {
@Override
public boolean onKey(View v, int keyCode, KeyEvent event) {
if (keyCode == KeyEvent.KEYCODE_BACK) {
popupWindow.dismiss();

return true;
}
return false;
}
});
popupWindow.showAsDropDown(mButton1, 0, 10);


这种方法就是在我前面说的方法2的基础上,获取PopupWindow中的contentView,并且获取焦点,并处理返回键事件,在按返回键的时候可以取消PopupWindow。

添加上面的代码,运行,嘿,还挺好使,可以了,心里一阵高兴。接着在Android 7.0的手机运行一把,什么鬼?7.0上还是不起作用,点击PopupWindow之外的地方还是会取消。试了好多方法,都不行。

上面的方法既然在Android 6.0以下可以,在Andoid 7.0手机上无效,那么就只有看源码了在Android 6.0以上做了什么更改了,分析一下看源码是怎么处理,为什么在5.1的手机上运行正常,而在 7.0的手机上运行无效呢?

2.2 Android6.0以上 点击PopupWindow以外区域不让其消失

找不到解决办法,就去分析一下源码了,以API 25的源码为例分析:

1,首先看
showAtLocation
这个方法:

public void showAtLocation(IBinder token, int gravity, int x, int y) {
if (isShowing() || mContentView == null) {
return;
}

TransitionManager.endTransitions(mDecorView);

detachFromAnchor();

mIsShowing = true;
mIsDropdown = false;
mGravity = gravity;

final WindowManager.LayoutParams p = createPopupLayoutParams(token);
// 重点在preparePopup 里
preparePopup(p);

p.x = x;
p.y = y;

invokePopup(p);
}


如上,在
showAtLocation
方法中有一个重要的方法
preparePopup


2,进入
preparePopup
一探究竟:

private void preparePopup(WindowManager.LayoutParams p) {
if (mContentView == null || mContext == null || mWindowManager == null) {
throw new IllegalStateException("You must specify a valid content view by "
+ "calling setContentView() before attempting to show the popup.");
}

// The old decor view may be transitioning out. Make sure it finishes
// and cleans up before we try to create another one.
if (mDecorView != null) {
mDecorView.cancelTransitions();
}

// When a background is available, we embed the content view within
// another view that owns the background drawable.
if (mBackground != null) {
mBackgroundView = createBackgroundView(mContentView);
mBackgroundView.setBackground(mBackground);
} else {
mBackgroundView = mContentView;
}
// 这个方法很关键
mDecorView = createDecorView(mBackgroundView);

// The background owner should be elevated so that it casts a shadow.
mBackgroundView.setElevation(mElevation);

// We may wrap that in another view, so we'll need to manually specify
// the surface insets.
p.setSurfaceInsets(mBackgroundView, true /*manual*/, true /*preservePrevious*/);

mPopupViewInitialLayoutDirectionInherited =
(mContentView.getRawLayoutDirection() == View.LAYOUT_DIRECTION_INHERIT);
}


对比:其实可以对比一下API 25的源码和前文 API 21 的源码,在
preparePopup
还是有很大区别的。这个区别是从Android 6.0改动的(因此本文都以Android 6.0为界限),前面第一节分析过了,在Android 6.0之前的
preparePopup
方法中,在
mBackgroud
不为null的情况下,包装了一个
PopupViewContainer
,在
PopupViewContainer
里面处理的事件分发。

而在Android 6.0以上,在这里更改了,在
createDecorView
这个方法里做了统一处理,也就是不管
mBackgroud
为null或者不为null,都会走到这个方法,这也就是为什么在Android 6.0以上不用调用seteBackgroudDrawable方法也可以点击外部dismiss的原因。

3 ,接下来重点看一下
createDecorView
方法:

private PopupDecorView createDecorView(View contentView) {
final ViewGroup.LayoutParams layoutParams = mContentView.getLayoutParams();
final int height;
if (layoutParams != null && layoutParams.height == WRAP_CONTENT) {
height = WRAP_CONTENT;
} else {
height = MATCH_PARENT;
}
//包装了一个PopupDecorView,其中做了事件分发处理
final PopupDecorView decorView = new PopupDecorView(mContext);
decorView.addView(contentView, MATCH_PARENT, height);
decorView.setClipChildren(false);
decorView.setClipToPadding(false);

return decorView;
}


在这个方法中给ContentView 包装了一个
PopupDecorView
类,我们看一下这个类干了什么。

private class PopupDecorView extends FrameLayout {

....
// 前面省略
@Override
public boolean dispatchTouchEvent(MotionEvent ev) {
//如果设置了拦截器,将事件交给拦截器处理
if (mTouchInterceptor != null && mTouchInterceptor.onTouch(this, ev)) {
return true;
}
return super.dispatchTouchEvent(ev);
}

@Override
public boolean onTouchEvent(MotionEvent event) {
final int x = (int) event.getX();
final int y = (int) event.getY();
//判断ActionDown 事件,点击区域在PopupWindow之外,dismiss PopupWindow
if ((event.getAction() == MotionEvent.ACTION_DOWN)
&& ((x < 0) || (x >= getWidth()) || (y < 0) || (y >= getHeight()))) {
dismiss();
return true;
} else if (event.getAction() == MotionEvent.ACTION_OUTSIDE) {
//如果是MotionEvent.ACTION_OUTSIDE 事件, dismiss PopupWindow
dismiss();
return true;
} else {
return super.onTouchEvent(event);
}
}

//后面省略
...
}


我们可以看到在Android 6.0以前,PopupWindow的事件分发逻辑是在
PopupViewContainer
里面做的,而Android 6.0以后,是放在了
PopupDecorView
里面。

我们来分析一下 它的
onTouch
处理逻辑:

判断ActionDown 事件,点击区域在PopupWindow之外,dismiss PopupWindow。

如果是MotionEvent.ACTION_OUTSIDE 事件, dismiss PopupWindow

有了上面的两个条件,在Android 6.0以上版本,不管怎么样,只要你点击了 PopupWindow以外区域,都会符合上面的两个条件之一。因此都会dismiss 掉PopupWindow的(要是google工程师能用一个变量来控制就好了)。因此要想在Android 6.0以上,点击PopupWindow之外部分,PopupWindow不消失,就只有一个办法 :事件拦截。看一下这个方法:

@Override
public boolean dispatchTouchEvent(MotionEvent ev) {
if (mTouchInterceptor != null && mTouchInterceptor.onTouch(this, ev)) {
return true;
}
return super.dispatchTouchEvent(ev);
}


重点就在
dispatchTouchEvent
这个方法,如果我们设置了拦截器
mTouchInterceptor
,就会执行拦截器的
onTouch
方法,并且消费掉这个事件,也就是说,事件不会再传递到
onTouchEvent
这个方法,因此就不会调用dismiss方法来取消PopupWindow。


最后解决方案:

为PopupWindow设置拦截器,代码如下:

//注意下面这三个是contentView 不是PopupWindow
mPopupWindow.getContentView().setFocusable(true);
mPopupWindow.getContentView().setFocusableInTouchMode(true);
mPopupWindow.getContentView().setOnKeyListener(new View.OnKeyListener() {
@Override
public boolean onKey(View v, int keyCode, KeyEvent event) {
if (keyCode == KeyEvent.KEYCODE_BACK) {
mPopupWindow.dismiss();

return true;
}
return false;
}
});
//在Android 6.0以上 ,只能通过拦截事件来解决
mPopupWindow.setTouchInterceptor(new View.OnTouchListener() {
@Override
public boolean onTouch(View v, MotionEvent event) {

final int x = (int) event.getX();
final int y = (int) event.getY();

if ((event.getAction() == MotionEvent.ACTION_DOWN)
&& ((x < 0) || (x >= mWidth) || (y < 0) || (y >= mHeight))) {
// donothing
// 消费事件
return true;
} else if (event.getAction() == MotionEvent.ACTION_OUTSIDE) {
Log.e(TAG,"out side ...");
return true;
}
return false;
}
});


解释:
onTouch
中的判断条件和
onTouchEvent
的判断条件保持一致就行了,在符合点击PopupWindow外部的的两个条件中,直接返回ture,其他则返回false。返回true的时候,就不会走到
PopupDecorView
onTouchEvent
方法,就不会dismiss。反之,返回false,则会走到
onTouchEvent
方法,就会dismiss 掉PopupWindow。

最终效果如下:



3 . CustomPopWindow 一行代码控制

上面我们找到了方法,通过设置拦截器的方式,可以兼容Android 6.0 以上,点击PopupWindow之外的区域不消失。因此我们就可以用一个变量来控制点击PopupWindow 以外的区域 PopupWindow的消失/不消失

CustomPopwindow地址:https://github.com/pinguo-zhouwei/CustomPopwindow

使用如下:

View view = LayoutInflater.from(this).inflate(R.layout.pop_layout_close,null);
//处理PopupWindow中的点击事件
View.OnClickListener listener = new View.OnClickListener() {
@Override
public void onClick(View v) {
Log.e("TAG","onClick.....");
mPopWindow.dissmiss();
}
};
view.findViewById(R.id.close_pop).setOnClickListener(listener);

mPopWindow = new CustomPopWindow.PopupWindowBuilder(this)
.setView(view)
.enableOutsideTouchableDissmiss(false)// 设置点击PopupWindow之外的地方,popWindow不关闭,如果不设置这个属性或者为true,则关闭
.create();

mPopWindow.showAsDropDown(mButton7,0,10);


如果需要点击PopupWindow以外区域不消失,并且像 AlertDialog一样是模态的话,只需要配置这个方法
enableOutsideTouchableDissmiss(false)
即可。

4 . 总结

本文从源码的角度解析了为什么在Android 6.0以下,需要设置
setBackgroundDrawable()
才能取消显示的PopupoWindow。和在Android 6.0以后,Google 对PopupWindow 的改动,最终通过剖析源码,找到了通过设置拦截器的方式来让Android 6.0以上版本可以点击PopupWindow 之外的区域不消失。以上,如有问题,欢迎指正。
内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息