forked from Jibo-Revival-Group/JiboOs
104 lines
2.4 KiB
JavaScript
104 lines
2.4 KiB
JavaScript
/**
|
|
* @class ViewGlobalEvents
|
|
* @description Typed global view events for ViewManager (`jibo.face.views.events`)
|
|
* @example
|
|
* jibo.face.views.events.process.on(onProcess);
|
|
*
|
|
* onProcess = (result:ViewProcessResult) => {
|
|
* // act accordingly
|
|
* }
|
|
*
|
|
* // When finished with event listening
|
|
* jibo.face.views.events.process.removeListener(onProcess);
|
|
*
|
|
* @memberof jibo.face.views
|
|
*/
|
|
|
|
/**
|
|
* Emits results from view change process.
|
|
* @name jibo.face.views.ViewGlobalEvents#process
|
|
* @type {Event<jibo.face.views.ViewProcessResult>}
|
|
*/
|
|
|
|
/**
|
|
* Emits results from View emitted events.
|
|
* @name jibo.face.views.ViewGlobalEvents#view
|
|
* @type {Event<jibo.face.views.ViewResult>}
|
|
*/
|
|
|
|
/**
|
|
* @class ViewProcessResult
|
|
* @description Result from change in view change process.
|
|
* @memberof jibo.face.views
|
|
*/
|
|
|
|
/**
|
|
* Current state of view process.
|
|
* Refer to {@link jibo.face.views.ViewProcess} for status values.
|
|
* @name jibo.face.views.ViewProcessResult#status
|
|
* @type {String}
|
|
* @readOnly
|
|
*/
|
|
|
|
/**
|
|
* Id of current view in process.
|
|
* @name jibo.face.views.ViewProcessResult#currentId
|
|
* @type {String}
|
|
* @readOnly
|
|
*/
|
|
|
|
/**
|
|
* Id of closing view in process.
|
|
* @name jibo.face.views.ViewProcessResult#closingId
|
|
* @type {String}
|
|
* @readOnly
|
|
*/
|
|
|
|
/**
|
|
* Serialized change options of process.
|
|
* @name jibo.face.views.ViewProcessResult#changeOptions
|
|
* @type {jibo.face.views~ChangeOptions}
|
|
* @readOnly
|
|
*/
|
|
|
|
/**
|
|
* @class ViewResult
|
|
* @description Results from events emitted by View.
|
|
* @memberof jibo.face.views
|
|
*/
|
|
|
|
/**
|
|
* Event emitted from view.
|
|
* @name jibo.face.views.ViewResult#event
|
|
* @type {String}
|
|
* @readOnly
|
|
*/
|
|
|
|
/**
|
|
* Id of view emitting the event.
|
|
* @name jibo.face.views.ViewResult#id
|
|
* @type {String}
|
|
* @readOnly
|
|
*/
|
|
|
|
/**
|
|
* Type of view emitting the event.
|
|
* @name jibo.face.views.ViewResult#type
|
|
* @type {String}
|
|
* @readOnly
|
|
*/
|
|
|
|
/**
|
|
* Statis of view emitting the event.
|
|
* Refer to {@link jibo.face.views.View} for status values.
|
|
* @name jibo.face.views.ViewResult#status
|
|
* @type {String}
|
|
* @readOnly
|
|
*/
|
|
|
|
/**
|
|
* Any additional data that may be passed with the event.
|
|
* @name jibo.face.views.ViewResult#data
|
|
* @type {any}
|
|
* @readOnly
|
|
*/ |