Theia APIs——事件

上一篇:Theia APIs——Preferences

事件

  Theia中的事件或许会让你感到困惑,希望本节能阐述清楚。
  来看下面的代码:
(来自logger-watcher.ts)
@injectable()
export class LoggerWatcher {

    getLoggerClient(): ILoggerClient {
        const emitter = this.onLogLevelChangedEmitter
        return {
            onLogLevelChanged(event: ILogLevelChangedEvent) {
                emitter.fire(event)
            }
        }
    }

    private onLogLevelChangedEmitter = new Emitter();

    get onLogLevelChanged(): Event {
        return this.onLogLevelChangedEmitter.event;
    }
}

  先来看看这一行:

private onLogLevelChangedEmitter = new Emitter();
  首先,什么是 Emitter
  Emitter是事件处理程序的容器,可以在上面注册事件处理程序并使用类型为X的事件触发它,在上面的例子中,X的类型为ILogLevelChangedEvent。
  所以这里我们创建了一个 Emitter,它将包含所有类型为ILogLevelChangedEvent的事件。
  接下来,我们希望能够在这个 Emitter上注册一个事件处理程序,可以像这样:
get onLogLevelChanged(): Event {
        return this.onLogLevelChangedEmitter.event;
    }
  它实际返回的是一个函数,用来注册事件处理程序,你只需要将事件处理程序的函数传递给它,它将注册该事件,然后当事件触发的时候该处理程序会被调用。
  你可以这样调用:
(来自logger.ts) 
/* Update the root logger log level if it changes in the backend. */
        loggerWatcher.onLogLevelChanged(event => {
            this.id.then(id => {
                if (id === this.rootLoggerId) {
                    this._logLevel = Promise.resolve(event.newLogLevel);
                }
            });
        });
  这将在emitter上注册一个匿名函数,并将其作为参数进行传递。
  接下来,我们需要触发一个事件来执行该事件处理程序。
onLogLevelChanged(event: ILogLevelChangedEvent) {
                emitter.fire(event)
            }
  当调用该函数时,emitter触发并调用所有的事件处理程序。
  所以,如果你想在Theia中触发事件,需要:
  • 创建一个emitter
  • 使用emitter.event函数注册事件
  • 使用emitter.fire(event)函数触发事件

 

原文地址:https://theia-ide.org/docs/events

你可能感兴趣的:(Theia APIs——事件)