Dialog

Project Url: kongzue/Dialog
Introduction: 空祖家的对话框工具
More: Author   ReportBugs   
Tags:

献给要求我们安卓照着苹果设计稿做开发的产品们(手动滑稽

Kongzue Dialog Maven License Homepage

多语言文档: English

空祖家的对话框 2.0 拥有提供最简单的调用方式以实现消息框、选择框、输入框、等待提示、警告提示、完成提示、错误提示等弹出样式。以下是目前包含的所有对话框样式预览图:

Kongzue's Dialog

试用版可以前往 http://fir.im/kDialog 下载

Kongzue's Dialog Demo

本例中,包含 DialogDemo(Dialog/app/)是对话框的演示项目源代码,以及 Library 库(Dialog/dialog/)是封装的空祖家对话框的源代码。

项目托管的 Maven 仓库在https://bintray.com/myzchh/maven/dialog

本项目遵循 Apache-2.0 开源协议,具体可参考:http://www.opensource.org/licenses/apache2.0.php

目录

· Maven 仓库或 Gradle 的引用方式

· 使用说明

· 关于 v2 组件包

· 关于模糊效果

· 使用方法

···· 调用消息对话框的方法

···· 调用选择对话框的方法

···· 调用输入对话框

···· 调用等待提示框

···· 调用完成提示框

···· 调用警告提示框

···· 调用错误提示框

···· 调用消息通知

···· 调用底部菜单

···· 气泡提示

· 自定义布局

· 附加功能

· 模态化(序列化)

· 一些建议

· 开源协议

· 更新日志

Maven 仓库或 Gradle 的引用方式

Maven 仓库:

<dependency>
  <groupId>com.kongzue.dialog</groupId>
  <artifactId>dialog</artifactId>
  <version>2.3.4</version>
  <type>pom</type>
</dependency>

Gradle: 在 dependencies{}中添加引用:

implementation 'com.kongzue.dialog:dialog:2.3.4'

若需要使用 v1 兼容库的老版本,可使用:

implementation 'com.kongzue.dialog:dialog:2.2.8'        //警告:不再提供更新

若需要降低包体积,可使用不带模糊的版本:

implementation 'com.kongzue.dialog:dialog:2.1.0'        //警告:不再提供更新

使用说明

1) 组件启用前请先初始化全局的风格样式,具体方法为

DialogSettings.type = TYPE_MATERIAL;

Material 风格对应 DialogSettings.TYPE_MATERIAL,

Kongzue 风格对应 DialogSettings.TYPE_KONGZUE,

iOS 风格对应 DialogSettings.TYPE_IOS

需要注意的是风格设置仅针对对话框,提示框样式不会改变。

2) 要启用 Light & Dark 黑白主题模式,请调用以下语句实现:

DialogSettings.tip_theme = THEME_LIGHT;         //设置提示框主题为亮色主题
DialogSettings.dialog_theme = THEME_DARK;       //设置对话框主题为暗色主题

具体预览图如下: Kongzue's Dialog Light&DarkMode

3) 从 2.0.4 版本开始,提供不需要悬浮窗权限,且可以跨域显示的通知功能,如下图所示: Kongzue's Dialog Notifaction

4) 从 2.1.0 版本开始,提供底部菜单,可以通过 com.kongzue.dialog.v2.BottomMenu 进行使用,如下图所示: Kongzue's Dialog BottomMenu

5) 从 2.1.1 版本开始,iOS 风格的对话框、提示框、底部菜单新增即时模糊效果: Kongzue's Dialog Blur

6) 从 2.2.3 版本开始,MessageDialog、SelectDialog、InputDialog 和 BottomMenu 支持自定义布局: Kongzue's Dialog CustomView

7) 从 2.3.4 版本开始,提供气泡提示功能: Kongzue's Dialog CustomView

关于 v2 组件包

在空祖家的对话框组件中,依然保留了一代的组件库但不再推荐使用,这是为了保持兼容性,若强行使用您会看到相关类的名称上有删除线。

为了更有效率的开发,我们现在强烈推荐直接使用 v2 组件库,其包含的包地址为:com.kongzue.dialog.v2

