https://github.com/javakam/dialogmanager
快速创建 Dialog和DialogFragment 的轻量级框架, 解决了Dialog的部分显示问题和兼容问题。
https://github.com/javakam/dialogmanager
android dialog dialogfragment dialogmanager
Last synced: about 1 month ago
JSON representation
快速创建 Dialog和DialogFragment 的轻量级框架, 解决了Dialog的部分显示问题和兼容问题。
- Host: GitHub
- URL: https://github.com/javakam/dialogmanager
- Owner: javakam
- Created: 2021-01-04T09:00:51.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-12-26T06:24:36.000Z (over 1 year ago)
- Last Synced: 2025-03-25T15:04:28.336Z (about 2 months ago)
- Topics: android, dialog, dialogfragment, dialogmanager
- Language: Kotlin
- Homepage:
- Size: 3.95 MB
- Stars: 21
- Watchers: 1
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
> **Ando 项目汇总**👉
# DialogManager
- [**GitHub**](https://github.com/javakam/DialogManager)👉
- [**Blog**](https://juejin.cn/post/6916791502161051656/)
👉
## 一、预览(Preview)
## 二、导入(Import)
🍎🍎🍎 很轻量的框架, 可根据不同的需求, 选取不同的导入方式:
1. 基于`Dialog/DialogFragment`实现, 主要包括`Dialog`开发过程中的基本用法并处理了一些常见的问题。
```groovy
implementation 'com.github.javakam:dialog.core:7.6.0@aar' //核心库, 2个类
implementation 'com.github.javakam:dialog.usage:7.6.0@aar' //常用样式(如: 加载中弹窗)
```
2. 基于`BottomSheetDialogFragment`, 包括网格弹窗, 可用于第三方分享, 支持标题、顶部圆角和滑动设置; 列表样式弹窗, 支持单选和多选。
> 支持单选/多选的RecyclerView框架'com.github.javakam:widget.optionview:xxx@aar'可以独立使用, 可依附于任何`ViewGroup`。
```groovy
implementation 'com.github.javakam:dialog.bottomsheet:7.6.0@aar' //底部弹窗(必需下面的 widget.optionview 框架)
implementation 'com.github.javakam:widget.optionview:7.6.0@aar' //单选/多选的RecyclerView,基于EasyAdapter实现
```
## 三、用法(Usage)
```kotlin
//1. 创建并显示弹窗
fun showLoadingDialog() {//以加载中弹窗为例
DialogManager.with(this, R.style.AndoLoadingDialog)//建议设置主题样式(It is recommended to set the theme style)
.useDialogFragment()//默认为`DialogFragment`实现, useDialog()表示由`Dialog`实现
.setContentView(R.layout.layout_ando_dialog_loading) { v -> //设置显示布局 (Set display layout)
v.findViewById(R.id.progressbar_ando_dialog_loading).visibility = View.VISIBLE
}
.setTitle("Title")//Need Config `false`
.setWidth(200)//设置宽
.setHeight(200)//设置高
.setSize(200, 200)//设置宽高(Set width and height)
.setAnimationId(R.style.AndoBottomDialogAnimation)//设置动画(Set up animation)
.setCancelable(true)
.setCanceledOnTouchOutside(true)
.setDimAmount(0.7F) //设置背景透明度, 0 ~ 1 之间,0为透明,1为不透明. 只要该值不是 -1, 就会应用该值
.setDimmedBehind(false) //设置背景透明, false透明, true不透明
.addOnGlobalLayoutListener { width, height -> }//获取显示后的真实宽高
.setOnCancelListener {} //取消监听
.setOnDismissListener {}//关闭监听
.setOnKeyListener { dialog, keyCode, event -> true }//按键监听
.setOnShowListener {}//显示监听
.apply {
//显示之前配置,如:
//Display the previous configuration, such as:
//dialog?.window?.requestFeature(Window.FEATURE_NO_TITLE)
}
.show()
.apply {
//显示之后配置, 效果和`setOnShowListener`相同
//Configure after display, the effect is the same as `setOnShowListener`
}
//Dialog是否正在显示
//Whether Dialog is showing
DialogManager.isShowing()
//Dialog显示后动态改变展示效果
//The Dialog display dynamically changes the display effect
findViewById(R.id.bt_loading_progressbar_imageview).postDelayed({
//实用性用法, 动态改变窗口文本: "加载中" -> "已完成"
DialogManager.contentView?.findViewById(R.id.xxx)?.text = "已完成"
//实用性用法, 动态改变转圈儿图片
DialogManager.contentView?.findViewById(R.id.xxx)?.visibility = View.GONE
val image: ImageView? = DialogManager.contentView?.findViewById(R.id.xxx)
image?.visibility = View.VISIBLE
val anim = AnimationUtils.loadAnimation(this, ando.dialog.usage.R.anim.anim_ando_dialog_loading)
image?.startAnimation(anim)
//改变弹窗宽高(Change the width and height of the dialog)
DialogManager.setWidth(280)
DialogManager.setHeight(280)
DialogManager.applySize()
//控制背景亮度(Control background brightness)
DialogManager.setDimAmount(0.3F)
DialogManager.applyDimAmount()
//or 直接移除背景变暗(Directly remove the background darkening)
//DialogManager.dialog?.window?.clearFlags(WindowManager.LayoutParams.FLAG_DIM_BEHIND)
}, 6000)
}
2. 关闭弹窗
override fun onDestroy() {
super.onDestroy()
DialogManager.dismiss()
}
```
- 同时支持`Dialog`和`DialogFragment`(Support both `Dialog` and `Dialog Fragment`):
```kotlin
Dialog: useDialog(); DialogFragment: useDialogFragment()
```
- 控制背景变暗(Control the darkening of the background)
```kotlin
Window.addFlags / clearFlags(WindowManager.LayoutParams.FLAG_DIM_BEHIND)
```
## 四、`Dialog.Window Setting`
### 1. `show()`之前设置(Set before `Dialog.show`)
```kotlin
Dialog / Window.requestWindowFeature(Window.FEATURE_LEFT_ICON)
```
### 2. `show()`之后设置(Set after `Dialog.show`)
- `Window`相关属性(`WindowManager.LayoutParams`), 如动态改变`Dialog`的位置、宽高、动画、背景等
- `setFeatureXXX` 相关方法,
如: `setFeatureDrawable/setFeatureDrawableResource/setFeatureDrawableUri/setFeatureDrawableAlpha`
- `setFeatureXXX` 方法必须在`Dialog.show`之前设置`requestWindowFeature`才能生效,
否则出现BUG:java.lang.RuntimeException: The feature has not been requested
- 🍎 通常在`show`执行后或者`setOnShowListener`中设置`window`属性
```kotlin
setOnShowListener {
//对`Window`的设置需要在`Dialog`显示后才有效果
//The setting of `Window` needs to be effective after `Dialog` is displayed
val attributes = DialogManager.getDialog().window?.attributes
attributes?.apply {
width = 800
height = 500
gravity = Gravity.CENTER //居中显示 (Center display)
dimAmount = 0.5f //背景透明度 (Background transparency) 0 ~ 1
}
DialogManager.getDialog().window?.attributes = attributes
}
```
## 五、`Dialog`设置动画(`Dialog` set animation)
### 1. 准备配置文件(Prepare configuration file)
`anim_ando_dialog_bottom_in.xml`
```xml
```
`anim_ando_dialog_bottom_out.xml`
```xml
```
`styles.xml`
```xml
<item name="android:windowEnterAnimation">@anim/anim_ando_dialog_bottom_in</item>
<item name="android:windowExitAnimation">@anim/anim_ando_dialog_bottom_out</item>
```
### 2. 设置动画(Set animation)
```kotlin
Dialog.window.setWindowAnimations(R.style.AndoBottomDialogAnimation)
```
> 注意: `Dialog`设置动画在`new BottomDialog(context, R.style.AndoBottomDialogAnimation)`时设置是无效的, 必须在`show`
> 之后再对`Window`
> 设置动画(`setWindowAnimations`)才能生效。经实际测试发现 API 5.0~11都是如此。
## 六、`Dialog`设置圆角(`Dialog` set rounded corners)
> 在`Dialog`的`setContentView`之后(即`show`之后)
> 设置`window.setBackgroundDrawableResource(R.drawable.rectangle_ando_dialog_bottom)`
`rectangle_ando_dialog_bottom.xml`
```xml
```
就是给`Window`加上个`background`, 详见👉[Dialog 圆角问题](https://juejin.cn/post/6915323090620645389)
## 七、`Dialog`设置宽高(`Dialog` set width and height)
> 要在`setContentView`外包一层`FrameLayout`防止宽高设置无效问题
🍎 `LoadingDialog`样式的弹窗提供了两种实现方案,一种是`animated-rotate`/`rotate`
直接配置动画方式,另一种是`android.view.animation.AnimationUtils`;
其中的布局文件需要包一层`FragmeLayout`
```xml
...
```
> `Dialog`的`setContentView(layoutId)`和`setContentView(view)`是不一样的, 如果使用的是`layoutId:Int`
> 则不需要外面套一层`FrameLayout`,
> 但如果是用的`view:View`, 则必须在自定义布局的最外层在套一层其它布局,如`FrameLayout`
> 。前者用的是`LayoutInflater.inflate(layoutId,mContentParent,true)`
> 而后者用的是`mContentParent.addView(view)`即`LayoutInflater.inflate(view,null,false)` . 我们看下`inflate`方法的特性:
### inflate(view, null);/inflate(resource, null, true/false);
只创建`view`，`view`没有`LayoutParams`值，然后直接返回`view`
布局中最外层的`layout_width`、`layout_height`将失效
### inflate(resource, mContentParent);/inflate(resource, root, true);
创建`view`, 然后执行`mContentParent.addView(view, params)`, 最后返回`mContentParent`
> 综上所述, `Dialog`宽高无效问题, 本质上就是`LayoutInflater.inflate`不同方法之间差异的问题.
> 其中的`mContentParent:ViewGroup`由`PhoneWindow.installDecor()`创建. 详见: `PhoneWindow.setContentView`
### `DialogManager`中已处理该问题(This issue has been dealt with in `Dialog Manager`)
```kotlin
fun setContentView(
layoutId: Int,
block: ((Dialog?, View) -> Unit)? = null
): DialogManager {
FrameLayout(mContext ?: return this).apply {
layoutParams = ViewGroup.LayoutParams(
ViewGroup.LayoutParams.MATCH_PARENT,
ViewGroup.LayoutParams.MATCH_PARENT
)
contentView = LayoutInflater.from(mContext).inflate(layoutId, this, true)
...
}
return this
}
```
## 八、总结(Summary)
1. DialogFragment源码中加载视图用的是 Dialog.setContentView(View)
2. 如果要改变`Window`属性, 可以在`onStart`中处理。因为`DialogFragment.onStart`中执行了`Dialog.show()`
## 九、感谢(Thanks)
`Android源码在线阅读`
`Android Dialog - Rounded Corners and Transparency`
`LayoutInflater的正确使用姿势`
`LayoutInflater中inflate方法的区别`
## 十、遇到的BUG(BUG encountered)
- java.lang.RuntimeException: The feature has not been requested
Fixed: `see above`
- android.util.AndroidRuntimeException: requestFeature() must be called before adding content
Fixed: `setContentView(...)`之前设置即可
- `java.lang.IllegalStateException: Fragment xxx not associated with a fragment manager.`
- `java.lang.IllegalArgumentException: View not attached to window manager`
Fixed:
- WindowManager: android.view.WindowLeaked: Activity ando.dialog.sample.MainActivity
has leaked window DecorView@54f9439[MainActivity] that was originally added here
如果只是处理`Dialog`在`Acticity.onConfigurationChanged`出现的问题
EN: If you just deal with the problem of `Dialog` in `Activity.onConfigurationChanged`
```kotlin
//若`AndroidManifest.xml`中已经配置了`android:configChanges="orientation|screenSize|screenLayout|smallestScreenSize"`则不需要设置该项
Acticity / Context.registerComponentCallbacks(object : ComponentCallbacks {
override fun onConfigurationChanged(newConfig: Configuration) {
dialog?.dismiss()
}
override fun onLowMemory() {
}
})
```
在`onDestroy`中也加上销毁
```kotlin
override fun onDestroy() {
super.onDestroy()
DialogManager.dismiss()
}
```
- java.lang.IllegalStateException: This ViewTreeObserver is not alive, call getViewTreeObserver() again
Fixed:
```kotlin
fun addOnGlobalLayoutListener(onGlobalLayout: (width: Int, height: Int) -> Unit): DialogManager {
contentView?.viewTreeObserver?.addOnGlobalLayoutListener(object :
ViewTreeObserver.OnGlobalLayoutListener {
override fun onGlobalLayout() {
contentView?.viewTreeObserver?.removeOnGlobalLayoutListener(this)
onGlobalLayout.invoke(contentView?.width ?: 0, contentView?.height ?: 0)
}
})
return this
}
```