olympus-r-dom

/// <amd-module name="DOMBridge" /> import IBridge from "olympus-r/engine/bridge/IBridge"; import { IMaskEntity } from "olympus-r/engine/mask/MaskManager"; import IMediator from "olympus-r/engine/mediator/IMediator"; import IPanelPolicy from "olympus-r/engine/panel/IPanelPolicy"; import { IPromptPanelConstructor } from "olympus-r/engine/panel/IPromptPanel"; import IScenePolicy from "olympus-r/engine/scene/IScenePolicy"; import { MaskData } from "./dom/mask/MaskEntity"; /** * @author Raykid * @email initial_r@qq.com * @create date 2017-09-18 * @modify date 2017-09-18 * * 基于DOM的表现层桥实现 */ export default class DOMBridge implements IBridge<Element> { /** 提供静态类型常量 */ static TYPE: string; private _initParams; /** * 获取表现层类型名称 * * @readonly * @type {string} * @memberof DOMBridge */ readonly type: string; /** * 获取表现层HTML包装器，可以对其样式进行自定义调整 * * @readonly * @type {HTMLElement} * @memberof DOMBridge */ readonly htmlWrapper: HTMLElement; /** * 获取根显示节点 * * @readonly * @type {HTMLElement} * @memberof DOMBridge */ readonly root: HTMLElement; /** * 获取舞台引用，DOM的舞台指向根节点 * * @readonly * @type {HTMLElement} * @memberof DOMBridge */ readonly stage: HTMLElement; private _bgLayer; /** * 获取背景容器 * * @readonly * @type {HTMLElement} * @memberof DOMBridge */ readonly bgLayer: HTMLElement; private _sceneLayer; /** * 获取场景容器 * * @readonly * @type {HTMLElement} * @memberof DOMBridge */ readonly sceneLayer: HTMLElement; private _frameLayer; /** * 获取框架容器 * * @readonly * @type {HTMLElement} * @memberof DOMBridge */ readonly frameLayer: HTMLElement; private _panelLayer; /** * 获取弹窗容器 * * @readonly * @type {HTMLElement} * @memberof DOMBridge */ readonly panelLayer: HTMLElement; private _maskLayer; /** * 获取遮罩容器 * * @readonly * @type {HTMLElement} * @memberof DOMBridge */ readonly maskLayer: HTMLElement; private _topLayer; /** * 获取顶级容器 * * @readonly * @type {HTMLElement} * @memberof DOMBridge */ readonly topLayer: HTMLElement; /** * 获取通用提示框 * * @readonly * @type {IPromptPanelConstructor} * @memberof DOMBridge */ readonly promptClass: IPromptPanelConstructor; /** * 获取遮罩实体 * * @readonly * @type {IMaskEntity} * @memberof DOMBridge */ readonly maskEntity: IMaskEntity; /** * 获取默认弹窗策略 * * @type {IPanelPolicy} * @memberof DOMBridge */ defaultPanelPolicy: IPanelPolicy; /** * 获取默认场景切换策略 * * @type {IScenePolicy} * @memberof DOMBridge */ defaultScenePolicy: IScenePolicy; constructor(params: IInitParams); private createLayer; /** * 初始化表现层桥，可以没有该方法，没有该方法则表示该表现层无需初始化 * @param {()=>void} complete 初始化完毕后的回调 * @memberof DOMBridge */ init(complete: (bridge: IBridge) => void): void; /** * 判断皮肤是否是DOM显示节点 * * @param {HTMLElement|string|string[]} skin 皮肤对象 * @returns {boolean} 是否是DOM显示节点 * @memberof DOMBridge */ isMySkin(skin: HTMLElement | string | string[]): boolean; /** * 包装Element节点 * * @param {IMediator<Element>} mediator 中介者 * @param {Element|string|string[]} skin 原始Element节点 * @returns {HTMLElement} 包装后的Element节点 * @memberof DOMBridge */ wrapSkin(mediator: IMediator<Element>, skin: Element | string | string[]): Element; /** * 替换皮肤，用于组件变身时不同表现层桥的处理 * * @param {IMediator<Element>} mediator 中介者 * @param {*} current 当前皮肤 * @param {Element|string|string[]} target 要替换的皮肤 * @returns {*} 替换完毕的皮肤 * @memberof DOMBridge */ replaceSkin(mediator: IMediator<Element>, current: Element, target: Element | string | string[]): any; /** * 同步皮肤，用于组件变身后的重新定位 * * @param {HTMLElement} current 当前皮肤 * @param {HTMLElement} target 替换的皮肤 * @memberof DOMBridge */ syncSkin(current: HTMLElement, target: HTMLElement): void; /** * 创建一个空的显示对象 * * @returns {HTMLElement} * @memberof DOMBridge */ createEmptyDisplay(): HTMLElement; /** * 创建一个占位符 * * @returns {HTMLElement} * @memberof DOMBridge */ createPlaceHolder(): HTMLElement; /** * 添加显示 * * @param {Element} parent 要添加到的父容器 * @param {Element} target 被添加的显示对象 * @return {Element} 返回被添加的显示对象 * @memberof DOMBridge */ addChild(parent: Element, target: Element): Element; /** * 按索引添加显示 * * @param {Element} parent 要添加到的父容器 * @param {Element} target 被添加的显示对象 * @param {number} index 要添加到的父级索引 * @return {Element} 返回被添加的显示对象 * @memberof DOMBridge */ addChildAt(parent: Element, target: Element, index: number): Element; /** * 移除显示对象 * * @param {Element} parent 父容器 * @param {Element} target 被移除的显示对象 * @return {Element} 返回被移除的显示对象 * @memberof DOMBridge */ removeChild(parent: Element, target: Element): Element; /** * 按索引移除显示 * * @param {Element} parent 父容器 * @param {number} index 索引 * @return {Element} 返回被移除的显示对象 * @memberof DOMBridge */ removeChildAt(parent: Element, index: number): Element; /** * 移除所有显示对象 * * @param {Element} parent 父容器 * @memberof DOMBridge */ removeChildren(parent: Element): void; /** * 获取父容器 * * @param {Element} target 目标对象 * @returns {Element} 父容器 * @memberof DOMBridge */ getParent(target: Element): Element; /** * 获取指定索引处的显示对象 * * @param {Element} parent 父容器 * @param {number} index 指定父级索引 * @return {Element} 索引处的显示对象 * @memberof DOMBridge */ getChildAt(parent: Element, index: number): Element; /** * 获取显示索引 * * @param {Element} parent 父容器 * @param {Element} target 子显示对象 * @return {number} target在parent中的索引 * @memberof DOMBridge */ getChildIndex(parent: Element, target: Element): number; /** * 通过名称获取显示对象 * * @param {Element} parent 父容器 * @param {string} name 对象名称 * @return {Element} 显示对象 * @memberof DOMBridge */ getChildByName(parent: Element, name: string): Element; /** * 获取子显示对象数量 * * @param {Element} parent 父容器 * @return {number} 子显示对象数量 * @memberof DOMBridge */ getChildCount(parent: Element): number; /** * 加载资源 * * @param {string[]} assets 资源数组 * @param {IMediator} mediator 资源列表 * @param {(err?:Error)=>void} handler 回调函数 * @memberof DOMBridge */ loadAssets(assets: string[], mediator: IMediator, handler: (err?: Error) => void): void; private _listenerDict; /** * 监听事件，从这个方法监听的事件会在中介者销毁时被自动移除监听 * * @param {EventTarget} target 事件目标对象 * @param {string} type 事件类型 * @param {(evt:Event)=>void} handler 事件处理函数 * @param {*} [thisArg] this指向对象 * @memberof DOMBridge */ mapListener(target: EventTarget, type: string, handler: (evt: Event) => void, thisArg?: any): void; /** * 注销监听事件 * * @param {EventTarget} target 事件目标对象 * @param {string} type 事件类型 * @param {(evt:Event)=>void} handler 事件处理函数 * @param {*} [thisArg] this指向对象 * @memberof DOMBridge */ unmapListener(target: EventTarget, type: string, handler: (evt: Event) => void, thisArg?: any): void; /** * 为绑定的列表显示对象包装一个渲染器创建回调 * * @param {Element} target BindFor指令指向的显示对象 * @param {(key?:any, value?:any, renderer?:Element)=>void} handler 渲染器创建回调 * @returns {*} 返回一个备忘录对象，会在赋值时提供 * @memberof IBridge */ wrapBindFor(target: Element, handler: (key?: any, value?: any, renderer?: Element) => void): any; /** * 为列表显示对象赋值 * * @param {Element} target BindFor指令指向的显示对象 * @param {*} datas 数据集合 * @param {*} memento wrapBindFor返回的备忘录对象 * @memberof IBridge */ valuateBindFor(target: Element, datas: any, memento: any): void; } export interface IInitParams { /** DOM容器名称或引用，不传递则自动生成一个 */ container?: string | Element; /** 通用提示框类型 */ promptClass?: IPromptPanelConstructor; /** 遮罩皮肤 */ maskData?: MaskData; }