Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DropDownBase

下拉组件基类

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

$elemt

$elemt: JQuery<HTMLElement>

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

$parentElem

$parentElem: JQuery<HTMLElement>

组件的父jQuery节点 一般静态渲染时候需要给给这属性赋值

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

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

Optional class

class: string

组件的样式class

componentWidth

componentWidth: string

输入组件宽度

css

css: DropDwonStyle

记录组件样式类型

cssString

cssString: string

自定义样式

cursor

cursor: Cursor

鼠标的图标

datas

datas: any[]

数据源

Protected dependencies

dependencies: IDependency[] = ...

designPopMenu

designPopMenu: Contextmenu

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

dock

dock: DockType

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

dragFilter

dragFilter: string

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

draggableClass

draggableClass: string

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

draggableCompnent

draggableCompnent: any

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

draggableInheritCompnent

draggableInheritCompnent: any

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

draggablextype

draggablextype: any

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

drogDownHeight

drogDownHeight: number

下拉的高度

drogDownWidth

drogDownWidth: number

弹出下拉菜单的宽度

dropDownDataSource

dropDownDataSource: string

下拉数据源

Private dropDownId

dropDownId: string

enable

enable: boolean

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

eventsSuspended

eventsSuspended: boolean

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

field

field: string

数据源关联的字段值

font

font: Font

组件字体

height

height: string | number

组件的高度

hide

hide: boolean

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

hitTitle

hitTitle: string

鼠标停留时候提示信息

Readonly id

id: string

组件的id

inputBackColor

inputBackColor: string

输入框的背景

Private inputDivId

inputDivId: string

isClearable

isClearable: Boolean

是否允许清空值

isClickStopEvent

isClickStopEvent: boolean

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

Protected isDataChanged

isDataChanged: boolean = false

数据源改变标志变量 在 doDataChanged 函数设置

isDropCreate

isDropCreate: boolean

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

isRightRes

isRightRes: boolean

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

isShowLabel

isShowLabel: boolean

是否显示label

isShowSuffix

isShowSuffix: boolean

是否显示后缀

isStatic

isStatic: boolean

静态渲染

items

items: ComponentBase[]

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

labelCaption

labelCaption: string

label标题

labelWidth

labelWidth: string

label标题宽度

margin

margin: string

组件间隔

maxlength

maxlength: number

能选择的最大几个值 默认值: 999999

name

name: string

组件名称

onSelectScript

onSelectScript: string

下拉选中事件

onValueChangeScript

onValueChangeScript: any

值发生编号的事件

parentCmp

parentCmp: ComponentBase

父组件

placeholder

placeholder: string

空白时候的提示字符串

Protected popEditor

popEditor: IDropDownEditor

下拉框

readonly

readonly: boolean

只读

required

required: boolean

是否必填

rightTitle

rightTitle: string

权限资源的标题

rootId

rootId: string

静态渲染的id

Protected row

row: Row

绑定的数据库记录

staticDataSource

staticDataSource: DataSourceBase

staticDatas

staticDatas: any[]

suffixText

suffixText: string

后缀文本

suffixWidth

suffixWidth: string | number

后缀文本

tag

tag: any

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

textAlign

textAlign: TextAlign

对齐方式

titlefield

titlefield: string

数据标题显示字段

value

value: any

组件值 一般不要直接修改这值.没有任何更新滴 使用setValue修改

valuefield

valuefield: string

数据唯一值KEY字段

verify

verify: string

校验规则

verifyText

verifyText: string

校验错误信息

width

width: string | number

组件的宽度

Readonly xtype

xtype: string

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

Methods

Protected addClosebtn

  • addClosebtn(): JQuery<HTMLElement>

  • Returns JQuery<HTMLElement>

Protected addDependencies

addEvents

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

  • 注册事件绑定的

    Parameters

    • Rest ...args: any[]

      事件唯一标志字符串

    Returns void

