Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IFormPageHolder

弹出页面的Page对象保留占位接口 代码编辑器内类似components.table1 无下拉代码提示,但是components.table1是可以生效

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

$elemt

$elemt: JQuery<HTMLElement>

组件的最外层的jquery对象 注意: 如果在运行时操作该对象会造成不可预知的错误. 谨慎!!!

$parentElem

$parentElem: JQuery<HTMLElement>

装设计界器的页面div jquery

Protected __cxt

__cxt: ScriptContext = null

页面的上下文

__isUrlParam

__isUrlParam: boolean

是否使用当前url上的参数作为页面参数(默认true)

__pageId

__pageId: string

这个id主要用于弹出最顶层的页面时候用于消息传递的唯一标志.一般情况是空的.

__resid

__resid: string

页面所属的资源id(与权限相关)

_oldJson

_oldJson: string

临时组件的json字符串, 用于校验关闭时是否有修改

_scripts

_scripts: {} = ...

设计模式下私有变量 保存当前已经存在的事件

Type declaration

  • [x: string]: { attr?: string; editor?: AttributeEditorBase; name?: string; value?: string }[]

actions

actions: {}

各个功能的action数组, 比如 复制,粘贴,剪切.....

Type declaration

active

active: boolean

设计模式下 焦点状态

background

background: string

组件背景

canChildComponentsDrag

canChildComponentsDrag: boolean

设计模式下是否允许拖拽子组件 默认: true 注意:这个是子组件不能拖了,不能接受外部拖进来的元素

canChildComponentsDragPull

canChildComponentsDragPull: boolean

设计模式下是否可以拖拽子组件到外部 默认: true

canChildComponentsDragPut

canChildComponentsDragPut: boolean

设计模式下是否可以在接受外部拖拽进来的组件 默认: true

canChildComponentsDragSort

canChildComponentsDragSort: boolean

设计模式下是否允许子组件拖拽排序 默认: true 注意:子组件选都选不到焦点但是能接受外部拖进来的元素 与 disabled差异

canChildFocus

canChildFocus: boolean

设计模式下子元素是否允许点击获取焦点包含tab按键

canCopy

canCopy: boolean

设计模式下是否允许拷贝

canCut

canCut: boolean

设计模式下是否允许剪切

canDelete

canDelete: boolean

组件设计模式下是否允许删除

canDesignModePointEvents

canDesignModePointEvents: boolean

是否允许设计模式下点击组件内部 运行模式下无效

canFocuse

canFocuse: boolean

设计模式下是否允许获取焦点

canMenu

canMenu: boolean

设计模式下是否右键选择组件时候弹出的菜单

canPaste

canPaste: boolean

设计模式下是否允许粘贴

childComponentDragFilterSelector

childComponentDragFilterSelector: string

禁止子组件的拖拽过滤字符串

childComponentDragSelector

childComponentDragSelector: string

允许子组件的拖拽过滤字符串

components

components: IDesignerPageComponentsHolder

代码编辑器内类似components.table1 无下拉代码提示,但是components.table1是可以生效

css

css: DesignerPageBaseStyle

记录组件样式类型

cssString

cssString: string

自定义样式

cursor

cursor: Cursor

鼠标的图标

Protected dependencies

dependencies: IDependency[] = ...

designPopMenu

designPopMenu: Contextmenu

设计模式下的右键弹出菜单

detailPage

detailPage: string

详情页面的ID

device

device: DeviceType

显示设备 默认: DeviceType.pc

dock

dock: DockType

组件停靠方式 当设置了dock full 后 height,width 将会失效

dragFilter

dragFilter: string

设计模式下不可以拖拽的jquery 类名

draggableClass

draggableClass: string

设计模式下可以拖拽的组件

draggableCompnent

draggableCompnent: any

设计模式下可以拖拽组件类

draggableInheritCompnent

draggableInheritCompnent: any

设计模式下可以拖拽的继承的父组件类

draggablextype

draggablextype: any

设计模式下可以拖拽组件xtype

editState

editState: PageEditState

编辑状态 新增页面和修改时候才有效.

enable

enable: boolean

是否可用 是否可以有焦点,事件 等等

eventsSuspended

eventsSuspended: boolean

是否事件暂停 一般是数据源初始化时候停止事件.

font

font: Font

组件字体

formulas

formulas: object

页面的公式集合 设计时候保存了公式源码,预览时候保存了公式计算以后的值,用于替换属性的值

height

height: string | number

组件的高度

hide

hide: boolean

组件隐藏/显示 true 隐藏 ,则反之

hitTitle

hitTitle: string

鼠标停留时候提示信息

Readonly id

id: string

组件的id

isClickStopEvent

isClickStopEvent: boolean

是否允许击的消息传递 默认是true. 如果要自己处理组件的内部点击事件可以设置成false

isDropCreate

isDropCreate: boolean

设计模式下是否拖拽释放时候创建的组件 有些组件需要区分这个,来增加默认值

isPost

isPost: boolean

界面是否提交

isRightRes

