WIP: Prepare package for generic display list

src/robotlegs/bender/bundles/openfl/OpenFLBundle.ts

@@ -5,7 +5,11 @@
 //  in accordance with the terms of the license agreement accompanying it.
 // ------------------------------------------------------------------------------
 
-import { IBundle, IContext, ILogger, instanceOfType } from "@robotlegsjs/core";
+import { interfaces, IBundle, IContext, ILogger, instanceOfType } from "@robotlegsjs/core";
+
+import { IDisplayObject } from "../../displayList/api/IDisplayObject";
+import { IDisplayObjectObserver } from "../../displayList/api/IDisplayObjectObserver";
+import { IDisplayObjectObserverFactory } from "../../displayList/api/IDisplayObjectObserverFactory";
 
 import { IContextView } from "../../extensions/contextView/api/IContextView";
 import { ContextView } from "../../extensions/contextView/impl/ContextView";
@@ -17,6 +21,8 @@ import { StageCrawlerExtension } from "../../extensions/viewManager/StageCrawler
 import { StageObserverExtension } from "../../extensions/viewManager/StageObserverExtension";
 import { ViewManagerExtension } from "../../extensions/viewManager/ViewManagerExtension";
 
+import { DisplayObjectObserver } from "./observer/DisplayObjectObserver";
+
 /**
  * For that Classic Robotlegs flavour
  *
@@ -42,6 +48,14 @@ export class OpenFLBundle implements IBundle {
         this._context = context;
         this._logger = context.getLogger(this);
 
+        this._context.injector
+            .bind<interfaces.Factory<IDisplayObjectObserver>>(IDisplayObjectObserverFactory)
+            .toFactory<IDisplayObjectObserver>(() => {
+                return (view: IDisplayObject, useCapture: boolean): IDisplayObjectObserver => {
+                    return new DisplayObjectObserver(view, useCapture);
+                };
+            });
+
         this._context.install(
             ContextViewExtension,
             ViewManagerExtension,
@@ -59,7 +73,7 @@ export class OpenFLBundle implements IBundle {
     /* Private Functions                                                          */
     /*============================================================================*/
 