Protected addbtn

  • addbtn(): JQuery<HTMLElement>

  • Returns JQuery<HTMLElement>

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

checkCanDragMove

checkDragAccept

  • 校验进来的组件是否允许拖拽进来

    Parameters

    Returns boolean

clearAllEvents

  • clearAllEvents(): void

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

    Returns void

copy

  • copy(): void

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

    Returns void

cut

  • cut(): void

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

    Returns void

deserialize

  • deserialize(jsonStr: string): any

  • 反序列化

    Parameters

    • jsonStr: string

      json字符串

    Returns any

    返回组件对象

destory

  • destory(): void

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

    Returns void

Protected doCanBlurHideDropDrown

  • doCanBlurHideDropDrown(e: FocusOutEvent<any, any, any, any>): boolean

  • 是否失去焦点允许关闭弹出 子类可以根据需求zidingyi

    Parameters

    • e: FocusOutEvent<any, any, any, any>

    Returns boolean

    默认true

Protected doCanChildComponentsDragPut

  • doCanChildComponentsDragPut(): boolean

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

    reutns

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

    Returns boolean

Protected doCanDragSort

  • doCanDragSort(): boolean

  • Returns boolean

Protected doCheckMaxValue

  • doCheckMaxValue(value: string): boolean

  • 检验value是否超过最大值 如果给的值超过了最大数量会抛出异常 throw

    Parameters

    • value: string

    Returns boolean

    返回true 未超过最大的数量 则反之

Protected doClear

  • doClear(): void

  • 清空值

    Returns void

Protected doDataChanged

Protected doDesigningDbClick

  • doDesigningDbClick(): void

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

    Returns void

Protected doDestory

  • doDestory(): void

  • 释放资源函数.组件移除之前会调用 一般用于释放资源和反注册消息处理函数

    Returns 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 doDropDrown

  • doDropDrown(): void

  • 显示下拉

    Returns void

Protected doF1Help

  • doF1Help(): void

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

    Returns void

Protected doGetBtnIconHtml

  • doGetBtnIconHtml(): string

Protected doGetClassName

  • doGetClassName(): string

Protected doGetCloseBtnIconHtml

  • doGetCloseBtnIconHtml(): string

doGetCss

  • doGetCss(): DropDwonStyle

  • Returns DropDwonStyle

Protected doGetCustomDesignerMenuItems

  • doGetCustomDesignerMenuItems(): IMenuItem[]

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

    reutns

    返回自定义的菜单数组

    Returns IMenuItem[]

Protected doGetDefalutDesignerMenuItems

  • doGetDefalutDesignerMenuItems(): IMenuItem[]

Protected doGetDefautlValue

  • doGetDefautlValue(): any

  • 返回默认值

    Returns any

    默认值

Protected doGetElemtHtml

  • doGetElemtHtml(): string

Protected doGetRealValue

  • doGetRealValue(value: any): any

  • 获取组件的值

    1. 绑定数据源 组件初始化 新增的行

    1). 当绑定的字段值为空时候 返回默认值 2). 当绑定的字段值为非空时候 返回当前值

    非新增的行 根据数据库绑定根据当前的值来渲染, 返回当前值

    1. 非绑定数据源 组件初始化 返回默认值

    Parameters

    • value: any

    Returns any

    返回最终的值

Protected doGetSuffixElemtHtml

  • doGetSuffixElemtHtml(): string

  • 得到组件渲染后缀的html模板 子类覆盖实现自定义

    Returns string

    返回渲染的html字符串

Protected doGetVerifyTipsElem

  • doGetVerifyTipsElem(): JQuery<HTMLElement>

  • 设置数据校验的标志的jquery 对象 如 子类可以覆盖该函数 实现提交校验没有通过会把改jquery 对象变成"红色的框框"

    Returns JQuery<HTMLElement>

doHideDropDrown

  • doHideDropDrown(): void

  • Returns void