isRightRes: boolean

是否权限资源 true可以在用户权限内看到改资源的控制,false 则看不到资源

isStatic

isStatic: boolean

静态渲染

isbigscreen

isbigscreen: boolean

开启大屏 如果页面是用于大屏则开启这个开关

items

items: ComponentBase[]

子组件数组包含可视组件 (页面渲染时候会按顺序渲染这个数组) 如果需要自定义组件渲染的子组件的顺序 @see doRenderChilds

margin

margin: string

组件间隔

modelCode

modelCode: string

模型的编号

modelId

modelId: string

页面模型的唯一id

modelName

modelName: string

模型的名称一般是服务端处理后返回 移动端的页面默认标题

name

name: string

组件名称

onCanCloseScript

onCanCloseScript: string

关闭事件

onLoadScript

onLoadScript: string

页面加载完成事件函数代码

params

params: IParam[]

参数 用于存储外面传递到页面参数

parentCmp

parentCmp: ComponentBase

父组件

parentPage

parentPage: DesignerPageBase

父页面. 一般用于移动端的SPA页面打开时候此值才会有值.

resRights

resRights: object[]

资源权限的数组,只要在请求时候带上resid参数后台会填充该参数数组.如果未登陆传递此参数会出现"未登陆异常"

rightTitle

rightTitle: string

权限资源的标题

rights

rights: object = ...

存储页面的公式控制的权限对象

rootId

rootId: string

静态渲染的id

tag

tag: any

组件的可附带一些标志的 用于附带一下参数

Readonly version

version: string = ...

页面的版本号

width

width: string | number

组件的宽度

Readonly xtype

xtype: string

组件的唯一类型标志(这个是不能重复的哦)

Static ON_PAGE_CANCLOSE_EVENT

ON_PAGE_CANCLOSE_EVENT: string = 'onPageCanClose'

Static ON_PAGE_CLOSE_EVENT

ON_PAGE_CLOSE_EVENT: string = 'onPageClose'

Static ON_PAGE_LOAD_EVENT

ON_PAGE_LOAD_EVENT: string = 'onPageLoad'

Methods

addCmpDeclare

Protected addDependencies

addEvents

  • addEvents(...args: any[]): void

  • 注册事件绑定的

    Parameters

    • Rest ...args: any[]

      事件唯一标志字符串

    Returns void

addFormula

  • addFormula(cmpId: string, attrName: string, value: string): void

  • 添加属性公式

    Parameters

    • cmpId: string

      组件id

    • attrName: string

      属性名

    • value: string

      值

    Returns void

appendChildCmp

  • 在组件数组后面增加子组件 这里只是组件的实例增加，页面并没重画

    Parameters

    Returns void

appendChildHtmlElemt

  • 把子组件的html元素$elemt添加到自己的children里面; 一些子组件需要定义在父组件的特定的位置不一定要是父组件的一级子元素 子类可以自定实现自定义的添加子组件的实现方式.

    Parameters

    Returns void

borcast

  • borcast(msg: string, param?: any): void

  • 给子组件广播发送消息

    Parameters

    • msg: string

      消息

    • Optional param: any

      跟随消息传递的参数

    Returns void

broadcast

checkCanDragMove

checkDragAccept

clear

  • clear(): void

  • 设计模式 清空所有的组件

    Returns void

clearAllEvents

  • clearAllEvents(): void

  • 清除所有已经注册的事件处理 注意:该函数一般是页面关闭时候才调用 防止重复调用.如果是运行中调用会导致未知的异常错误

    Returns void

close

  • close(forceDestory?: boolean): void

  • 关闭页面窗口

    Parameters

    • forceDestory: boolean = false

      强制关闭,并清理事件;避免事件重复;避免管时候出现"数据已经更改"的提示 默认false

    Returns void

copy

  • copy(): void

  • 设计模式下复制组件 子类可以覆盖此方法来实现自定义复制

    Returns void

cut

  • cut(): void

  • 设计模式下剪切组件 子类可以覆盖此方法来实现自定义剪切

    Returns void

deserialize

  • deserialize(jsonStr: string): any

  • 反序列化

    Parameters

    • jsonStr: string

      json字符串

    Returns any

    返回组件对象

designActionsShortCut

  • designActionsShortCut(): void

destory

  • destory(): void

  • 释放资源析构函数.组件移除之前会调用 一般不要主动调用. 该函数并没有删除和释放组件.只是调用了组件的资源释放函数

    Returns void

disableEdit

  • disableEdit(): void

  • 禁止页面内的所有点击和隐藏不可见组件 一般用于某些设计情况,比如PageQuote在设计时候引用了界面不允许选择内部的组件

    Returns void

Protected doCanChildComponentsDragPut

  • doCanChildComponentsDragPut(): boolean

  • 设计模式下允许拖入的组件类名正则表达式 子类可以通过覆盖这个函数实现自定义下拉的弹出菜单

    reutns

    true 时候可以运行任何组件,则反之只允许匹配到的.

    Returns boolean