关于模糊效果

从 2.1.1 版本起可使用即时模糊效果。

您可以通过以下属性设置开关:

DialogSettings.use_blur = true;                 //设置是否启用模糊

如果需要启动,还需要在您的 app 的 build.gradle 中添加以下代码:

android {
    ...
    defaultConfig {
        ...

        renderscriptTargetApi 19
        renderscriptSupportModeEnabled true
    }
}

模糊效果目前仅对当 DialogSettings.type = TYPE_IOS 时三种对话框、提示框、等待框以及底部菜单有效。

可以通过以下方法修改模糊透明度:

/*
 *  决定等待框、提示框以及 iOS 风格的对话框的模糊背景透明度(50-255)
 */
DialogSettings.blur_alpha = 200;

使用方法

调用消息对话框的方法:

MessageDialog.show(context, "消息提示框", "用于提示一些消息", "知道了", new DialogInterface.OnClickListener() {
    @Override
    public void onClick(DialogInterface dialog, int which) {
    }
});

或者可以采用快速调用方式:

MessageDialog.show(context, "欢迎", "欢迎使用 Kongzue 家的对话框,此案例提供常用的几种对话框样式。\n 如有问题可以在 https://github.com/kongzue/Dialog 提交反馈");

调用选择对话框的方法:

SelectDialog.show(context, "提示", "请做出你的选择", "确定", new DialogInterface.OnClickListener() {
    @Override
    public void onClick(DialogInterface dialog, int which) {
        Toast.makeText(context, "您点击了确定按钮", Toast.LENGTH_SHORT).show();
    }
}, "取消", new DialogInterface.OnClickListener() {
    @Override
    public void onClick(DialogInterface dialog, int which) {
        Toast.makeText(context, "您点击了取消按钮", Toast.LENGTH_SHORT).show();
    }
});

或者可以采用快速调用方式:

SelectDialog.show(context, "提示", "请做出你的选择", new DialogInterface.OnClickListener() {
    @Override
    public void onClick(DialogInterface dialog, int which) {
        Toast.makeText(context, "您点击了确定按钮", Toast.LENGTH_SHORT).show();
    }
});

调用输入对话框:

InputDialog.show(context, "设置昵称", "设置一个好听的名字吧", "确定", new InputDialogOkButtonClickListener() {
    @Override
    public void onClick(Dialog dialog, String inputText) {
        Toast.makeText(context, "您输入了:" + inputText, Toast.LENGTH_SHORT).show();
    }
}, "取消", new DialogInterface.OnClickListener() {
    @Override
    public void onClick(DialogInterface dialog, int which) {

    }
});

或者可以采用快速调用方式:

InputDialog.show(context, "设置昵称", "设置一个好听的名字吧", new InputDialogOkButtonClickListener() {
                    @Override
                    public void onClick(Dialog dialog, String inputText) {
                        Toast.makeText(context, "您输入了:" + inputText, Toast.LENGTH_SHORT).show();
                    }
                });

调用等待提示框:

WaitDialog.show(context, "载入中...");

调用完成提示框:

TipDialog.show(context, "完成", TipDialog.SHOW_TIME_SHORT, TipDialog.TYPE_FINISH);

调用警告提示框:

TipDialog.show(context, "请输入密码", TipDialog.SHOW_TIME_SHORT, TipDialog.TYPE_WARNING);

调用错误提示框:

TipDialog.show(context, "禁止访问", TipDialog.SHOW_TIME_LONG, TipDialog.TYPE_ERROR);

调用消息通知:

注意,此处使用的是来自 com.kongzue.dialog.v2 的 Notification 类。

通知消息(v2.Notification)与提示框(v2.TipDialog)的主要区别是提示框会打断用的操作,而消息通知不会,消息通知适合于并发需要提醒用户是否处理消息的业务场景,而提示框适用于阻断用户操作,提醒用户当前发生的情况的业务场景。