Protected doInitCompnentEvent

  • doInitCompnentEvent(): void

  • 初始化组件的一些事件

    Returns void

Protected doInsertChildCmp

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

Protected doInsertChildCmpAfter

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 doRender

  • doRender(): void

  • Returns void

Protected doRenderBackground

  • doRenderBackground(): void

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

    Returns void

Protected doRenderCanDesigChildFocus

  • doRenderCanDesigChildFocus(): void

Protected doRenderChilds

  • doRenderChilds(): void

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

    Returns void

Protected doRenderComponentWidth

  • doRenderComponentWidth(): void

Protected doRenderCursor

  • doRenderCursor(): void

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

    Returns void

doRenderDisplayValue

  • doRenderDisplayValue(): void

  • Returns void

Protected doRenderDrogAnchor

  • doRenderDrogAnchor(): void

Protected doRenderElemt

  • doRenderElemt(): void

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

    Returns void

Protected doRenderEnable

  • doRenderEnable(): void

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

    Returns void

doRenderFocuse

  • doRenderFocuse(): void

Protected doRenderFont

  • doRenderFont(): void

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

    Returns void

Protected doRenderHide

  • doRenderHide(): void

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

    Returns void

Protected doRenderHitTitle

  • doRenderHitTitle(): void

Protected doRenderInputBackColor

  • doRenderInputBackColor(): void

  • 渲染组件的背景色 子类可以覆盖实现自定义的赋值方式

    Returns void

Protected doRenderInputValue

  • doRenderInputValue(): void

  • 渲染input元素,

    子类可以覆盖实现自定义的赋值方式

    Returns void

Protected doRenderLabel

  • doRenderLabel(): void

  • 渲染标题

    Returns void

Protected doRenderMargin

  • doRenderMargin(): void

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

    Returns void

Protected doRenderPlaceholder

  • doRenderPlaceholder(): void

Protected doRenderPointerEvents

  • doRenderPointerEvents(): void

Protected doRenderReadOnly

  • doRenderReadOnly(): void

Protected doRenderSuffix

  • doRenderSuffix(): void

  • 渲染后缀

    Returns void

Protected doRenderTextAlign

  • doRenderTextAlign(): void

  • 渲染文字内容对齐方式 子类自行继承覆盖实现

    Returns void

Protected doSetDangerStatus

  • doSetDangerStatus(): void

Protected doSetTabIndex

  • doSetTabIndex(): void

  • 设置组件的焦点元素.主要用于显示获取焦点情况下元素设置tabindex="0"

    Returns void

doShowDropDrown

  • doShowDropDrown(): void

  • Returns void

doUpdate

  • doUpdate(): void

  • 更新组件,当修改了属性时候需要修改重新画组件的时候调用. 子类可以覆盖来自定义更新重画

    Returns void

Protected doValueChange

  • doValueChange(): void

doVerify

  • doVerify(): boolean

  • 校验数据是否通过设置的校验规则

    Returns boolean

    true通过,则反之

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

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

    Parameters

    • cmpId: string

      组件Id

    Returns ComponentBase

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

findChildComponentByName

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

    Parameters

    • cmpName: string

      组件name

    Returns ComponentBase

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

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[]

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

focuse

  • focuse(): void

  • 输入框得到输入焦点

    Returns void

getAttrEditors

getAttrsByClassName

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

    Parameters

    • clazz: any

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

    Returns AttributeEditorBase[]

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

Protected getCanEdit

  • getCanEdit(): boolean

  • 组件是否可以编辑

    Returns boolean

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

  • 得到页面上下文 上下文保存了资源的权限,resid...

    Returns ScriptContext

    上下文实例

getDataSource

getDefalutDesignerMenuItems

getDesignModel

  • getDesignModel(): boolean

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

    Returns boolean

    返回 true设计模式 则反之

getDesignPopMenu

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

    Returns Contextmenu

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

getDropDownDataSouce

  • 得到下拉组件的下拉数据源 这个回忽略翻页属性

    Returns DataSourceBase

    返回下拉的数据源实例