Protected doCanDragSort

  • doCanDragSort(): boolean

Protected doDesigningDbClick

  • doDesigningDbClick(): void

  • 设计模式下双击组件时候触发的函数调用.

    Returns void

Protected doDestory

  • doDestory(): void

Protected doDragEnd

  • doDragEnd(e: any): void

  • 组件结束拖拽事件 子类可以覆盖此方法实现自定义拖拽时的规则

    Parameters

    • e: any

      拖拽事件对象

    Returns void

Protected doDragPull

  • doDragPull(to: any, from: any, dragEl: any, event: any): boolean

  • 用来进行拖出元素的函数判断，可以进行复杂逻辑，在函数中 子类可以覆盖此方法来自定义是否可以在拖拽时移出组件

    Parameters

    • to: any

      目标

    • from: any

      源

    • dragEl: any

      拖拽的对象

    • event: any

    Returns boolean

    false/true来判断是否可以移出；

Protected doDragPut

  • doDragPut(to: any, from: any, dragEl: any, event: any): boolean

  • 用来定义是否可以往组件放置，true/false 子类可以覆盖此方法来自定义是否可以在拖拽时移入组件

    Parameters

    • to: any

      目标组件

    • from: any

      源组件

    • dragEl: any

      拖拽的对象

    • event: any

    Returns boolean

    false/true来判断是否可以移入；

Protected doDragStart

  • doDragStart(e: any): void

  • 组件开始拖拽的时候事件 子类可以覆盖此方法实现自定义拖拽时的规则

    Parameters

    • e: any

    Returns void

Protected doF1Help

  • doF1Help(): void

  • 设计模式下按f1干的事情

    Returns void

doGetClassName

  • doGetClassName(): string

doGetCss

  • doGetCss(): DesignerPageBaseStyle

  • Returns DesignerPageBaseStyle

Protected doGetCustomDesignerMenuItems

  • doGetCustomDesignerMenuItems(): IMenuItem[]

  • 自定义设计模式下拉的弹出菜单 子类可以通过覆盖这个函数实现自定义下拉的弹出菜单

    reutns

    返回自定义的菜单数组

    Returns IMenuItem[]

Protected doGetDefalutDesignerMenuItems

  • doGetDefalutDesignerMenuItems(): IMenuItem[]

Protected doGetElemtHtml

  • doGetElemtHtml(): string

  • 返回组件的html的字符串.

    子类覆盖改方法用于扩展组件的构建html字符串 该函数返回值会被getElemtHtml外包一层div

    Returns string

    返回htm的字符串.用户渲染

Protected doInitCompnentEvent

  • doInitCompnentEvent(): void

Protected doInitParams

  • doInitParams(): void

  • 初始化页面的请求的参数到page内

    Returns void

Protected doInsertChildCmp

  • doInsertChildCmp(childCmp: ComponentBase, index?: number): void

Protected doInsertChildCmpAfter

Protected doMobileClose

  • doMobileClose(): void

Protected doOnDragMove

  • doOnDragMove(e: any, originalEvent: Event): boolean | 1 | -1

  • 组件拖拽时的事件

    Parameters

    • e: any
    • originalEvent: Event

    Returns boolean | 1 | -1

Protected doOnElemtClick

  • doOnElemtClick(e: any): void

  • 处理点击函数 子类可以覆盖该函数实现自定义点击处理过程

    Parameters

    • e: any

    Returns void

Protected doReSize

  • doReSize(): void

  • 重新排列位置,大小

    Returns void

Protected doReSizeChilds

  • doReSizeChilds(): void

  • 重新设置子组件的的大小,位置等.... 注意与 update的区别, 这个只是重新设置每个组件的位置和大小并没用删除html元素然后重建. 子类可覆盖自定义

    Returns void

Protected doRemove

  • doRemove(isMove?: boolean): void

  • 移除自己 by gk 子类可以覆盖此方法来实现自定义移除

    Parameters

    • isMove: boolean = false

      可选参数 默认true 是否是组件移动时候的场景(这个时候无需设置最近的组件获取焦点)

    Returns void

Protected doRemoveChildComponent

  • doRemoveChildComponent(child: ComponentBase, isDestory?: boolean): void

  • 直接在子组件数组删除子组件

    Parameters

    • child: ComponentBase

      子组件

    • isDestory: boolean = false

      可选参数; 是否要释放资源,默认 false;

    Returns void

Protected doRenderBackground

  • doRenderBackground(): void

  • 渲染组件的背景颜色 子类可以通过覆盖这个函数实现自定义的背景颜色

    Returns void

Protected doRenderCanDesigChildFocus

  • doRenderCanDesigChildFocus(): void

Protected doRenderChilds

  • doRenderChilds(): void

  • 渲染子组件 子类可以自定实现自定义渲染的方式,顺序等...

    Returns void

Protected doRenderCursor

  • doRenderCursor(): void

  • 渲染组件的鼠标 子类可以通过覆盖这个函数实现自定义的背景颜色

    Returns void

Protected doRenderDevice

  • doRenderDevice(): void

