Class UiModule

EntityBase.

Hierarchy (view full)

AppModuleBase
- UiModule

Implements

IAppModuleBase

Constructors

constructor

new UiModule(app?, options?): UiModule
Parameters
- Optional app: App
- Optional options: UiModuleOptions
Returns UiModule
Overrides AppModuleBase.constructor

Properties

`Optional` _app

_app?: App

_controlContainer

_controlContainer: HTMLElement

_controlPositions

_controlPositions: Record<string, HTMLElement> = {}

_controls

_controls: IControl[] = []

`Protected` _destroyed

_destroyed: boolean = false

appRenderIndex

appRenderIndex: number = 0

`Optional` configPane

configPane?: any

data

data: ShallowReactive<{
[key: string]: any;
}> = ...

Type declaration

[key: string]: any

extData

extData: {
[key: string]: any;
} = {}

Type declaration

[key: string]: any

`Readonly` instanceId

instanceId: number = ++AppObject._instanceIdCounter

onSetApp

onSetApp: Signal = ...

options

options: UiModuleOptions

`Static` moduleName

moduleName: string = "UiModule"

Accessors

app

get app(): App
Returns App
Inherited from AppModuleBase.app
set app(value): void
Parameters
- value: App
Returns void
Inherited from AppModuleBase.app

destroyed

get destroyed(): boolean
Whether it has been destroyed.

Returns boolean
Inherited from AppModuleBase.destroyed

enabled

get enabled(): boolean
Indicates whether the component is enabled.

Returns boolean
Inherited from AppModuleBase.enabled
set enabled(value): void
Parameters
- value: boolean
Returns void
Inherited from AppModuleBase.enabled

uiConfig

get uiConfig(): UiObjectConfig<any, string, any>
Returns UiObjectConfig<any, string, any>
Inherited from AppModuleBase.uiConfig

Methods

_onAwake

_onAwake(): void
Internal
Returns void
Inherited from AppModuleBase._onAwake

_onDestroy

_onDestroy(): void
Internal
Returns void
Inherited from AppModuleBase._onDestroy

_onDisable

_onDisable(): void
Internal
Returns void
Inherited from AppModuleBase._onDisable

_onEnable

_onEnable(): void
Internal
Returns void
Inherited from AppModuleBase._onEnable

_setActive

_setActive(value): void
Internal
Parameters
- value: boolean
Returns void
Inherited from AppModuleBase._setActive

addControl

addControl(control, position?): App
增加控件 (会调用 control.onAdd(this) ).
Parameters
- control: IControl
  需要增加的控件.