getDropDownElemt

  • getDropDownElemt(): JQuery<HTMLElement>

  • 得到下拉的挂靠jquery元素

    Returns JQuery<HTMLElement>

getElemt

  • getElemt(): JQuery<HTMLElement>

  • 组件的最外层的jquery对象

    Returns JQuery<HTMLElement>

    返回组件的 jquery对象

getElemtHtml

  • getElemtHtml(): string

getFieldValues

  • getFieldValues(): {}

  • 得到容器内编辑组件的值 一般用于提交数据

    Returns {}

getFocuse

  • getFocuse(): boolean

  • 判断组件是否拥有焦点

    Returns boolean

    返回组件是否有焦点

Protected getFocuseElemt

  • getFocuseElemt(): JQuery<HTMLElement>

  • Returns JQuery<HTMLElement>

Protected getHtml

  • getHtml(): string

  • Returns string

getId

  • getId(): string

  • 获取组件的全球唯一id

    Returns string

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

getIndex

  • getIndex(): number

  • 获取组件的位置索引

    Returns number

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

getInputDivElemt

  • getInputDivElemt(): JQuery<HTMLElement>

  • Returns JQuery<HTMLElement>

getInputElem

  • getInputElem(): JQuery<HTMLElement>

  • Returns JQuery<HTMLElement>

getLabelCaption

  • getLabelCaption(): string

  • 获取label的caption

    Returns string

    返回label的caption字符串

getName

  • getName(): string

  • 获取组件的名称

    Returns string

    组件的名称字符串

getNameString

  • getNameString(): string

getNext

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

    Returns ComponentBase

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

getPage

  • 得到当前组件的page 组件

    Returns DesignerPageBase

    返回找到的designerPage 组件实例

getParent

Abstract getPopEdior

  • 得到下拉编辑器

    Returns DropDownInputEditorBase

    下拉编辑器实例

getPrev

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

    Returns ComponentBase

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

getReadOnly

  • getReadOnly(): boolean

  • 获取是否组件只读

    Returns boolean

    返回true 不允许修改, 则反之

getRequired

  • getRequired(): boolean

  • 获取是是否必填

    Returns boolean

    返回true 必填, 则反之

getSelectedRow

  • getSelectedRow(): Row

  • 得到当前选择下拉数据源的行,一般用于获取现在的行的另外列的值

    Returns Row

    当前下拉数据源的行实例

Private getSelectmultipleInputElemt

  • getSelectmultipleInputElemt(): JQuery<HTMLElement>

  • Returns JQuery<HTMLElement>

getSerializePropertys

  • getSerializePropertys(): {}

getValue

  • getValue(): any

  • 得到组件的值

    Returns any

    返回值

getValues

  • getValues(): string[]

  • 得到组件的值数组

    Returns string[]

    返回数组

hasCreate

  • hasCreate(): boolean

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

    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

    返回组件样式对象.

Private initEvents

  • initEvents(): void

  • Returns void

Protected insertAttrEditorAfter

Protected insertAttrEditorBefore

insertChildAfterCmp

insertChildCmp

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

    Parameters

    • childCmp: ComponentBase

      子组件

    • index: number = 0

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

    Returns void

Protected isBindDataSource

  • isBindDataSource(): boolean

  • 判断是否有绑定有数据源组件和字段

    Returns boolean

    true绑定了数据源,则反之

Protected isElementVisableArea

  • isElementVisableArea(el: HTMLElement): boolean

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

    Parameters

    • el: HTMLElement

    Returns boolean

    返回true 可见,否则不可见

Private isOutWidth

  • isOutWidth(): { isOut: boolean; outCount: number }

  • 判断当前所选的项目宽度和是否大于组件的最大

    Returns { isOut: boolean; outCount: number }

    • isOut: boolean
    • outCount: number

