NCHR开发框架设计说明书.doc

NCHR开发框架
设计说明书文章标题
作者:丁建昕王星曾诚
创建日期:2005-xx12-xx15
修改日期:2005-xx12-27xx
修改次数:0
变更记录
变更日期
变更内容
变更原因
变更人
YYYY-MM-DD
目录
1. 引言 5
. 编写目的 5
. 背景 5
. 定义 5
. 参考资料 5
2. 程序系统的结构 6
. 横向来看 6
. 纵向来看 6
. 从框架开发者的角度 6
. 从应用开发者的角度 6
3. 基础结构BASEUI相关类设计说明 7
. 程序描述 7
. 功能 7
. BaseUI类 7
. 状态控制 8
. 按钮管理 9
. 动作管理 10
. 数据持久化 11
4. 快速开发模板FRAMEUI相关类设计说明 12
. 程序描述 12
. 功能 14
. 界面展现 14
. 按钮和动作管理 15
5. 按钮管理BUTTONMANAGER相关类设计说明 16
. 关键词 16
. 功能说明 16
. 按钮管理相关类 16
. 类图 17
. ButtonManager类说明 18
. AbstractBtnRgst类说明 19
. ButtonStateRegister类说明 21
. StateRegister类说明 22
6. MAINBILLCARDPANEL设计说明 23
. MainPanel父类说明 23
. MainPanel的设计意图 23
. MainPanel的方法说明 23
. MainBillCardPanel说明 26
7. MAINBILLLISTPANEL设计说明 27
1 200
引言
编写目的
详细说明UIFrame的设计思想、层次结构、类之间的关系。
适用读者为UIFrame的开发者和使用者。
背景
针对界面开发中代码结构不合理的问题提供一个解决方案及规范。
定义
UIFrame:框架名称
UI类:界面入口程序
Panel:组织存放各种控件
DataModel:保存当前状态,发送状态信息;同服务器端通讯
按钮:界面上菜单位置的按钮控件,不包括其它
动作:点击按钮时要完成的事情
观察对象及被观察对象:当被观察对象改变时,观察对象响应被观察对象的变化
状态:界面响应用户的操作会导致控件状态变化:可用、不可用、可见、不可见
注册:将功能或是数据类以参数形式告知管理类,由管理类负责调用
参考资料
程序系统的结构
横向来看
UIFrame是以UI类作为程序的入口和控制中心,结合DataModel类进行状态控制,结合ButtonManager进行按钮控制。同时以各个Panel为被控制单元,在各种动作类(Action)中进行调度。
纵向来看
UIFrame分为两个层次,以BaseUI为中心的相关类作为最上层,完成UIFrame的基本功能:状态控制,按钮管理。以FrameUI为中心的相关类继承于BaseUI,以模板形式提供额外的快速开发能力。
从框架开发者的角度
需要考虑的是如何为框架添加更多的快速开发能力,即继承BaseUI相关类,形成与FrameUI平行的各种模板类。
从应用开发者的角度
直接继承各种模板类,充分利用模板已经实现的各种功能,扩展自己的业务功能。有一点需要特别注意:严格禁止应用开发者继承BaseUI相关类。
基础结构BaseUI相关类设计说明
程序描述
BaseUI相关类组成UIFrame的基础结构,为所有其它UI相关类的父类,完成UIFrame的最基本功能。
涉及类:BaseUI、DataModel、ButtonManager、StateRegister、AbstractButtonRegister、ButtonStateRegister、StateChangeEvent
类名
描述
父类
接口
BaseUI
程序入口,负责调度所有资源,包括DataModel、ButtonManager
ToftPanel
DataModel
保存当前状态,发送状态事件;同后台通讯
ButtonManager
管理全部按钮,包括其名称、动作、状态
StateChangeLister
StateRegister
状态列表
AbstractButtonRegister
按钮列表
ButtonStateRegister
按钮对应状态列表
S