PopupWindow 使用详解(一) 中文API 文档 赠送 ListPopupWindow 中文 API

简介: 原汁原味翻译 ListPopupWindow 与 PopupWindow API文档。

笔者数了数枕巾脱落的头发,发现了 Android 开发常用的类似于弹窗的悬浮窗口 大概是 PopupWindow 和 dialog。之前有还算具体的写过关于 dialog 以及自定义 dialog 甚至是 dialogActivity 的相关笔记,即:Android 系统原生dialog使用Android dialog Activity 使用android自定义相对复杂dialog 。突然感觉 PopupWindow 这个说简单不简单,说难不难的知识点也应该详细研究一下。
下面回归正题,请欣赏笔者的表演:

一、创建 PopupWindow

先说一下 Google 爸爸提供的构造方法

public PopupWindow() 

public PopupWindow(View contentView) 
public PopupWindow(int width, int height)
public PopupWindow(View contentView, int width, int height)
public PopupWindow(View contentView, int width, int height, boolean focusable)

public PopupWindow(Context context)
public PopupWindow(Context context, AttributeSet attrs)
public PopupWindow(Context context, AttributeSet attrs, int defStyleAttr)
public PopupWindow(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)

数一数不多不少 9 个构造方法,一个无参的 8 个有参的,参数代表的意思分别为:
View contentView 表示该 PopupWindow 内装载的内容,即展示各位用户的内容
int width, int height表示该 PopupWindow 对象的长度和宽度,参数可以是 ViewGroup.LayoutParams.WRAP_CONTENTViewGroup.LayoutParams.MATCH_PARENT
也可以是具体的数值了。但是 这里规定的 是 PopupWindow 内加载到的 view 对象的大小。相当于 PopupWindow 设置的值 为 xml 内最外层布局是等效的。

如果,需要控制加载展示的 view 大小,那么需要将该参数设置ViewGroup.LayoutParams.WRAP_CONTENT 并且 目标样式外再包裹一层布局,类似于:

<?xml version="1.0" encoding="utf-8"?>
<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent">

    <RelativeLayout
        android:layout_width="200dp"
        android:layout_height="200dp"
        android:layout_centerInParent="true">

        <ImageView
            android:id="@+id/iv_home"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:contentDescription="@string/app_name"
            android:src="@mipmap/home" />
    </RelativeLayout>
</RelativeLayout>

boolean focusable PopupWindow 响应内部的点击事件,例如 TextView、Button 等
Context context 上下文,不多讲
剩下下面的三个构造方法,不常用,但是会自定义 view 的大佬都知道啥意思。

二、常用设置方法

//设置动画特效 即 展示和消失动画
public void setAnimationStyle(int animationStyle)
//主要作用是为了设置 PopupWindow 显示的时候是否会与 StatusBar 重叠(如果存在的话也包括 SystemBar )
public void setAttachedInDecor(boolean enabled)
//设置  PopupWindow 的背景。该属性不设置的会,会导致 PopupWindow 出现后不会消失,即便是 点击 back 键也不起作用。这应该是 PopupWindow 较为变态的地方。
public void setBackgroundDrawable(Drawable background)
//设置 PopupWindow 允许超出窗口
public void setClippingEnabled(boolean enabled)
//设置 PopupWindow  内展示的内容
public void setContentView(View contentView)
//设置 PopupWindow  的高度,类似于 3D 效果的阴影
public void setElevation(float elevation)
//设置 PopupWindow的入场动画
public void setEnterTransition(Transition enterTransition) 
//有如就得有出 设置出场动画
public void setExitTransition(Transition exitTransition)
//设置 popupWindow 是否可以获取焦点
 public void setFocusable(boolean focusable)
//设置 PopupWindow的高度
 public void setHeight(int height) 
//脸颊事件  Events 都是有大小的当触摸点大于手指头大小时,则为 脸颊事件 ,蛮有意思的 你可以尝试一下。
 public void setIgnoreCheekPress()
//设置输入法的操作模式 
 public void setInputMethodMode(int mode)
//监听 PopupWindow关闭的事件
 public void setOnDismissListener(OnDismissListener onDismissListener)
//设置 点击 PopupWindow意外区域,隐藏 popupWindow  然而并没有什么卵用
 public void setOutsideTouchable(boolean touchable) 