doRenderDrogAnchor

  • doRenderDrogAnchor(): void

Protected doRenderElemt

  • doRenderElemt(): void

  • 给一次机会重新渲染$elemt,一般用于vue 组件集成时候重新渲染dom vue组件可以可覆盖此函数来渲染dom

    Returns void

Protected doRenderEnable

  • doRenderEnable(): void

  • 渲染用于属性 子类自己继承覆盖实现

    Returns void

Protected doRenderFocuse

  • doRenderFocuse(): void

  • 渲染出焦点的边框 by gk 子类可以覆盖此方法来自定义焦点

    Returns void

Protected doRenderFont

  • doRenderFont(): void

  • 渲染组件的字体样式 子类可以通过覆盖这个函数实现件的字体

    Returns void

Protected doRenderHide

  • doRenderHide(): void

  • 渲染组件UI的是否可视 子类可以通过覆盖这个函数实现自定义的隐藏/显示

    Returns void

Protected doRenderHitTitle

  • doRenderHitTitle(): void

Protected doRenderMargin

  • doRenderMargin(): void

  • 渲染组件的间隔距离 子类可以通过覆盖这个函数实现件的间隔

    Returns void

Protected doRenderPointerEvents

  • doRenderPointerEvents(): void

doUpdate

  • doUpdate(): void

  • 刷新组件/重画组件 子孙组件都重画

    Returns void

eachChild

eachChildEx

  • eachChildEx(eachCallback: (cmp: ComponentBase) => any, onlyChild?: boolean): void

  • 遍历所有子子孙组件 如果要中断循环返回 false

    Parameters

    Returns void

Protected excludeAttr

extistComponent

  • extistComponent(childCmp: any): boolean

  • 判断是否存在组件

    Parameters

    • childCmp: any

      需要判断存在的组件

    Returns boolean

    成功就返回true,否则返回false

findChildComponentById

findChildComponentByName

findChildComponents

  • findChildComponents<T>(callback: (item: ComponentBase) => Boolean): T[]

  • 通过一个回调函数的放回值来查找组件实例

    Type parameters

    • T

    Parameters

    • callback: (item: ComponentBase) => Boolean

      遍历整个函数组件树的回调,返回true时候符合条件,否则

    Returns T[]

    返回找到的找到的组件

findComponentById

  • 通过组件id来获取子子孙孙组件

    Parameters

    • cmpId: string

      组件Id

    Returns ComponentBase

    成功返回组件实例，否则返回undefine

findComponentByName

  • 通过组件name来获取子子孙孙组件

    Parameters

    • cmpName: string

      组件name

    Returns ComponentBase

    成功返回组件实例，否则返回undefine

findComponents

  • 通过组件的类来获取组件实例

    Type parameters

    • T

    Parameters

    Returns T[]

    返回找到的找到的组件数组

getAttrEditors

getAttrsByClassName

  • 获取组件的属性编辑器数组

    Parameters

    • clazz: any

      组件的类 (注意:这里必须是类,不能是组件的实例.)

    Returns AttributeEditorBase[]

    返回组件的属性编辑器数组

getChildComponentByType

  • getChildComponentByType<T>(classDef: any): T

  • 通过组件的类来获取子孙组件实例

    Type parameters

    • T

    Parameters

    • classDef: any

      需要查找的子孙组件的类

    Returns T

    返回找到的找到的组件

getChildComponentsByType

  • getChildComponentsByType<T>(classDef: any): T[]

  • 通过组件的类来获取子孙组件实例数组

    Type parameters

    • T

    Parameters

    • classDef: any

      需要查找的子孙组件的类

    Returns T[]

    返回组件实例数组

getComponentByType

  • getComponentByType<T>(parent: any, classDef: any): T

  • 通过组件的类来获取组件实例

    Type parameters

    • T

    Parameters

    • parent: any

      父组件

    • classDef: any

      需要查找的子组件的类

    Returns T

    返回找到的第一个组件

getComponentsByType

  • getComponentsByType<T>(parent: any, classDef: any): T[]

  • 通过子孙组件的类来获取子孙组件实例

    Type parameters

    • T

    Parameters

    • parent: any

      父组件

    • classDef: any

      需要查找的子孙组件的类定义

    Returns T[]

    返回找到的找到的组件数组

getCustomDesignerMenuItems

getCxt

  • 得到页面的上下文 注意:运行中不提倡修改上下文内的属性值. 平台框架会维护上下文对象

    Returns ScriptContext

    上下对象

getDefalutDesignerMenuItems

getDesignModel

  • getDesignModel(): boolean

  • 获取设计模式： true:设计模式 否则:运行模式

    Returns boolean

    返回 true设计模式 则反之

getDesignPopMenu

  • 获取设计模式下的弹出下拉菜单

    Returns Contextmenu

    设计模式下返回菜单实例 ,则返回null

getDesigningFocused

getElemt

  • getElemt(): JQuery<HTMLElement>

  • 组件的最外层的jquery对象

    Returns JQuery<HTMLElement>

    返回组件的 jquery对象

