DDeiEditorUtil
DDeiEditorUtil
是DDei
在设计器运行时的一个工具类,包含了常见的全局变量、配置和公共函数。
DDeiEditorUtil
和DDeiUtil
的区别在于:DDeiEditorUtil
服务于设计器整体运行时,提供了设计器界面所需的API,而DDeiUtil
主要服务于在图形运行时。
DDeiEditorUtil
中有一部分方法需和DDeiUtil
共用,这些方法一般在DDeiEditorUtil
中定义。
钩子方法
这些方法在本类中定义并与DDeiUtil
共用。
static getEditorId
钩子函数,获取当前编辑器ID
参数
参数名 | 类型 | 范围 | 默认值 | 备注 |
---|---|---|---|---|
ddInstance | DDei | DDei实例 |
返回值
类型 | 备注 |
---|---|
string | 编辑器ID |
static getAttrValueByConfig
钩子函数,从配置定义中获取属性值,优先从code中获取,其次从mapping获取
参数
参数名 | 类型 | 范围 | 默认值 | 备注 |
---|---|---|---|---|
configModel | object | 配置模型,如果包含了attrDefineMap等数据,则直接获取数据,如果只包含id则通过id取原始数据 | ||
paths | string[] | 属性路径,支持传入多个 | ||
editor | DDeiEditor | 设计器实例 |
返回值
类型 | 备注 |
---|---|
Map | 由构成的属性的实际路径和配置中对应的值组成的Map |
static getControlDefine
钩子函数,取得控件原始定义
参数
参数名 | 类型 | 范围 | 默认值 | 备注 |
---|---|---|---|---|
configModel | DDeiAbstractShape | 控件 |
返回值
类型 | 备注 |
---|---|
object | 控件定义 |
static getSubControlJSON
钩子函数,返回控件的子控件定义,用于创建控件时自动创建子控件
参数
参数名 | 类型 | 范围 | 默认值 | 备注 |
---|---|---|---|---|
modelCode | string | 控件配置code | ||
ddInstance | DDei | DDei实例 |
返回值
类型 | 备注 |
---|---|
object | 控件定义 |
static getLineInitJSON
钩子函数,返回线控件的定义
static getMenuConfig
钩子函数,获取菜单配置,由外部调用者初始化
参数名 | 类型 | 范围 | 默认值 | 备注 |
---|---|---|---|---|
model | object | DDeiAbstractShape | ||
editor | DDeiEditor | 设计器实例 |
返回值
类型 | 备注 |
---|---|
object[] | 菜单列表 |
static getMenuControlId
钩子函数,获取菜单的控件ID,用于显示菜单,控制样式等
参数名 | 类型 | 范围 | 默认值 | 备注 |
---|---|---|---|---|
editor | DDeiEditor | 设计器实例 |
返回值
类型 | 备注 |
---|---|
string | 菜单Dom |
static showContextMenu
钩子函数,显示右键菜单等
参数名 | 类型 | 范围 | 默认值 | 备注 |
---|---|---|---|---|
control | object | 当前控件/目标对象 | ||
ddInstance | DDei | DDei实例 | ||
evt | Event | 事件对象 |
返回值
无
static getBusiData
钩子函数,获取业务数据
参数
无
返回值
类型 | 备注 |
---|---|
object | 业务数据对象 |
static invokeCallbackFunc
钩子函数,调用回调函数
参数
参数名 | 类型 | 范围 | 默认值 | 备注 |
---|---|---|---|---|
name | string | 回调函数名称 | ||
operate | DDeiEnumOperateType | string | ||
data | object | null | ||
ddInstance | DDei | DDei实例 | ||
evt | Event | 事件 |
返回值
类型 | 备注 |
---|---|
number | 1成功/-1失败 |
static notifyChange
钩子函数,通知改变
参数 无
返回值 无
static isBackActive
钩子函数,判断当前实例是否可以在后台激活,允许后台激活的实例,在当前实例为非ACTIVE_INSTANCE时,依然能够执行部分后台操作
参数
参数名 | 类型 | 范围 | 默认值 | 备注 |
---|---|---|---|---|
ddInstance | DDei | DDei实例 |
返回值
类型 | 备注 |
---|---|
boolean | 是或否 |
方法
static getEditorInsByDDei
根据DDei实例获取编辑器实例
参数
参数名 | 类型 | 范围 | 默认值 | 备注 |
---|---|---|---|---|
ddeiInstance | DDei | DDei实例 |
返回值
类型 | 备注 |
---|---|
DDeiEditor | 编辑器实例 |
static createControl
根据配置创建控件
参数
参数名 | 类型 | 范围 | 默认值 | 备注 |
---|---|---|---|---|
control | object | 控件初始化定义json | ||
editor | DDeiEditor | 设计器实例 |
返回值
类型 | 备注 |
---|---|
DDeiAbstractShape[] | 控件集合 |
static clearControlIcons
清空控件小图标
参数
参数名 | 类型 | 范围 | 默认值 | 备注 |
---|---|---|---|---|
editor | DDeiEditor | 设计器实例 |
返回值 无
static getControlIcons
生成控件小图标,生成后放入editor.icons中
参数
参数名 | 类型 | 范围 | 默认值 | 备注 |
---|---|---|---|---|
editor | DDeiEditor | 设计器实例 |
返回值 无
static showDialog
打开弹出框
参数
参数名 | 类型 | 范围 | 默认值 | 备注 |
---|---|---|---|---|
editor | DDeiEditor | 设计器实例 | ||
id | string | 弹出框ID | ||
data | object | 承载数据 | ||
data.background | string | 背景色 | ||
data.value | object | null | 当前值 | |
data.dataSource | object[] | null | 数据源 | |
data.callback | object | null | 回调函数 | |
data.group | string | null | 所属分组 | |
pos | object | 位置信息 | ||
pos.type | number | 位置类型:99自由配置/2底部/3底部居中/4顶部/5顶部居中 | ||
pos.left | number | 位置left | ||
pos.top | number | 位置top | ||
pos.dx | number | 0 | 偏移量x | |
pos.dy | number | 0 | 偏移量y | |
el | Element | 事件源 | ||
isPop | boolean | false | 是否浮动 | |
keepState | boolean | false | 是否保持设计器状态 |
返回值
无
static closeDialog
关闭弹出框
参数
参数名 | 类型 | 范围 | 默认值 | 备注 |
---|---|---|---|---|
editor | DDeiEditor | 设计器实例 | ||
id | string | 弹出框ID | ||
isPop | boolean | false | 是否浮动 |
返回值
无
static closeDialogs
关闭多个弹出框
参数
参数名 | 类型 | 范围 | 默认值 | 备注 |
---|---|---|---|---|
editor | DDeiEditor | 设计器实例 | ||
groups | string[] | 弹出框分组 | ||
isPop | boolean | false | 是否浮动 |
返回值
无
static showOrCloseDialog
打开或关闭弹出框
参数
参数名 | 类型 | 范围 | 默认值 | 备注 |
---|---|---|---|---|
editor | DDeiEditor | 设计器实例 | ||
id | string | 弹出框ID | ||
data | object | 承载数据 | ||
data.background | string | 背景色 | ||
data.value | object | null | 当前值 | |
data.dataSource | object[] | null | 数据源 | |
data.callback | object | null | 回调函数 | |
data.group | string | null | 所属分组 | |
pos | object | 位置信息 | ||
pos.type | number | 位置类型:99自由配置/2底部/3底部居中/4顶部/5顶部居中 | ||
pos.left | number | 位置left | ||
pos.top | number | 位置top | ||
pos.dx | number | 0 | 偏移量x | |
pos.dy | number | 0 | 偏移量y | |
el | Element | 事件源 | ||
isPop | boolean | false | 是否浮动 | |
keepState | boolean | false | 是否保持设计器状态 |
返回值
无
static displayDialog
显示弹出框
参数
参数名 | 类型 | 范围 | 默认值 | 备注 |
---|---|---|---|---|
editor | DDeiEditor | 设计器实例 | ||
id | string | 弹出框ID | ||
data | object | 承载数据 | ||
data.background | string | 背景色 | ||
data.value | object | null | 当前值 | |
data.dataSource | object[] | null | 数据源 | |
data.callback | object | null | 回调函数 | |
data.group | string | null | 所属分组 | |
pos | object | 位置信息 | ||
pos.type | number | 位置类型:99自由配置/2底部/3底部居中/4顶部/5顶部居中 | ||
pos.left | number | 位置left | ||
pos.top | number | 位置top | ||
pos.dx | number | 0 | 偏移量x | |
pos.dy | number | 0 | 偏移量y | |
el | Element | 事件源 | ||
isPop | boolean | false | 是否浮动 |
返回值
无
static hiddenDialog
隐藏弹出框
参数
参数名 | 类型 | 范围 | 默认值 | 备注 |
---|---|---|---|---|
editor | DDeiEditor | 设计器实例 | ||
id | string | 弹出框ID |
返回值
无