// PopupWindow触摸时的监听回调
 public void setTouchInterceptor(OnTouchListener l)
//设置 PopupWindow是否可触摸
 public void setTouchable(boolean touchable)
//设置 popwindow 的宽度
 public void setWidth(int width)
//设置 PopupWindow布局类型
  public void setWindowLayoutType(int layoutType)

设置 PopupWindow 显示位置 相对重要 拿出来写

//设置 PopupWindow 在某个控件的下方,某控件的左下角与 PopupWindow 的左上角对齐
public void showAsDropDown(View anchor)

//设置 PopupWindow 在某个控件的下方,某控件的左下角与 PopupWindow 的左上角对齐,可以设置偏移量 向左为副 ,向右为正;向上为负,向下为正
 public void showAsDropDown(View anchor, int xoff, int yoff) 
//设置 PopupWindow 在相当于父布局进行摆放,可以设置偏移量。
public void showAtLocation(View parent, int gravity, int x, int y)
//隐藏 PopupWindow 
public void dismiss()

三、常用获取方法

//获取 PopupWindow 动画样式
 public int getAnimationStyle()
//获取 PopupWindow 背景
 public Drawable getBackground() 
//获取 PopupWindow 设置的 view 返回一个view对象
 public View getContentView() 
//获得 PopupWindow 的悬浮高度
 public float getElevation() 
//获取 PopUpWindow 的入场动画
 public float getElevation() 
//获取 PopupWindow 的出场动画
public Transition getExitTransition()
//获取 PopupWindow 的高度
public int getHeight() 
//获取输入模式
public int getInputMethodMode() 
//获取 PopupWindow 是否应该与寄生(不太合理但是不知道用啥词)对象重叠
public boolean getOverlapAnchor()
//获取 Popwindow 的宽度
 public int getWidth()
//获取 PopupWindow 的布局类型
 public int getWindowLayoutType() 

//获取可以让 PopupWindow 设置的最大高度
public int getMaxAvailableHeight(View anchor)
public int getMaxAvailableHeight(View anchor, int yOffset) 
//获取可以设置 PopupWindow 的最大高度,可以忽略软键盘。
public int getMaxAvailableHeight(
            View anchor, int yOffset, boolean ignoreBottomDecorations)

四、常用判断方法

//判断 PopupWindow 是否在超出父布局
public boolean isAboveAnchor() 
// 判断 PopupWindow 是否在父布局的 装饰上
public boolean isAttachedInDecor()
//判读 PopupWindow 是否可以超出窗口
public boolean isClippingEnabled()
//判断 PopupWindow 是否可以获取焦点
public boolean isFocusable()
//判断 PopupWindow 是否相应自身以外的点击事件
public boolean isOutsideTouchable()
//判断 PopupWindow 是否展示
public boolean isShowing()
//判断 PopupWindow 是否支持多点触控
public boolean isSplitTouchEnabled()
//判断 PopupWindow 是否支持触摸事件
public boolean isTouchable()

五、不常使用 更新位置或更新内容方法

//更新当前 PopupWindow
public void update() 
//更新 Popwindow 到新的形态  参数:长度、宽度
public void update(int width, int height) 
//更新 Popwindow 到新的位置、新的形态  参数:新位置的坐标,长度、宽度
public void update(int x, int y, int width, int height)
//同上
public void update(int x, int y, int width, int height, boolean force)

//相对于宿主 更新体型
public void update(View anchor, int width, int height)
//相对宿主更新 大小 位置
public void update(View anchor, int xoff, int yoff, int width, int height) 

六、部分主要事项

1、

PopupWindow 默认是不允许超出窗口的,具体演示请看下篇笔记;

2、

PopupWindow 的 public void setOutsideTouchable(boolean touchable) 方法默认没有什么卵用 ,是否可以点击 PopupWindow 外部进行隐藏 PopupWindow ,必须设置 public void setBackgroundDrawable(Drawable background) 该方法

3、

getHeight() getWidth() 方法不太好用,一般返回为 0;如果获取 PopupWindow 的长宽建议使用如下方法:

devPop.getContentView().measure(0, 0);
int hight=devPop.getContentView().getMeasuredHeight();
int width=devPop.getContentView().getMeasuredWidth();

4、