getElemtHtml

  • getElemtHtml(): string

  • 返回组件的html的字符串.

    Returns string

    返回htm的字符串.用户渲染

getFieldValues

  • getFieldValues(): {}

  • 得到form的内的所有组件的值

    Returns {}

getFocuse

  • getFocuse(): boolean

  • 判断组件是否拥有焦点

    Returns boolean

    返回组件是否有焦点

Protected getFocuseElemt

  • getFocuseElemt(): JQuery<HTMLElement>

  • 设置组件的获取焦点元素

    Returns JQuery<HTMLElement>

getFormula

  • getFormula(cmpId: string, attrName: string): any

  • 获取组件的属性公式

    Parameters

    • cmpId: string

      组件id

    • attrName: string

      属性名

    Returns any

getId

  • getId(): string

  • 获取组件的全球唯一id

    Returns string

    返回组件的全球唯一id字符串

getIndex

  • getIndex(): number

  • 获取组件的位置索引

    Returns number

    返回组件的位置索引,不存在父亲返回 -1

getMenuId

  • getMenuId(): string

  • 获取页面对象关联的菜单ID (资源id) 注意page对象实例会先在内部找资源ID,内部为空时候然后再找最顶层的iframe,然后url的参数. resid 与 menuid是一个东西

    Returns string

    菜单ID (资源id)字符串

getName

  • getName(): string

  • 获取组件的名称

    Returns string

    组件的名称字符串

getNameString

  • getNameString(): string

  • 获取字符串 子类可以通过覆盖这个函数来自定义 主要用于设计模式,那些需要在组件树显示自定义的组件名称

    Returns string

getNext

  • 得到下一个兄弟(弟弟)组件

    Returns ComponentBase

    存在返回组件实例,否则返回null

getPage

getParamByName

  • getParamByName(paramName: string): IParam

  • 通过参数名获取参数实例

    Parameters

    • paramName: string

      参数名

    Returns IParam

    返回参数实例.

getParamObj

  • getParamObj(): object

  • 得到页面的参数对象 访问Param对象的例子： Common.msg(cmp.getPage().getParamObj().paramName)

    Returns object

    返回页面参数对象

getParamValue

  • getParamValue(paramName: string): any

  • 得到页面参数的值

    Parameters

    • paramName: string

      参数名

    Returns any

    返回参数的值.不存在参数返回undefine

getParams

  • 获取页面的参数数组

    Returns IParam[]

    返回页面参数数组

getParent

getPrev

  • 得到前一个兄弟(哥哥)组件

    Returns ComponentBase

    存在返回组件实例,否则返回null

getSerializePropertys

  • getSerializePropertys(): {}

getTempParamObj

  • getTempParamObj(): object

  • 获取设置临时参数变量

    Returns object

    返回通过setTempParamObj设置的参数对象

getTempParamValue

  • getTempParamValue(paramName: string): any

  • 获取设置临时参数变量值

    Parameters

    • paramName: string

      参数名

    Returns any

    返回临时参数变量值

hasChanged

  • hasChanged(): boolean

  • 设计模式下,判断设计页面时候是否有属性值改变,包含自己与子孙组件的任何属性

    Returns boolean

hasCreate

  • hasCreate(): boolean

  • 判断json对象是否被创建为组件实例

    Returns boolean

hasDataChanged

  • hasDataChanged(): boolean

  • 运行模式 下是否存在数据需要保存才能通过页签关闭页面 注意:改函数与 hasChanged的区别 ; 本函数是运行模式针对数据级别的变动标志,hasChanged 是设计模式下组件的属性变动的标志

    Returns boolean

    true 存在修改的数据,则反之 (默认:false)

hasFormula

  • hasFormula(cmpId: string, attrName: string): boolean

  • 判断组件的属性是否存在公式

    Parameters

    • cmpId: string

      组件id

    • attrName: string

      属性名

    Returns boolean

hasPasteData

  • hasPasteData(callback: (has: boolean) => void): boolean

  • 设计模式下判断是否有数据可以粘贴

    Parameters

    • callback: (has: boolean) => void
        • (has: boolean): void

        • Parameters

          • has: boolean

          Returns void

    Returns boolean

    返回true 有数据

Protected hookgetElemtHtml

  • hookgetElemtHtml(html: string): string

  • html的钩子,可以修改组件返回的HTML,正常是返回html的值 给组件修改html的机会

    Parameters

    • html: string

      组件的html源码

    Returns string

    返回html

iniCss

  • iniCss(): any

  • 初始化组件的css

    Returns any

    返回组件样式对象.

Protected insertAttrEditorAfter

Protected insertAttrEditorBefore

insertChildAfterCmp

insertChildCmp

  • 在组件数组指定的位置插入组件后面增加子组件

    Parameters

    • childCmp: ComponentBase

      子组件

    • index: number = 0

      插入的位置（ 0 ~ items.length-1）

    Returns void