Notification.show(context, id, iconResId, getString(R.string.app_name), "这是一条消息", Notification.SHOW_TIME_LONG, notifactionType)
                        .setOnNotificationClickListener(new Notification.OnNotificationClickListener() {
                            @Override
                            public void OnClick(int id) {
                                Toast.makeText(context,"点击了通知",SHOW_TIME_SHORT).show();
                            }
                        })
                ;

其中,id 为通知消息 id,在用户点击该通知后,会在 OnNotificationClickListener 中进行回调。

字段 含义 是否必须
context 上下文索引 必须
iconResId 图标 可选
title 通知标题 可选
message 通知内容 必须
colorType 消息类型 必须
OnNotificationClickListener 下载监听器 可选

注意,此处的消息类型 colorType 目前仅对“Kongzue 风格”有效,且提供的风格有:

字段 含义 是否默认
TYPE_NORMAL 默认灰黑色 默认
TYPE_FINISH 绿色 可选
TYPE_WARNING 橙色 可选
TYPE_ERROR 红色 可选

在 2.0.6 版本后,若 colorType 不为上述设定值,则可以使用自选颜色值,可为 Color 类的返回值。

另外,可以采用快速调用方式:

Notification.show(context, 0, "", "这是一条消息", Notification.SHOW_TIME_SHORT, notifactionType);

调用底部菜单:

注意,此处使用的是来自 com.kongzue.dialog.v2 的 BottomMenu 类。

List<String> list = new ArrayList<>();
list.add("菜单 1");
list.add("菜单 2");
list.add("菜单 3");
BottomMenu.show(context, list, new OnMenuItemClickListener() {
    @Override
    public void onClick(String text, int index) {
        Toast.makeText(context,"菜单 " + text + " 被点击了",SHOW_TIME_SHORT).show();
    }
},true);

包含的参数如下:

字段 含义 是否必须
activity 必须继承自 AppCompatActivity 必须
list 泛型为 String 的列表 必须
OnMenuItemClickListener 点击回调 可选
isShowCancelButton 是否显示“取消”按钮,注意,TYPE_MATERIAL 风格对此无效 可选
cancelButtonCaption 设置“取消”按钮的文字 可选

另外,本菜单暂时对夜间模式(THEME_DARK)不受影响,只提供 Light Theme,但不排除接下来的版本对此更新。

使用 iOS 主题时,DialogSettings.ios_normal_button_color 会对菜单内容文字的颜色产生影响,其他主题不受此属性影响。

或可以使用快速调用:

List<String> list = new ArrayList<>();
list.add("菜单 1");
list.add("菜单 2");
list.add("菜单 3");
BottomMenu.show(context, list);

为底部对话框添加标题:

BottomMenu.show(context, list).setTitle("这里是标题测试");

气泡提示:

从 2.3.4 版本起,新增气泡提示功能。

使用方法如下:

Pop.show(context, view, "这是一个提示", showWhere, colorType);

view 为气泡提示需要跟随的布局,可选参数 showWhere 可选:

字段 含义 是否默认
SHOW_UP 在跟随布局上方显示
SHOW_LEFT 在跟随布局左侧显示
SHOW_RIGHT 在跟随布局右侧显示
SHOW_DOWN 在跟随布局下方显示

可选参数 colorType 控制气泡颜色,当其值为 COLOR_TYPE_NORMAL 时受 DialogSettings.tip_theme 设置影响,会显示暗色或亮色主题,另外可选:

字段 含义 是否默认
COLOR_TYPE_NORMAL 默认颜色,此时会受 DialogSettings.tip_theme 影响
COLOR_TYPE_FINISH 绿色
COLOR_TYPE_WARNING 橙色
COLOR_TYPE_ERROR 红色

其次可使用 setText(...) 方法对已经创建的气泡提示进行文字修改,范例如下:

pop.setText("至少填写 6 位,还差" + (6 - editPop.getText().toString().length()) + "位");

可使用 setOnDismissListener(...) 方法对气泡消失事件进行监听:

pop.setOnDismissListener(new PopupWindow.OnDismissListener() {
    @Override
    public void onDismiss() {

    }
});

可使用 dismiss(); 方法直接关闭已创建的气泡:

pop.dismiss();