将 PopupWindow 的四角设置为圆角方法,可以将事先准备的 view 的父布局加一个带有圆角的 shape background, 之后设置 PopupWindow 的 setBackgroundDrawable() 方法 设置为devPop.setBackgroundDrawable(new ColorDrawable(0x00ffffff));

5、

一定要在显示 PopupWindow 的界面的 OnDestroy()方法内调用 dismiss()方法,否则会产生 “意想不到”的惊喜。

 @Override
    protected void onDestroy() {
        super.onDestroy();
        if (popupWindow != null) {
            popupWindow.dismiss();
        }
    }

6、

笔者遇到的注意事项,感觉目前就这么多了,之后如果遇到还会补充;

七、附赠 ListPopupWindow 相关汉语 API

1、效果展示

或许各位很多人都知道 PopupWindow 但是 少有人知道 ListPopupWindow ,故 展示效果如下,具体应用 请留意之后的 笔记。
ListPopupWindow 效果

2、相关 API

继承结构
继承结构

(1)、构造方法
public ListPopupWindow( Context context)
public ListPopupWindow( Context context,  AttributeSet attrs)
public ListPopupWindow( Context context,  AttributeSet attrs,int defStyleAttr) 
public ListPopupWindow(Context context,  AttributeSet attrs,int defStyleAttr,  int defStyleRes)

构造方法就这四种,笔者常用的是第一种。

(2)、设置类方法
//为列表设置 适配器
public void setAdapter( ListAdapter adapter)
//设置锚点 view 寄生的view
public void setAnchorView(@Nullable View anchor)
//为 ListPopupWindow 设置动画样式
public void setAnimationStyle( int animationStyle) 
//为 ListPopupWindow 设置背景
public void setBackgroundDrawable( Drawable d)
//设置 ListPopupWindow 的宽度 单位:像素
public void setContentWidth(int width)
//设置下拉列表的对齐方式
public void setDropDownGravity(int gravity)
//设置 ListPopupWindow 的高度 单位:像素
public void setHeight(int height)
//设置横向偏移量 单位:像素
public void setHorizontalOffset(int offset)
//设置 Drawable 为列表的选择器
public void setListSelector(Drawable selector) 
//将 ListPopupWindow 设置为模态框
 public void setModal(boolean modal)
//设置 ListPopupWindow  提示位置
public void setPromptView( View prompt)
//设置 ListPopupWindow  的选定位置
public void setSelection(int position)
//设置 ListPopupWindow  输入区域的输入模式
public void setSoftInputMode(int mode)
//设置 ListPopupWindow  的竖直方向偏移量
public void setVerticalOffset(int offset)
//设置 ListPopupWindow  的宽度
public void setWidth(int width) 
//设置 ListPopupWindow  的布局类型
public void setWindowLayoutType(int layoutType)
// 可将返回对象 添加到 源视图中,进而实现拖动并打开。
public OnTouchListener createDragToOpenListener(View src)

//展示 ListPopupWindow  
public void show() 
(3)、监听器
//设置 ListPopupWindow  关闭的 时的监听
public void setOnDismissListener(PopupWindow.OnDismissListener listener) 
//设置 ListPopupWindow 的 item 单击时的监听回调
public void setOnItemClickListener(AdapterView.OnItemClickListener clickListener)
//设置 ListPopupWindow  item 被选择 时的监听回调
public void setOnItemSelectedListener(OnItemSelectedListener selectedListener)
(4)、获取方法
//获取 ListPopupWindow  的锚点 view
public View getAnchorView()
//获取 ListPopupWindow  的动画样式
public  int getAnimationStyle() 
//获取 ListPopupWindow  的背景
public  Drawable getBackground() 
//获取 ListPopupWindow 的高度
public int getHeight()
//获取 ListPopupWindow 的横向偏移量
public int getHorizontalOffset() 
//获取 ListPopupWindow 的 列表
public  ListView getListView()
//获取可选的 ListPopupWindow 的位置
public int getPromptPosition()
//获取 ListPopupWindow 内被选中的 item
public  Object getSelectedItem() 
//获取被选中的 item 的 id
public long getSelectedItemId()
//获取被选中的 item 的位置
public int getSelectedItemPosition() 
//获取被选中的 view
public  View getSelectedView() 
//获取 垂直方向的偏移量  单位:像素
public int getVerticalOffset() 
//获取 ListPopupWindow 的宽度
public int getWidth()
(5)、判断方法
//判断是否为 模态框样式
public boolean isModal()
//判断是否为显示状态
public boolean isShowing()