- Optional position: ControlPosition
  位置. 'top-left', 'top-right', 'bottom-left', and 'bottom-right'. Defaults to 'top-right'`
Returns App

addDispose

addDispose(cb): void
Parameters
- cb: Function
Returns void
Inherited from AppModuleBase.addDispose

applyMixinsTo

applyMixinsTo(toClassInst, methodNames?, addMethods?, filterName?): void
Parameters
- toClassInst: any
- Optional methodNames: string[]
- Optional addMethods: string[]
- Optional filterName: string[]
Returns void
Inherited from AppModuleBase.applyMixinsTo

destroy

destroy(): void
Destroy self.

Returns void
Inherited from AppModuleBase.destroy

dispatch

dispatch(event, ...data): boolean
触发指定事件名称.
Parameters
- event: string
  Event name
- Rest ...data: any
  Data
Returns boolean
- Whether the dispatching is successful
Inherited from AppModuleBase.dispatch

effectScope

effectScope(fn): void
Parameters
- fn: (() => any)
  - - (): any
    - Returns any
Returns void
Inherited from AppModuleBase.effectScope

eventNames

eventNames(): string[]
返回注册的所有事件名.

Returns string[]
所有事件名

Inherited from AppModuleBase.eventNames

getConfigPane

getConfigPane(opts?): Promise<{
    appendChild: ((config?, params?) => any);
    configPane: any;
    element: HTMLElement;
    isInit: boolean;
    isVisible: (() => boolean);
    renderUiConfig: ((uiConfig) => any);
    renderUiObject: ((uiConfig, parent?) => any);
    reset: (() => void);
    rootPane: any;
    setVisible: ((b) => "" | "none");
    uiRefresh(deep?, mode?, delay?): any;
}>
Parameters
- Optional opts: {
      isReset?: boolean;
      style?: Partial<CSSStyleDeclaration>;
      title?: string;
  }
  - Optional isReset?: boolean
    是否清空，默认是
  - Optional style?: Partial<CSSStyleDeclaration>
    样式
  - Optional title?: string
    标题
Returns Promise<{
    appendChild: ((config?, params?) => any);
    configPane: any;
    element: HTMLElement;
    isInit: boolean;
    isVisible: (() => boolean);
    renderUiConfig: ((uiConfig) => any);
    renderUiObject: ((uiConfig, parent?) => any);
    reset: (() => void);
    rootPane: any;
    setVisible: ((b) => "" | "none");
    uiRefresh(deep?, mode?, delay?): any;
}>

hasControl

hasControl(control): boolean
是否有控件.
Parameters
- control: IControl
  要查询的控件.
Returns boolean

hasEvent

hasEvent(event): boolean
确定是否存在事件侦听
Parameters
- event: string
  事件名
Returns boolean
返回是否存在相应的事件

Inherited from AppModuleBase.hasEvent

listenerCount

listenerCount(event): number
返回具有指定事件名称的侦听总数.
Parameters
- event: string
  Event name
Returns number
The count of listeners

Inherited from AppModuleBase.listenerCount

logInfo

logInfo(text, type?, time?): void
信息弹窗提示
- text（必填）：需要输出的文本
- type（可选）：输出类型默认是 "log"
- time（可选）：停留时间默认是 2500
Parameters
- text: string
- Optional type: number | logInfoType
- Optional time: number
Returns void

off

off(event, fn?): EventDispatcher
移除监听.
Parameters
- event: string
  Event name
- Optional fn: Function
  Function, If is undefined, delete all corresponding event listeners.
Returns EventDispatcher
Inherited from AppModuleBase.off

on

on(event, fn): EventDispatcher
增加监听
Parameters
- event: string
  Event name
- fn: Function
  Function
Returns EventDispatcher
This

Inherited from AppModuleBase.on

onAwake

onAwake(): void
Returns void
Implementation of IAppModuleBase.onAwake

once

once(event, fn): EventDispatcher
只监听一次.
Parameters
- event: string
  Event name
- fn: Function
  Function
Returns EventDispatcher
This

Inherited from AppModuleBase.once

removeAllEventListeners

removeAllEventListeners(event?): void
通过事件名移除所有监听.
Parameters
- Optional event: string
  Event name, delete all events if not passed
Returns void
Inherited from AppModuleBase.removeAllEventListeners

removeControl

removeControl(control): App
移除控件.
Parameters
- control: IControl
  要移除的控件.
Returns App

removeDispose

removeDispose(cb): void
Parameters
- cb: Function
Returns void
Inherited from AppModuleBase.removeDispose

setControlMargin

setControlMargin(opts): void
Parameters
- opts: ControlMarginOptions
Returns void

setCursor

setCursor(cur): void
设置光标
Parameters
- cur: string
  光标名称
Returns void

setupUiConfig

setupUiConfig(): UiObjectConfig<any, string, any>
Returns UiObjectConfig<any, string, any>

Class UiModule

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional app: App

Optional options: UiModuleOptions

Returns UiModule

Properties

Optional _app

_controlContainer

_controlPositions

_controls

Protected _destroyed

appRenderIndex

Optional configPane

data

Type declaration

[key: string]: any

extData

Type declaration

[key: string]: any

Readonly instanceId

onSetApp

options

Static moduleName

Accessors

app

Returns App

Parameters

value: App

Returns void

destroyed

Returns boolean

enabled

Returns boolean

Parameters

value: boolean

Returns void

uiConfig

Returns UiObjectConfig<any, string, any>

Methods

_onAwake

Returns void

_onDestroy

Returns void

_onDisable

Returns void

_onEnable

Returns void

_setActive

Parameters

value: boolean

Returns void

addControl

Parameters

control: IControl

Optional position: ControlPosition

Returns App

addDispose

Parameters

cb: Function

Returns void

applyMixinsTo

Parameters

toClassInst: any

Optional methodNames: string[]

Optional addMethods: string[]

Optional filterName: string[]

Returns void

destroy

Returns void

dispatch

Parameters

`Optional` app: App

`Optional` options: UiModuleOptions

`Optional` _app

`Protected` _destroyed

`Optional` configPane

`Readonly` instanceId

`Static` moduleName

`Optional` position: ControlPosition

`Optional` methodNames: string[]

`Optional` addMethods: string[]

`Optional` filterName: string[]

`Rest` ...data: any

`Optional` opts: {
isReset?: boolean;
style?: Partial<CSSStyleDeclaration>;
title?: string;
}

`Optional` isReset?: boolean

`Optional` style?: Partial<CSSStyleDeclaration>

`Optional` title?: string

`Optional` type: number | logInfoType

`Optional` time: number

`Optional` fn: Function

`Optional` event: string