Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SerializeComponetBase

组件序列化基类 支持：组件的序列化和反序列化

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    • config: any

    Returns SerializeComponetBase

Properties

Private _events

_events: {} = ...

事件存储对象

Type declaration

Protected dependencies

dependencies: IDependency[] = ...

eventsSuspended

eventsSuspended: boolean

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

Private excludeKeys

excludeKeys: string[] = ...

排除序列化的全局数组

Readonly id

id: string

组件的id

name

name: string

组件名称

Readonly xtype

xtype: string

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

Methods

Protected addDependencies

  • Parameters

    Returns void

addEvents

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

  • 注册事件绑定的

    Parameters

    • Rest ...args: any[]

      事件唯一标志字符串

    Returns void

clearAllEvents

  • clearAllEvents(): void

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

    Returns void

deserialize

  • deserialize(jsonStr: string): any

  • 反序列化

    Parameters

    • jsonStr: string

      json字符串

    Returns any

    返回组件对象

getDesignModel

  • getDesignModel(): boolean

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

    Returns boolean

    返回 true设计模式 则反之

getId

  • getId(): string

  • 获取组件的全球唯一id

    Returns string

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

getName

  • getName(): string

  • 获取组件的名称

    Returns string

    组件的名称字符串

getNameString

  • getNameString(): string

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

    Returns string

getSerializePropertys

  • getSerializePropertys(): {}

  • 获取实例的序列化属性

    Returns {}

    需要组件的属性对象 例如:{ pop1:String,pop2:Boolean}

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

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

    返回事件的返回值

relayEvents

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

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

    Parameters

    • o: IObserver

      需要接管的实例

    • events: string[]

      事件名数组

    Returns void

resumeEvents

  • resumeEvents(): void

  • 恢复事件触发

    Returns void

serialize

  • serialize(space?: any): any

  • 组件序列化

    Parameters

    • space: any = ...

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

    Returns any

    返回json字符串

Private serializefilter

  • serializefilter(prop: any, value: any, cmp: any): boolean

  • 序列化的属性过滤函数

    Parameters

    • prop: any

      组件属性名

    • value: any

      属性值

    • cmp: any

    Returns boolean

    返回true 运行序列化,则反之

Protected setDefaultValues

  • setDefaultValues(): void

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

    Returns void

Private setDependencies

  • Parameters

    • obj: any

    Returns IDependency[]

setName

  • setName(value: string): void

  • 设置组件名称

    Parameters

    • value: string

      组件名

    Returns void

Protected stopEventPropagation

  • stopEventPropagation(e: any): void

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

    Parameters

    • e: any

      事件对象

    Returns void

suspendEvents

  • suspendEvents(): void

  • 暂停事件触发

    Returns void

Static getDesignmodel

  • getDesignmodel(): boolean

  • 获取设计模式

    Returns boolean

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

Generated using TypeDoc