Protected isElementVisableArea

  • isElementVisableArea(el: HTMLElement): boolean

  • 判断元素是否在可见的区域 注意滚动条

    Parameters

    • el: HTMLElement

    Returns boolean

    返回true 可见,否则不可见

Protected linkEditorOnDesigningDbClick

  • linkEditorOnDesigningDbClick(atrtName: string, cmpCallback?: (item: AttributeEditorBase) => boolean): void

loadFromJson

  • page加载json

    Parameters

    • strJson: string

      json字符串

    • resetId: boolean = false

      是否重设所有的Id 默认值false

    Returns DesignerPageBase

move

  • 移动组件到某个位置

    Parameters

    Returns void

needName

  • needName(): void

  • 获取名称

    Returns void

off

  • off(eventName: string, fn: Function, scope: any): void

  • 取消注册的事件

    Parameters

    • eventName: string

      事件名

    • fn: Function

      函数过程

    • scope: any

      this的取值

    Returns void

offbyEventName

  • offbyEventName(eventName: string): void

  • 取消注册的事件

    Parameters

    • eventName: string

      事件名

    Returns void

on

  • on<T>(eventName: string, fn: T, scope: any, o?: IObserver): void

  • 注册事件处理函数 注意,如果同一个函数重复注册只生效最后一个

    Type parameters

    • T

    Parameters

    • eventName: string

      事件的名称

    • fn: T

      事件处理函数

    • scope: any

      this的取值

    • Optional o: IObserver

      参数

    Returns void

onCanClose

  • onCanClose(fn: onPageCanCloseHandle): void

  • 注册是否允许关闭回调 返回true 允许关闭,false不允许关闭 默认true 在页面关闭前给个机会介入判断是否允许关闭页面

    Parameters

    • fn: onPageCanCloseHandle

      回调函数

    Returns void

onClick

  • 注册组件的鼠标左键击事件

    Parameters

    Returns void

onClose

  • onClose(fn: onPageCloseHandle): void

  • 注册关闭回调

    Parameters

    • fn: onPageCloseHandle

      回调函数

    Returns void

onKeyPress

  • 注册键盘按下弹起事件

    Parameters

    Returns void

onKeyUp

  • 注册键盘按键弹起事件

    Parameters

    Returns void

onKeydown

  • 注册键盘按下时事件

    Parameters

    Returns void

onLeftDown

  • 注册组件的鼠标左键按下

    Parameters

    Returns void

onLeftUp

  • 注册组件的鼠标左键弹起

    Parameters

    Returns void

onMessage

  • onMessage(msg: any, callback: OnMessageHandle, override?: boolean, isGlobal?: boolean): void

  • 组件注册消息处理

    Parameters

    • msg: any

      处理的消息

    • callback: OnMessageHandle

      处理函数

    • Optional override: boolean

      是否覆盖原来注册的处理函数

    • Optional isGlobal: boolean

      是否全局监听(跨域iframe监听) 默认值 = false

    Returns void

onMouseMove

onPageLoad

  • onPageLoad(fn: onPageLoadHandle): void

  • 注册组件所属的Page加载完毕回调,这时候组件已经渲染 $elemt应不会出现空 可用于初始化组件

    Parameters

    • fn: onPageLoadHandle

      回调函数

    Returns void

onRightClick

onRightDown

  • 注册组件的鼠标右键按下

    Parameters

    Returns void

onRightUp

  • 注册组件的鼠标右键弹起

    Parameters

    Returns void

paste

  • paste(): void

  • 设计模式下的粘贴组件 子类可以覆盖此方法来实现自定义粘贴

    Returns void

preview

  • preview(): void

  • 设计模式 预览

    Returns void

purgeListeners

  • purgeListeners(): void

raiseEvent

  • raiseEvent(eventName: string, ...params: any[]): boolean

  • 触发事件 变量this.eventsSuspended 控制是否可以触发 true停止触发,则反之 例如:

    ```typescript this.raiseEvent('onClick',this,param1,param2)

    ```

    Parameters

    • eventName: string

      事件名称

    • Rest ...params: any[]

      可变参数列表 如: param1,param2,param3...

    Returns boolean

    返回事件的返回值

raiseOnCanCloseScript

  • raiseOnCanCloseScript(): boolean

raiseOnLoadScript

  • raiseOnLoadScript(): void

Protected raiseScriptEvent

  • raiseScriptEvent<T>(script: string, args?: any[]): any

  • 触发脚本事件函数

    Type parameters

    • T

    Parameters

    • script: string

      脚本

    • args: any[] = ...

      参数数组

    Returns any

    返回脚本内返回的值

reSize

  • reSize(includeChild?: boolean): void

  • 重新排列位置以及子组件的位置,大小

    Parameters

    • includeChild: boolean = true

      可选参数 是否包含子组件一起调整 默认:true

    Returns void

reSizeChilds

  • reSizeChilds(): void

  • 重新设置子组件的的大小,位置等..... 注意与 update的区别, 这个只是重新设置每个组件的位置和大小并没用删除html元素然后重建.

    Returns void

