Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WorkbenchBase

提供工作台的基本封装,建议自定义工作台从此类继承。

abstract
class
version

1.0.0

Hierarchy

Implements

Index

Constructors

Protected constructor

Events

ACTIVATING

ACTIVATING: string = "activating"

当工作台正在激活时产生的事件。

CLOSED

CLOSED: string = "closed"

当工作台被关闭后产生的事件。

CLOSING

CLOSING: string = "closing"

当工作台正在关闭时产生的事件。

DEACTIVATED

DEACTIVATED: string = "deactivated"

当工作台取消激活后产生的事件。

DEACTIVATING

DEACTIVATING: string = "deactivating"

当工作台正在取消激活时产生的事件。

OPENED

OPENED: string = "opened"

当工作台被打开后产生的事件。

OPENING

OPENING: string = "opening"

当工作台正在打开时产生的事件。

TITLE_CHANGED

TITLE_CHANGED: string = "title_changed"

当工作台标题被更改后产生的事件。

Properties

Private _applicationContext

_applicationContext: ApplicationContextBase

Private _status

_status: any

Private _title

_title: string

Accessors

applicationContext

status

title

  • get title(): string
  • set title(value: string): void

Methods

activate

  • activate(): void

addListener

  • addListener(type: string, listener: Function, scope?: any, once?: boolean): void
  • 为指定的事件类型注册一个侦听器,以使侦听器能够接收事件通知。

    summary

    如果不再需要某个事件侦听器,可调用 removeListener() 删除它,否则会产生内存问题。 由于垃圾回收器不会删除仍包含引用的对象,因此不会从内存中自动删除使用已注册事件侦听器的对象。

    Parameters

    • type: string

      事件类型。

    • listener: Function
    • Default value scope: any = this

      侦听函数绑定的 this 对象。

    • Default value once: boolean = false

      是否添加仅回调一次的事件侦听器,如果此参数设为 true 则在第一次回调时就自动移除监听。

    Returns void

    void

close

  • close(): Promise<boolean>

deactivate

  • deactivate(): void

dispatchEvent

  • dispatchEvent(type: string, data?: any): void
  • dispatchEvent(args: EventArgs): void

hasListener

  • hasListener(type: string): boolean

Protected onActivate

  • onActivate(): void

Protected onActivated

  • onActivated(): void

Protected onActivating

  • onActivating(): void

Protected onClose

  • onClose(): Promise<void>

Protected onClosed

  • onClosed(): void

Protected onClosing

Protected onDeactivate

  • onDeactivate(): void

Protected onDeactivated

  • onDeactivated(): void

Protected onDeactivateing

  • onDeactivateing(): void

Protected onOpen

  • onOpen(args: Array<string>): Promise<void>

Protected onOpened

  • onOpened(): void

Protected onOpening

  • onOpening(): void

Protected onTitleChanged

  • onTitleChanged(): void

open

  • open(args: Array<string>): Promise<void>

removeListener

  • removeListener(type: string, listener: Function, scope?: any): void
  • 移除侦听器。如果没有注册任何匹配的侦听器,则对此方法的调用没有任何效果。 侦听函数绑定的 this 对象。

    Parameters

    • type: string

      事件类型。

    • listener: Function

      处理事件的侦听器函数。

    • Default value scope: any = this

      侦听函数绑定的 this 对象。

    Returns void

    void

Generated using TypeDoc