//过了关键按键  点击事件
public boolean onKeyDown(int keyCode,  KeyEvent event)
//过滤关键按键 点击抬起事件
public boolean onKeyUp(int keyCode,  KeyEvent event)
//判断 是否 在指定 item 下执行点击事件
public boolean performItemClick(int position)
(6)、其他的重要方法
//执行相关 对 ui 线程的操作
public void postShow()
//删除 当前列表的所有选择
public void clearListSelection() 
//关闭 ListPopupWindow 
public void dismiss()

3、关于 ListPopupWindow 的其它 杂谈

当发现这个 ListPopupWindow 算是控件的工具值,笔者舍去很多地方的 ListView 和部分AutoCompleteTextView 和 Spinner 控件使用,因为 ListPopupWindow 搭配 TextView 或者搭配 EditText 极其好用。

今天学习就到这里,笔者希望可以帮助各位在伙伴,欢迎大佬指点、批评还有建议;
之后的几篇笔者尽快写出来,只是一些 关于 ListPopupWindow 和 PopupWindow 的具体用法,相关源码会上传 github ;
不介意各位读者,帮忙点个心或者是加个关注哈 (︶.̮︶) !

相关文章
|
3月前
|
Java API 开发者
在Spring Boot中集成Swagger API文档
在Spring Boot中集成Swagger API文档
|
29天前
|
JSON 缓存 API
淘系商品详情API接口概述,API文档说明
在成长的路上,我们都是同行者。这篇关于API接口的文章,希望能帮助到您。期待与您继续分享更多API接口的知识,请记得关注Anzexi58哦! 淘宝API接口文档是淘宝开放平台为开发者提供的一套详细的技术规范和使用指南,旨在帮助开发者通过API接口与淘宝平台进行交互,获取商品详情等数据。以下是对淘宝商品详情数据解析的详细说明:
|
2月前
|
Java API 数据中心
百炼平台Java 集成API上传文档到数据中心并添加索引
本文主要演示阿里云百炼产品,如何通过API实现数据中心文档的上传和索引的添加。
|
3月前
|
安全 Java API
Nest.js 实战 (三):使用 Swagger 优雅地生成 API 文档
这篇文章介绍了Swagger,它是一组开源工具,围绕OpenAPI规范帮助设计、构建、记录和使用RESTAPI。文章主要讨论了Swagger的主要工具,包括SwaggerEditor、SwaggerUI、SwaggerCodegen等。然后介绍了如何在Nest框架中集成Swagger,展示了安装依赖、定义DTO和控制器等步骤,以及如何使用Swagger装饰器。文章最后总结说,集成Swagger文档可以自动生成和维护API文档,规范API标准化和一致性,但会增加开发者工作量,需要保持注释和装饰器的准确性。
Nest.js 实战 (三):使用 Swagger 优雅地生成 API 文档
|
3月前
|
开发框架 Java 测试技术
Spring Boot中的API文档生成
Spring Boot中的API文档生成
|
3月前
|
JSON Java API
Spring Boot中使用OpenAPI生成API文档
Spring Boot中使用OpenAPI生成API文档
|
4月前
|
自然语言处理 安全 API
触发邮件接口有哪些?邮件API文档
**触发邮件接口**如AokSend、Mailgun、Amazon SES、Postmark和Sendinblue是自动化企业通信的关键。这些接口在特定事件时自动发送邮件,提高效率和客户体验。例如,AokSend提供详细的API文档,支持事件触发、模板管理和多语言集成;Mailgun以灵活性著称;Amazon SES适合大规模发送;Postmark专注于事务邮件;Sendinblue则提供邮件、短信和营销自动化功能。每种服务都有示例代码展示如何使用API发送邮件。选择合适的接口能提升企业通信效率和客户满意度。
|
4月前
|
Java API Spring
Spring Boot中配置Swagger用于API文档
Spring Boot中配置Swagger用于API文档
|
4月前
|
API 开发工具 git
ShowDoc自动生成api接口文档
ShowDoc自动生成api接口文档
92 0
|
4月前
|
前端开发 Java API
Java中的API设计与文档生成最佳实践
Java中的API设计与文档生成最佳实践