relayEvents

  • relayEvents(o: IObserver, events: string[]): void

  • 接管事件, 可以把事件接管到当前this的事件 如: this.relayEvents(this.proxy, [DataSourceEventType.loadexception]);

    Parameters

    • o: IObserver

      需要接管的实例

    • events: string[]

      事件名数组

    Returns void

remove

  • remove(): void

  • 移除自己

    Returns void

removeAllChildComponent

  • removeAllChildComponent(): void

removeChildComponent

  • removeChildComponent(cmp: ComponentBase, isDestory?: boolean): void

  • 移除下一级的子组件

    Parameters

    • cmp: ComponentBase

      需要移除的组件实例

    • isDestory: boolean = false

      可选参数; 是否要释放资源,默认 false;

    Returns void

removeChildComponentById

  • removeChildComponentById(cmpId: string): void

removeChildComponentByName

  • removeChildComponentByName(cmpName: string): void

removeChildComponentExt

  • removeChildComponentExt(callback: (item: ComponentBase) => boolean, isDestory?: boolean): void

  • 移除下一级的子组件

    Parameters

    • callback: (item: ComponentBase) => boolean

      移除每个组件时候的回调,注意会回调多次

    • isDestory: boolean = false

      可选参数; 是否要释放资源,默认 false;

    Returns void

removeCmpDeclare

removeCmpFormula

  • removeCmpFormula(cmpId: string): void

  • 移除属性公式

    Parameters

    • cmpId: string

      组件id

    Returns void

removeComponent

removeComponentById

  • removeComponentById(id: string): void

  • 通过组件id移除子组件

    Parameters

    • id: string

      组件实例id

    Returns void

removeFormula

  • removeFormula(cmpId: string, attrName: string): void

  • 移除属性公式

    Parameters

    • cmpId: string

      组件id

    • attrName: string

      属性名

    Returns void

renameCmpDeclare

render

resumeEvents

  • resumeEvents(): void

save

  • save(desc?: string): void

  • 设计模式下的保存

    Parameters

    • Optional desc: string

    Returns void

select

  • select(): void

  • 设计模式下组件获取焦点

    Returns void

selectCmp

  • cmp获取焦点

    Parameters

    Returns void

serialize

  • serialize(space?: any): any

  • 组件序列化

    Parameters

    • space: any = ...

      可选参数 输出的格式的缩进参数. 如:每行缩进两个空格 serialize(2)

    Returns any

    返回json字符串

setBackground

  • setBackground(value: string): void

  • 设置背景颜色

    Parameters

    • value: string

    Returns void

setCss

  • setCss(value: object): void

  • 设置组件的css

    Parameters

    • value: object

    Returns void

setCursor

  • setCursor(value: Cursor): void

  • 设置组件的鼠标形状

    Parameters

    • value: Cursor

      鼠标形状的枚举

    Returns void

setCxt

Protected setDefaultValues

  • setDefaultValues(): void

  • 设置 @serialize 注册过的属性的默认值

    Returns void

setDesigningFocused

setDock

setEnable

  • setEnable(value: boolean): void

  • 设置组件是否可用

    Parameters

    • value: boolean

      true可用 则反之

    Returns void

setFocuse

  • setFocuse(): void

  • 设置组件焦点 子类覆盖自定义组件内的焦点行为

    Returns void

setFont

  • setFont(value: Font): void

  • 设置组件字体

    Parameters

    • value: Font

      字体字符串

    Returns void

setHandle

  • setHandle(h: any): void

  • 设置页面的窗口唯一句柄

    Parameters

    • h: any

      一般就是弹出层的ID

    Returns void

setHasDataChanged

  • setHasDataChanged(value: boolean): void

  • 运行模式 下是否存在数据需要保存,如果存在页面关闭时候回提示,

    Parameters

    • value: boolean

      true 存在修改的数据,则反之

    Returns void

setHide

  • setHide(value: boolean): void

  • 设置隐藏

    Parameters

    • value: boolean

      true 组件隐藏,否则显示

    Returns void

setIsChanged

  • setIsChanged(value: boolean): void

  • 标记页面已经被修改

    Parameters

    • value: boolean

      true已经被修改,否则false;

    Returns void

setMargin

  • setMargin(value: string): void

  • 设置组件的间隔距离

    Parameters

    • value: string

      true 组件隐藏,否则显示

    Returns void

setName

  • setName(value: string): void

  • 设置组件名称

    Parameters

    • value: string

      组件名

    Returns void

setPage

  • 设置页面实例,一般用于静态渲染时候getPage为空

    Parameters

    Returns void

setParams

  • setParams(param: IParam[]): void

  • 设置并融合页面的参数数组 不存在就新增,存在就更新 例子: setParams([{name:'param1',value:'paramValue1'},{name:'param1',value:'paramValue1'},])

    Parameters

    • param: IParam[]

      IParam对象数组

    Returns void