Protected isRowNewState

  • isRowNewState(): boolean

  • 判断组件绑定的行是否新增状态

    Returns boolean

    true绑定行式新增状态,则反之

Protected linkEditorOnDesigningDbClick

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

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

onClick

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

    Parameters

    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

  • 注册组件的鼠标移动

    Parameters

    Returns void

onPageLoad

  • onPageLoad(fn: onPageLoadHandle): void

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

    Parameters

    • fn: onPageLoadHandle

      回调函数

    Returns void

onRightClick

  • 注册组件的鼠标右键事件

    Parameters

    Returns void

onRightDown

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

    Parameters

    Returns void

onRightUp

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

    Parameters

    Returns void

onSelectValueChange

  • onSelectValueChange(callback: onSelectChangedHandle): void

  • 值发生点击时候触发事件

    Parameters

    • callback: onSelectChangedHandle

      回调

    Returns void

onValueChanged

  • onValueChanged(callback: onValueChangeHandle): void

  • 注册值发生变动时候的事件 注意,数据源第一次给组件赋值初始化时候是无法触发该事件,否则会死循环

    Parameters

    • callback: onValueChangeHandle

      值修改事件回调函数

    Returns void

paste

  • paste(): void

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

    Returns void

purgeListeners

  • purgeListeners(): void

  • 清除事件

    Returns 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

    返回事件的返回值

raiseOnClickScript

  • raiseOnClickScript(): void

  • 执行界面编辑器设置的触发点击事件

    Returns 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

  • 移除子组件通过组件id

    Parameters

    • cmpId: string

      组件Id

    Returns void

removeChildComponentByName

  • removeChildComponentByName(cmpName: string): void

  • 移除子组件通过组件Name

    Parameters

    • cmpName: string

      组件名称

    Returns void

removeChildComponentExt

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

  • 移除下一级的子组件

    Parameters

    • callback: (item: ComponentBase) => boolean

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

    • isDestory: boolean = false

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

    Returns void

Protected removeCloseBtn

  • removeCloseBtn(): void

  • 移除清空按钮

    Returns void

render

  • render(): void

  • Returns void

resumeEvents

  • resumeEvents(): void

  • 恢复事件触发

    Returns void

select

  • select(): void

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

    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

setDataSource

  • 设置数据源

    Parameters

    Returns void

Protected setDefaultValues

  • setDefaultValues(): void

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

    Returns void

setDock

  • Parameters

    Returns void

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

setHide

  • setHide(value: boolean): void

  • 设置隐藏

    Parameters

    • value: boolean

      true 组件隐藏,否则显示

    Returns void

setLabelCaption

  • setLabelCaption(caption: string): void

  • 设置组件的label的标题

    Parameters

    • caption: string

    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

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

setReadOnly

  • setReadOnly(value: boolean): void

  • 设置只读

    Parameters

    • value: boolean

      true 只读不允许修改,否则允许修改

    Returns void

setRequired

  • setRequired(value: boolean): void

  • 设置是否必填

    Parameters

    • value: boolean

      true 必填,则反之

    Returns void

setValue

  • setValue(value: string): void

  • 设置组件的值 如果给的值超过了最大数量会抛出异常 throw 子类需要要用try catch来包裹住

    Parameters

    • value: string

      值字符串;多选时候值用逗号隔开的字符串

    Returns void

staticRender

Protected stopEventPropagation

  • stopEventPropagation(e: any): void

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

    Parameters

    • e: any

      事件对象

    Returns void

submit

  • submit(): Boolean

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

    Returns Boolean

suspendEvents

  • suspendEvents(): void

  • 暂停事件触发

    Returns void

verifyTips

  • verifyTips(): void

  • 显示的提示校验信息 当 verifyText 非空时候显示"危险"的样式, 空则去除"危险"的样式

    Returns void

Static getDesignmodel

  • getDesignmodel(): boolean

  • 获取设计模式

    Returns boolean

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

Generated using TypeDoc