自定义布局:

从 2.2.3 版本起支持 MessageDialog、SelectDialog、InputDialog 和 BottomMenu 的自定义布局。

由于调用逻辑顺序不同,在 type 为 TYPE_KONGZUE 和 TYPE_IOS 使用方法举例:

//初始化布局:
View customView = LayoutInflater.from(me).inflate(R.layout.layout_custom, null);
//启动对话框
MessageDialog.show(context, null, null, "知道了", new DialogInterface.OnClickListener() {
                    @Override
                    public void onClick(DialogInterface dialog, int which) {

                    }
                }).setCustomView(customView);

在 type 为 TYPE_MATERIAL 时,请先使用 build(...) 方法创建 Dialog,接着设置好自定义布局后再执行 showDialog() 方法,使用方法举例:

//初始化布局:
View customView = LayoutInflater.from(me).inflate(R.layout.layout_custom, null);
//启动对话框
MessageDialog.build(context, null, null, "知道了", new DialogInterface.OnClickLis
    @Override
    public void onClick(DialogInterface dialog, int which) {

    }
}).setCustomView(customView)
  .setCanCancel(true)
  .showDialog();

附加功能:

在任何一种对话框中都可以使用.setCanCancel(boolean)来设置是否可以点击对话框以外的区域关闭对话框,提示类默认都是禁止的,选择、输入对话框默认也是禁止的,消息对话框默认是允许的。

使用方法可以参考以下代码:

WaitDialog.show(context, "载入中...").setCanCancel(true);

在空祖家的对话框组件中,您可以使用监听器来监听对话框的生命周期,Demo 如下:

WaitDialog.show(context, "载入中...").setCanCancel(true).setDialogLifeCycleListener(new DialogLifeCycleListener() {
    @Override
    public void onCreate(AlertDialog alertDialog) {
        //此时对话框创建
    }
    @Override
    public void onShow(AlertDialog alertDialog) {
        //此时对话框显示
    }
    @Override
    public void onDismiss() {
        //此时对话框关闭
    }
});

另外提供一些定制属性:

DialogSettings.dialog_title_text_size = -1;                 //设置对话框标题文字大小,<=0 不启用
DialogSettings.dialog_message_text_size = -1;               //设置对话框内容文字大小,<=0 不启用
DialogSettings.dialog_button_text_size = -1;                //设置对话框按钮文字大小,<=0 不启用
DialogSettings.dialog_menu_text_size = -1;                  //设置菜单默认字号,<=0 不启用
DialogSettings.tip_text_size = -1;                          //设置提示框文字大小,<=0 不启用
DialogSettings.ios_normal_button_color = -1;                //设置 iOS 风格默认按钮文字颜色,=-1 不启用
DialogSettings.dialog_background_color = R.color.white;     //控制 TYPE_MATERIAL 和 TYPE_KONGZUE 两种风格时对话框的背景色,=-1 时不启用
//v2.3.1 新增:
DialogSettings.dialog_cancelable_default = -1;              //控制消息对话框、选择对话框和输入对话框默认是否可点击外部遮罩层区域关闭,=-1 不启用
DialogSettings.notification_text_color = -1;                //控制 Notification 标题和消息默认颜色,=-1 不启用
DialogSettings.notification_text_size = -1;                 //控制 Notification 标题和消息默认字号,=-1 不启用

模态化(序列化)

模态化(序列化)是指一次性弹出多个对话框时不一次性全部显示,而是按照队列一个关闭后再先试下一个的启动方式。

Kongzue Dialog 是从 2.0.9 版本起支持模态化的,但在 2.3.0 版本起我们做了更多的修改,以保证此方法可能引发的内存泄露问题得以解决,从 2.3.0 版本起,Kongzue Dialog 默认关闭了模态化,要是用模态化,请详细阅读以下文档:

从 2.3.0 版本起,我们提供了“创建”对话框的方法 build(...) ,通过此方法可以在内存中创建 Dialog 而不启动它,以下代码演示了两个消息框、一个选择框和一个输入框模态化显示的方法:

MessageDialog.build(context, "提示", "一次启动多个对话框,他们会按顺序显示出来","确定",null).showDialog();                           //第一个要显示的 Dialog 请调用其 showDialog() 将它显示出来
MessageDialog.build(context, "提示", "弹出时,会模拟阻塞的情况,此时主线程并不受影响,但对话框会建立队列,然后逐一显示","确定",null);
SelectDialog.build(context, "提示", "多种类型对话框亦支持", "知道了", new DialogInterface.OnClickListener() {
    @Override
    public void onClick(DialogInterface dialog, int which) {

    }
}, "选择 2", new DialogInterface.OnClickListener() {
    @Override
    public void onClick(DialogInterface dialog, int which) {

    }
});
InputDialog.build(context, "提示", "这是最后一个对话框,序列即将结束", "提交", new InputDialogOkButtonClickListener() {
    @Override
    public void onClick(Dialog dialog, String inputText) {
        Log.i(">>>", "InputDialogOkButtonClickListener-ok");
        dialog.dismiss();
    }
}, "取消", new DialogInterface.OnClickListener() {
    @Override
    public void onClick(DialogInterface dialog, int which) {
        Log.i(">>>", "InputDialogOkButtonClickListener-cancel");
    }
});

需要模态化的 Dialog 只需要使用 build 创建,而不会直接将它显示出来,支持模态化的有消息对话框(MessageDialog)、选择对话框(SelectDialog)和输入对话框(InputDialog),其他暂不支持。

上述代码在执行时默认就会按照一个关闭再先试下一个的方式进行。

一些建议

由于 Dialog 的模态化实现、等待对话框(WaitDialog)、提示对话框(TipDialog)都需要至少显示一段时间,而 Dialog 的显示是依赖于 Context(更准确说是 Activity) 的,那么在这段时间内,若 Activity 被卸载,则有可能发生 WindowLeaked 错误,针对此问题,建议在 Activity 的 onDestroy() 加入以下代码以确保所有 Dialog 完全卸载:

@Override
protected void onDestroy() {
    super.onDestroy();
    DialogSettings.unloadAllDialog();           //卸载掉所有对话框
}

开源协议

Copyright Kongzue Dialog

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

 http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

更新日志:

v2.3.4:

v2.3.3:

  • 修复当 type == TYPE_MATERIAL 时自定义布局的问题,具体请参考章节:自定义布局
  • 新增模糊度调节,具体亲参考章节:关于模糊效果

v2.3.2:

  • BottomMenu 支持直接使用 String[] 作为参数创建菜单;

v2.3.1:

  • 新增 DialogSettings.dialog_cancelable_default 控制消息对话框、选择对话框和输入对话框默认是否可点击外部遮罩层区域关闭;
  • 新增 DialogSettings.notification_text_color 控制 Notification 标题和消息默认颜色;
  • 新增 DialogSettings.notification_text_size 控制 Notification 标题和消息默认字号;

v2.3.0:

  • 对之前可能存在的内存泄漏的问题进行了修复;
  • 重写对话框构造器,现在起,Kongzue Dialog 默认将不再采用模态化弹出方式,要需要模态化的弹出方式,请参阅“模态化”章节;
  • 此版本起,除 Notification 外的 Dialog 均提供额外的 build 方法用以只创建而不弹出,具体请参考“模态化”章节;

v2.2.9.9:

  • 修复 InputDialog 事件问题;

v2.2.9.8:

  • 修复一些 bug;

v2.2.9.7:

  • 修复一些 bug;

v2.2.9.6:

  • 修复一些 bug;

v2.2.9.5:

  • 修复对话框的内存释放问题,提升健壮性;

v2.2.9.4:

  • 修复 TipDialog、WaitDialog 释放问题,提升健壮性;

v2.2.9.3:

  • 修复 bug;
  • 兼容性更新;

v2.2.9:

  • 不再支持 v1 版本对话框库;

v2.2.8:

  • 修复了对话框生命周期 dialogLifeCycleListener 存在的问题;