setParamsObj

  • setParamsObj(paramObj: Object): void

  • 设置并融合页面的参数数组 不存在就新增,存在就更新 例子: setParams({param1:paramvalue1,param2:paramvalue2})

    Parameters

    • paramObj: Object

      参数对象

    Returns void

setParent

  • 设置父组件

    Parameters

    • parent: ComponentBase

      父组件实例 非空时候设置组件的父组件, null,undefine 移除父组件

    • index: number = 0

      插入的子元素的位置（ 0 ~ items.length-1）

    Returns void

setParentAfter

  • 设置父组件 ,在before后面插入组件

    Parameters

    • parent: ComponentBase

      父组件实例 非空时候设置组件的父组件, null,undefine 移除父组件

    • before: ComponentBase

      在before后面插入组件

    Returns void

setTempParamObj

  • setTempParamObj(paramObj: Object): void

  • 设置临时参数变量,这个参数没有参与数据源的查询,可用于临时变量的存储.

    Parameters

    • paramObj: Object

      参数变量对象

    Returns void

staticRender

  • staticRender(setting: any): void

  • 静态渲染组件

    Parameters

    • setting: any

      设置的属性

    Returns void

Protected stopEventPropagation

  • stopEventPropagation(e: any): void

  • 停止事件的传播 注意这个事件是针对dom的html事件,而不是组件的事件

    Parameters

    • e: any

      事件对象

    Returns void

submit

  • submit(): Boolean

  • 校验容器内的可编辑组件的值

    Returns Boolean

suspendEvents

  • suspendEvents(): void

Static getDesignmodel

  • getDesignmodel(): boolean

  • 获取设计模式

    Returns boolean

    true:设计模式 否则:运行模式

Static getPageByCode

  • getPageByCode(modelCode: string, designModel: boolean, callback: (page: DesignerPageBase, err?: string) => void, resid?: string, isUrlParam?: boolean): void

  • 根据modeCode获取page的实例

    Parameters

    • modelCode: string

      界面模型的编号

    • designModel: boolean

      是否设计模式

    • callback: (page: DesignerPageBase, err?: string) => void

      获取完后的回调 成功 err为空

    • Optional resid: string

      可选参数. 资源ID,需要权限时候需要传递此参数

    • isUrlParam: boolean = true

      可选参数. 是否要再url中解析参数到页面参数

    Returns void

Static getPageById

  • getPageById(modelId: string, designModel: boolean, callback: (page: DesignerPageBase, err?: string) => void, resid?: string, isUrlParam?: boolean): void

  • 根据modelId获取page的实例

    Parameters

    • modelId: string

      界面模型的rwid

    • designModel: boolean

      是否设计模式

    • callback: (page: DesignerPageBase, err?: string) => void

      获取完后的回调 成功 err为空

    • Optional resid: string

      可选参数. 资源ID ,需要权限时候需要传递此参数

    • isUrlParam: boolean = true

      可选参数. 是否要在url中解析参数到页面参数

    Returns void

Static getPageJsonByCodeStr

  • getPageJsonByCodeStr(modelCode: string, designModel: boolean, callback: (strJson: string, err?: string) => void, resid?: string): void

  • 获取page的json

    Parameters

    • modelCode: string

      界面模型的编号

    • designModel: boolean

      是否设计模式

    • callback: (strJson: string, err?: string) => void

      回调

        • (strJson: string, err?: string): void

        • Parameters

          • strJson: string
          • Optional err: string

          Returns void

    • Optional resid: string

      可选参数. 资源ID,需要权限时候需要传递此参数

    Returns void

Static getPageJsonByIdStr

  • getPageJsonByIdStr(modelId: string, designModel: boolean, callback: (strJson: string, err?: string) => void, resid?: string): void

  • 获取page的json

    Parameters

    • modelId: string

      界面模型的rwid

    • designModel: boolean

      是否设计模式

    • callback: (strJson: string, err?: string) => void

      回调

        • (strJson: string, err?: string): void

        • Parameters

          • strJson: string
          • Optional err: string

          Returns void

    • Optional resid: string

      可选参数. 资源ID,需要权限时候需要传递此参数

    Returns void

Static loadById

  • loadById($rootDom: JQuery<HTMLElement>, designModel: boolean, modelId: string, actions: {}, callback: (page: DesignerPageBase, error: string) => void): void

  • 通过modelId加载页面

    Parameters

    • $rootDom: JQuery<HTMLElement>

      根节点jquery对象

    • designModel: boolean

      是否设计模式

    • modelId: string

      界面模型的rwid

    • actions: {}
    • callback: (page: DesignerPageBase, error: string) => void

      回调

    Returns void

Static loadFromJson

  • loadFromJson(rootDom: JQuery<HTMLElement>, strJson: string, modelId: string, actions: {}): DesignerPageBase

  • 通过jsonString加载页面

    Parameters

    • rootDom: JQuery<HTMLElement>

      根节点jquery对象

    • strJson: string

      json字符串

    • modelId: string

      界面模型的rwid

    • actions: {}

    Returns DesignerPageBase

    返回创建完毕后的designerPageBase对象实例

Generated using TypeDoc