鸿蒙5.0进阶开辟:UI开辟-不依靠UI组件的全局自界说弹出框 (openCustomDial ...

瑞星  论坛元老 | 2025-3-26 04:22:07 | 显示全部楼层 | 阅读模式
打印 上一主题 下一主题

主题 1676|帖子 1676|积分 5028

 往期鸿蒙全套实战文章必看:(文中附带鸿蒙全栈学习资料)



  • 鸿蒙开辟核心知识点,看这篇文章就够了
  • 最新版!鸿蒙HarmonyOS Next应用开辟实战学习门路
  • 鸿蒙HarmonyOS NEXT开辟技能最全学习门路指南
  • 鸿蒙应用开辟实战项目,看这一篇文章就够了(部分项目附源码)

不依靠UI组件的全局自界说弹出框 (openCustomDialog)(保举)

由于CustomDialogController在使用上存在诸多限定,不支持动态创建也不支持动态刷新,在相对较复杂的应用场景中保举使用UIContext中获取到的PromptAction对象提供的openCustomDialog接口来实现自界说弹出框。
   阐明
  弹出框(openCustomDialog)存在两种入参方式创建自界说弹出框:
  

  • openCustomDialog(传参为ComponentContent形式):通过ComponentContent封装内容可以与UI界面解耦,调用更加灵活,可以满足开辟者的封装诉求。拥有更强的灵活性,弹出框样式是完全自界说的,且在弹出框打开之后可以使用updateCustomDialog方法动态更新弹出框的一些参数。
  • openCustomDialog(传builder的形式):相对于ComponentContent,builder必须要与上下文做绑定,与UI存在一定耦合。此方法有效默认的弹出框样式,适合于开辟者想要实现与体系弹窗默认风格一致的结果。
  本文先容通过入参形式为ComponentContent创建自界说弹出框,传builder形式的弹出框使用方法可参考openCustomDialog。
弹出框(openCustomDialog)可以通过配置isModal来实现模态和非模态弹窗。isModal为true时,弹出框为模态弹窗。isModal为false时,弹出框为非模态弹窗。
生命周期

弹出框提供了生命周期函数用于关照用户该弹出框的生命周期。生命周期的触发时序依次为:onWillAppear -> onDidAppear -> onWillDisappear -> onDidDisappear。
名称类型阐明onDidAppear() => void弹出框弹出时的事件回调。onDidDisappear() => void弹出框消失时的事件回调。onWillAppear() => void弹出框显示动效前的事件回调。onWillDisappear() => void弹出框退出动效前的事件回调。 自界说弹出框的打开与关闭


  • 创建ComponentContent。
    ComponentContent用于界说自界说弹出框的内容。此中,wrapBuilder(buildText)封装自界说组件,new Params(this.message)是自界说组件的入参,可以缺省,也可以传入基础数据类型。
    1. private contentNode: ComponentContent<Object> = new ComponentContent(this.ctx, wrapBuilder(buildText), new Params(this.message));
    复制代码
  • 打开自界说弹出框。
    通过调用openCustomDialog接口打开的弹出框默以为customStyle为true的弹出框,即弹出框的内容样式完全按照contentNode自界说样式显示。
    1. this.ctx.getPromptAction().openCustomDialog(this.contentNode, this.options)
    2.   .then(() => {
    3.     console.info('OpenCustomDialog complete.')
    4.   })
    5.   .catch((error: BusinessError) => {
    6.     let message = (error as BusinessError).message;
    7.     let code = (error as BusinessError).code;
    8.     console.error(`OpenCustomDialog args error code is ${code}, message is ${message}`);
    9.   })
    复制代码
  • 关闭自界说弹出框。
    由于closeCustomDialog接口必要传入待关闭弹出框对应的ComponentContent。因此,如果必要在弹出框中设置关闭方法,则可参考完备示例封装静态方法来实现。
    关闭弹出框之后若必要释放对应的ComponentContent,则必要调用ComponentContent的dispose方法。
    1. this.ctx.getPromptAction().closeCustomDialog(this.contentNode)
    2.   .then(() => {
    3.     console.info('CloseCustomDialog complete.')
    4.   })
    5.   .catch((error: BusinessError) => {
    6.     let message = (error as BusinessError).message;
    7.     let code = (error as BusinessError).code;
    8.     console.error(`CloseCustomDialog args error code is ${code}, message is ${message}`);
    9.   })
    复制代码
更新自界说弹出框的内容

ComponentContent与BuilderNode有相同的使用限定,不支持自界说组件使用@Reusable、@Link、@Provide、@Consume等装饰器,来同步弹出框弹出的页面与ComponentContent中自界说组件的状态。因此,若必要更新弹出框中自界说组件的内容可以通过ComponentContent提供的update方法来实现。
  1. this.contentNode.update(new Params('update'))
复制代码
更新自界说弹出框的属性

通过updateCustomDialog可以动态更新弹出框的属性。目前支持的属性包括alignment、offset、autoCancel、maskColor。
必要注意的是,更新属性时,未设置的属性会规复为默认值。例如,初始设置{ alignment: DialogAlignment.Top, offset: { dx: 0, dy: 50 } },更新时设置{ alignment: DialogAlignment.Bottom },则初始设置的offset: { dx: 0, dy: 50 }不会保存,会规复为默认值。
  1. this.ctx.getPromptAction().updateCustomDialog(this.contentNode, options)
  2.   .then(() => {
  3.     console.info('UpdateCustomDialog complete.')
  4.   })
  5.   .catch((error: BusinessError) => {
  6.     let message = (error as BusinessError).message;
  7.     let code = (error as BusinessError).code;
  8.     console.error(`UpdateCustomDialog args error code is ${code}, message is ${message}`);
  9.   })
复制代码
完备示例

  1. // PromptActionClass.ts
  2. import { BusinessError } from '@kit.BasicServicesKit';
  3. import { ComponentContent, window } from '@kit.ArkUI';
  4. import { UIContext } from '@ohos.arkui.UIContext';
  5. export class PromptActionClass {
  6.   static ctx: UIContext;
  7.   static contentNode: ComponentContent<Object>;
  8.   static options: Object;
  9.   static setContext(context: UIContext) {
  10.     this.ctx = context;
  11.   }
  12.   static setContentNode(node: ComponentContent<Object>) {
  13.     this.contentNode = node;
  14.   }
  15.   static setOptions(options: Object) {
  16.     this.options = options;
  17.   }
  18.   static openDialog() {
  19.     if (this.contentNode !== null) {
  20.       this.ctx.getPromptAction().openCustomDialog(this.contentNode, this.options)
  21.         .then(() => {
  22.           console.info('OpenCustomDialog complete.')
  23.         })
  24.         .catch((error: BusinessError) => {
  25.           let message = (error as BusinessError).message;
  26.           let code = (error as BusinessError).code;
  27.           console.error(`OpenCustomDialog args error code is ${code}, message is ${message}`);
  28.         })
  29.     }
  30.   }
  31.   static closeDialog() {
  32.     if (this.contentNode !== null) {
  33.       this.ctx.getPromptAction().closeCustomDialog(this.contentNode)
  34.         .then(() => {
  35.           console.info('CloseCustomDialog complete.')
  36.         })
  37.         .catch((error: BusinessError) => {
  38.           let message = (error as BusinessError).message;
  39.           let code = (error as BusinessError).code;
  40.           console.error(`CloseCustomDialog args error code is ${code}, message is ${message}`);
  41.         })
  42.     }
  43.   }
  44.   static updateDialog(options: Object) {
  45.     if (this.contentNode !== null) {
  46.       this.ctx.getPromptAction().updateCustomDialog(this.contentNode, options)
  47.         .then(() => {
  48.           console.info('UpdateCustomDialog complete.')
  49.         })
  50.         .catch((error: BusinessError) => {
  51.           let message = (error as BusinessError).message;
  52.           let code = (error as BusinessError).code;
  53.           console.error(`UpdateCustomDialog args error code is ${code}, message is ${message}`);
  54.         })
  55.     }
  56.   }
  57. }
复制代码
  1. // Index.ets
  2. import { ComponentContent } from '@kit.ArkUI';
  3. import { PromptActionClass } from './PromptActionClass';
  4. class Params {
  5.   text: string = ""
  6.   constructor(text: string) {
  7.     this.text = text;
  8.   }
  9. }
  10. @Builder
  11. function buildText(params: Params) {
  12.   Column() {
  13.     Text(params.text)
  14.       .fontSize(50)
  15.       .fontWeight(FontWeight.Bold)
  16.       .margin({ bottom: 36 })
  17.     Button('Close')
  18.       .onClick(() => {
  19.         PromptActionClass.closeDialog()
  20.       })
  21.   }.backgroundColor('#FFF0F0F0')
  22. }
  23. @Entry
  24. @Component
  25. struct Index {
  26.   @State message: string = "hello"
  27.   private ctx: UIContext = this.getUIContext();
  28.   private contentNode: ComponentContent<Object> =
  29.     new ComponentContent(this.ctx, wrapBuilder(buildText), new Params(this.message));
  30.   aboutToAppear(): void {
  31.     PromptActionClass.setContext(this.ctx);
  32.     PromptActionClass.setContentNode(this.contentNode);
  33.     PromptActionClass.setOptions({ alignment: DialogAlignment.Top, offset: { dx: 0, dy: 50 } });
  34.   }
  35.   build() {
  36.     Row() {
  37.       Column() {
  38.         Button("open dialog and update options")
  39.           .margin({ top: 50 })
  40.           .onClick(() => {
  41.             PromptActionClass.openDialog()
  42.             setTimeout(() => {
  43.               PromptActionClass.updateDialog({
  44.                 alignment: DialogAlignment.Bottom,
  45.                 offset: { dx: 0, dy: -50 }
  46.               })
  47.             }, 1500)
  48.           })
  49.         Button("open dialog and update content")
  50.           .margin({ top: 50 })
  51.           .onClick(() => {
  52.             PromptActionClass.openDialog()
  53.             setTimeout(() => {
  54.               this.contentNode.update(new Params('update'))
  55.             }, 1500)
  56.           })
  57.       }
  58.       .width('100%')
  59.       .height('100%')
  60.     }
  61.     .height('100%')
  62.   }
  63. }
复制代码


免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作!更多信息从访问主页:qidao123.com:ToB企服之家,中国第一个企服评测及商务社交产业平台。

本帖子中包含更多资源

您需要 登录 才可以下载或查看,没有账号?立即注册

x
回复

使用道具 举报

0 个回复

倒序浏览

快速回复

您需要登录后才可以回帖 登录 or 立即注册

本版积分规则

瑞星

论坛元老
这个人很懒什么都没写!
快速回复 返回顶部 返回列表