-    private handleContextView(): void {
+    private handleContextView(contextView: ContextView): void {
         this._context.configure(ContextViewListenerConfig);
     }
 

src/robotlegs/bender/bundles/openfl/observer/DisplayObjectObserver.ts

@@ -0,0 +1,129 @@
+// ------------------------------------------------------------------------------
+//  Copyright (c) 2017-present, RobotlegsJS. All Rights Reserved.
+//
+//  NOTICE: You are permitted to use, modify, and distribute this file
+//  in accordance with the terms of the license agreement accompanying it.
+// ------------------------------------------------------------------------------
+
+import { IDisplayObject } from "../../../displayList/api/IDisplayObject";
+import { IDisplayObjectObserver } from "../../../displayList/api/IDisplayObjectObserver";
+
+import { ConfigureViewEvent } from "../../../extensions/viewManager/impl/ConfigureViewEvent";
+
+import DisplayObject from "openfl/display/DisplayObject";
+
+import Event from "openfl/events/Event";
+
+/**
+ *
+ */
+export class DisplayObjectObserver implements IDisplayObjectObserver {
+    private _displayObject: DisplayObject;
+    private _useCapture: boolean;
+
+    private _addedToStageHandler: Function;
+    private _removedFromStageHandler: Function;
+    private _configureViewHandler: Function;
+
+    /*============================================================================*/
+    /* Constructor                                                                */
+    /*============================================================================*/
+
+    /**
+     *
+     * @param displayObject
+     * @param useCapture
+     */
+    constructor(displayObject: IDisplayObject, useCapture: boolean) {
+        if (displayObject !== null && displayObject !== undefined) {
+            this._displayObject = <DisplayObject>displayObject;
+            this._useCapture = useCapture;
+        } else {
+            throw new Error("DisplayObject can't be null or undefined");
+        }
+    }
+
+    /*============================================================================*/
+    /* Public Functions                                                           */
+    /*============================================================================*/
+
+    /**
+     *
+     * @param handler
+     */
+    public addAddedToStageHandler(handler: Function): void {
+        if (handler !== null && handler !== undefined && this._displayObject.addEventListener !== undefined) {
+            this._addedToStageHandler = handler;
+            this._displayObject.addEventListener("addedToStage", this.onAddedToStage, this._useCapture);
+        }
+    }
+
+    /**
+     *
+     * @param handler
+     */
+    public addRemovedFromStageHandler(handler: Function): void {
+        if (handler !== null && handler !== undefined && this._displayObject.addEventListener !== undefined) {
+            this._removedFromStageHandler = handler;
+            this._displayObject.addEventListener("removedFromStage", this.onRemovedFromStage, this._useCapture);
+        }
+    }
+
+    /**
+     *
+     * @param handler
+     */
+    public addConfigureViewHandler(handler: Function): void {
+        if (handler !== null && handler !== undefined && this._displayObject.addEventListener !== undefined) {
+            this._configureViewHandler = handler;
+            this._displayObject.addEventListener(ConfigureViewEvent.CONFIGURE_VIEW, this.onConfigureView, this._useCapture);
+        }
+    }
+
+    /**
+     *
+     */
+    public destroy(): void {
+        if (this._displayObject.removeEventListener !== undefined) {
+            this._displayObject.removeEventListener("addedToStage", this.onAddedToStage, this._useCapture);
+            this._displayObject.removeEventListener("removedFromStage", this.onRemovedFromStage, this._useCapture);
+            this._displayObject.removeEventListener(ConfigureViewEvent.CONFIGURE_VIEW, this.onConfigureView, this._useCapture);
+        }
+
+        this._displayObject = null;
+
+        this._addedToStageHandler = null;
+        this._removedFromStageHandler = null;
+        this._configureViewHandler = null;
+    }
+
+    /*============================================================================*/
+    /* Private Functions                                                          */
+    /*============================================================================*/
+
+    private onAddedToStage = (event: Event): void => {
+        this._addedToStageHandler(event.target);
+    };
+
+    private onRemovedFromStage = (event: Event): void => {
+        this._removedFromStageHandler(event.target);
+    };
+
+    private onConfigureView = (event: ConfigureViewEvent): void => {
+        // Stop that event!
+        event.stopPropagation();
+
+        this._configureViewHandler(event.currentTarget, event.target);
+    };
+
+    /*============================================================================*/
+    /* Public Properties                                                          */
+    /*============================================================================*/
+
+    /**
+     * The display object
+     */
+    public get displayObject(): IDisplayObject {
+        return <IDisplayObject>this._displayObject;
+    }
+}

src/robotlegs/bender/displayList/api/IDisplayObject.ts

@@ -0,0 +1,13 @@
+// ------------------------------------------------------------------------------
+//  Copyright (c) 2017-present, RobotlegsJS. All Rights Reserved.
+//
+//  NOTICE: You are permitted to use, modify, and distribute this file
+//  in accordance with the terms of the license agreement accompanying it.
+// ------------------------------------------------------------------------------
+
+import { IDisplayObjectContainer } from "./IDisplayObjectContainer";
+
+export let IDisplayObject = Symbol("IDisplayObject");
+export interface IDisplayObject {
+    parent: IDisplayObjectContainer;
+}

src/robotlegs/bender/displayList/api/IDisplayObjectContainer.ts

@@ -0,0 +1,18 @@
+// ------------------------------------------------------------------------------
+//  Copyright (c) 2017-present, RobotlegsJS. All Rights Reserved.
+//
+//  NOTICE: You are permitted to use, modify, and distribute this file
+//  in accordance with the terms of the license agreement accompanying it.
+// ------------------------------------------------------------------------------
+
+import { IDisplayObject } from "./IDisplayObject";
+
+export let IDisplayObjectContainer = Symbol("IDisplayObjectContainer");
+export interface IDisplayObjectContainer extends IDisplayObject {
+    children?: IDisplayObject[];
+
+    numChildren?: number;
+    getChildAt?(index: number): IDisplayObject;
+
+    contains(child: IDisplayObject): boolean;
+}

src/robotlegs/bender/displayList/api/IDisplayObjectObserver.ts

@@ -0,0 +1,23 @@
+// ------------------------------------------------------------------------------
+//  Copyright (c) 2017-present, RobotlegsJS. All Rights Reserved.
+//
+//  NOTICE: You are permitted to use, modify, and distribute this file
+//  in accordance with the terms of the license agreement accompanying it.
+// ------------------------------------------------------------------------------
+
+import { IDisplayObject } from "./IDisplayObject";
+
+/**
+ *
+ */
+export interface IDisplayObjectObserver {
+    displayObject: IDisplayObject;
+
+    addAddedToStageHandler(handler: Function): void;
+
+    addRemovedFromStageHandler(handler: Function): void;
+
+    addConfigureViewHandler(handler: Function): void;
+
+    destroy(): void;
+}

src/robotlegs/bender/displayList/api/IDisplayObjectObserverFactory.ts

@@ -0,0 +1,15 @@
+// ------------------------------------------------------------------------------
+//  Copyright (c) 2017-present, RobotlegsJS. All Rights Reserved.
+//
+//  NOTICE: You are permitted to use, modify, and distribute this file
+//  in accordance with the terms of the license agreement accompanying it.
+// ------------------------------------------------------------------------------
+
+import { IDisplayObject } from "./IDisplayObject";
+import { IDisplayObjectObserver } from "./IDisplayObjectObserver";
+
+/**
+ *
+ */
+export let IDisplayObjectObserverFactory = Symbol("IDisplayObjectObserverFactory");
+export type IDisplayObjectObserverFactory = (view: IDisplayObject, useCapture: boolean) => IDisplayObjectObserver;

src/robotlegs/bender/extensions/contextView/api/IContextView.ts

@@ -5,9 +5,9 @@
 //  in accordance with the terms of the license agreement accompanying it.
 // ------------------------------------------------------------------------------
 
-import Stage from "openfl/display/Stage";
+import { IDisplayObjectContainer } from "../../../displayList/api/IDisplayObjectContainer";
 
-export let IContextView = Symbol("IContextView");
+export const IContextView = Symbol("IContextView");
 export interface IContextView {
-    view: Stage;
+    view: IDisplayObjectContainer;
 }

src/robotlegs/bender/extensions/contextView/impl/ContextView.ts

@@ -7,15 +7,15 @@
 
 import { IConfig } from "@robotlegsjs/core";
 
-import { IContextView } from "../api/IContextView";
+import { IDisplayObjectContainer } from "../../../displayList/api/IDisplayObjectContainer";
 
-import Stage from "openfl/display/Stage";
+import { IContextView } from "../api/IContextView";
 
 /**
  * The Context View represents the root Container for a Context
  */
 export class ContextView implements IContextView, IConfig {
-    private _view: Stage;
+    private _view: IDisplayObjectContainer;
 
     /*============================================================================*/
     /* Constructor                                                                */
@@ -25,7 +25,7 @@ export class ContextView implements IContextView, IConfig {
      * The Context View represents the root Container for a Context
      * @param view The root Container for this Context
      */
-    constructor(view: Stage) {
+    constructor(view: IDisplayObjectContainer) {
         if (view !== null && view !== undefined) {
             this._view = view;
         } else {
@@ -45,7 +45,7 @@ export class ContextView implements IContextView, IConfig {
     /**
      * The root Container for this Context
      */
-    public get view(): Stage {
+    public get view(): IDisplayObjectContainer {
         return this._view;
     }
 }

src/robotlegs/bender/extensions/mediatorMap/api/IMediatorMap.ts

@@ -13,7 +13,7 @@ import { IMediatorUnmapper } from "../dsl/IMediatorUnmapper";
 /**
  * The Mediator Map allows you to bind Mediators to objects
  */
-export let IMediatorMap = Symbol("IMediatorMap");
+export const IMediatorMap = Symbol("IMediatorMap");
 export interface IMediatorMap {
     /**
      * Maps a matcher that will be tested against incoming items to be handled.

src/robotlegs/bender/extensions/mediatorMap/impl/MediatorFactory.ts

@@ -7,6 +7,8 @@
 
 import { IClass, IType, IInjector, applyHooks, guardsApprove, instantiateUnmapped, ITypeFilter } from "@robotlegsjs/core";
 
+import { IDisplayObjectObserverFactory } from "../../../displayList/api/IDisplayObjectObserverFactory";
+
 import { IMediatorMapping } from "../api/IMediatorMapping";
 
 import { MediatorManager } from "./MediatorManager";
@@ -34,7 +36,7 @@ export class MediatorFactory {
      */
     constructor(injector: IInjector, manager?: MediatorManager) {
         this._injector = injector;
-        this._manager = manager || new MediatorManager(this);
+        this._manager = manager || new MediatorManager(this, this._injector.get(IDisplayObjectObserverFactory));
     }
 
     /*============================================================================*/