v2.2.7:

  • 暂时移除了 WaitDialog.dismiss(); 后的延迟,该延迟可能导致 WindowLeaked 异常,解决方案后续版本更新;
  • 修复对话框生命周期监听器不会重置的问题,现在在启动一个新的对话框时监听器会重置;
  • TipDialog 提供了 show(context, tip, type) 快速创建方法;

v2.2.6:

  • DialogSettings 新增属性 DEBUGMODE 以决定框架是否打印 log 日志;
  • InputDialog 在点击确定后自动关闭输入法;

v2.2.5:

  • 优化执行流程,修复可能出现的死锁问题:
    经测试,在 Dialog 显示的情况下,遇到 Activity 被 finish() 掉后导致出现问题:android.view.WindowLeaked
    此问题导致接下来用户程序在未结束掉全部进程的情况下,再无法重新启动任何对话框
    在 2.2.5 版本中我们将提供方法 DialogSettings.unloadAllDialog(),您可以在 Activity 的 onDestroy() 事件执行此方法来关闭所有在队列中的 Dialog。
    
  • 新增 DialogSettings.dialog_background_color 可控制 TYPE_MATERIAL 和 TYPE_KONGZUE 两种风格时对话框的背景色。

v2.2.4:

  • TipDialog 和 WaitDialog 现在可以支持更多文字的扩展了,且最大行数限定为 3 行;
  • 调整白色界面时模糊不透明度 180 → 200;

v2.2.3:

  • 修复 bug;
  • 新增添加自定义布局,目前支持 MessageDialog、SelectDialog、InputDialog 和 BottomMenu,因为一些原因,选择 Material 风格时仅支持对话框全部使用自定义布局。

v2.2.2:

  • InputDialog 点击确定后默认不关闭对话框,可以作出判断后再使用 dialog.dismiss() 关闭;

v2.2.1:

  • 修复多次重复调用 WaitDialog 和 TipDialog 时可能存在的叠加问题;
  • 底部菜单 BottomMenu 现已全部拒绝使用 margin\padding - Horizontal\Vertical 以避免部分设备上的兼容问题导致的布局显示错误;
  • 统一背景遮罩层 40% 不透明度;

v2.2.0:

  • 修复 bug;
  • 底部菜单支持取消按钮文字设置;
  • 底部菜单支持菜单字号设置(dialog_menu_text_size);

v2.1.9:

  • Android Support 支持库升级到 27.1.0;

v2.1.8:

  • 修复显示标题的底部菜单情况下第一位菜单按下状态不符的 bug;

v2.1.7:

  • 优化 iOS 对话框消失时的动画,与最新版本的 iOS 保持一致;
  • 底部菜单新增标题功能;

v2.1.6:

  • 底部菜单 iOS 风格时的线条颜色优化;

v2.1.5:

  • iOS 风格对话框线条颜色优化;

v2.1.4:

  • 底部菜单 iOS 风格时的透明度优化;

v2.1.3:

  • WaitDialog 和 TipDialog 现在可以衔接了;
  • 优化 iOS 模式下对话框的透明度和模糊程度;

v2.1.2:

  • Android Support 支持库升级到 26.1.0;

v2.1.1:

  • iOS 主题的对话框、等待框以及提示框、底部菜单增加即时模糊效果;

v2.1.0:

  • 新增底部菜单(BottomMenu);
  • 新增 iOS 对话框出现、消失动画;
  • 修复一些细节 bug;

v2.0.9:

  • 序列启动对话框;

v2.0.8:

  • 修复 bug;

v2.0.7:

  • 修复 bug;

v2.0.6:

  • 修复 bug;

v2.0.5:

  • 新增通知消息在使用 Kongzue 主题时可自定义颜色;

v2.0.4:

  • 提供消息与通知功能;

v2.0.3:

  • 提供部分文字大小和颜色修改;

v2.0.2:

  • 提供 Light 和 Dark 两种黑白主题模式;

v2.0.1:

  • TipDialog 提供自定义提示图标;
  • WaitDialog 可通过 dismiss()方法关闭等待提示框;

v2.0.0:

  • 新增 v2 组件库;
Support Me
Apps
About Me
Google+: Trinea trinea
GitHub: Trinea