implab/implabjs-djx Commit - r38:5c6c7e16919c

Fixes in WidgetContex, added _Container.addChild support

cin -

r38:5c6c7e16919c v1.0.0-rc18 default

parent child

Context file:

r38:5c6c7e16919c

Collapse all files

src/main/ts/dom-inject.ts +2 -2

             import { id as mid } from "module";
             import { TraceSource } from "@implab/core-amd/log/TraceSource";
             import { MapOf } from "@implab/core-amd/interfaces";
             import { mixin } from "@implab/core-amd/safe";
             const trace = TraceSource.get(mid);
             function on<T extends keyof HTMLElementEventMap>(node: HTMLElement, eventName: T, handler: (this: HTMLElement, ev: HTMLElementEventMap[T]) => any): () => void {
                 // Add an event listener to a DOM node
                 node.addEventListener(eventName, handler, false);
                 return () => node.removeEventListener(eventName, handler, false);
             }
             interface NodeLoadResult {
                 node: HTMLElement;
             }
             class DomInject {
                 injectionPoint?: HTMLElement;
-                injectBefore?: HTMLElement;
+                injectAfter?: HTMLElement;
                 _map: MapOf<Promise<NodeLoadResult>> = {};
                 _inject<T extends keyof HTMLElementTagNameMap>(name: T, attr: Partial<HTMLElementTagNameMap[T]>) {
                     const node = document.createElement(name);
                     return new Promise<NodeLoadResult>((ok, fail) => {
                         const cleanup = () => {
                             noerr();
                             noload();
                         };
                         const noload = on(node, "load", () => {
                             ok({ node });
                             cleanup();
                         });
                         const noerr = on(node, "error", e => {
                             fail({
                                 erorr: e,
                                 node
                             });
                             cleanup();
                         });
                         mixin(node, attr);
                         const _injectionPoint = this.injectionPoint || document.head;
-                        const _injectBefore = this.injectBefore || _injectionPoint.firstChild;
+                        const _injectBefore = this.injectAfter ? this.injectAfter.nextSibling : null;
                         _injectionPoint.insertBefore(node, _injectBefore);
                     });
                 }
                 async injectScript(url: string) {
                     let d = this._map[url];
                     if (!d) {
                         trace.log("js {0}", url);
                         d = this._inject("script", {
                             type: "text/javascript",
                             charset: "utf-8",
                             src: url
                         });
                         this._map[url] = d;
                     }
                     try {
                         await d;
                         trace.log("done {0}", url);
                     } catch (e) {
                         trace.error("failed {0}: {1}", url, e);
                         throw e;
                     }
                 }
                 async injectStylesheet(url: string) {
                     let d = this._map[url];
                     if (!d) {
                         trace.log("js {0}", url);
                         d = this._inject("link", {
                             type: "text/css",
                             rel: "stylesheet",
                             href: url
                         });
                         this._map[url] = d;
                     }
                     try {
                         await d;
                         trace.log("done {0}", url);
                     } catch (e) {
                         trace.error("failed {0}: {1}", url, e);
                         throw e;
                     }
                 }
             };
             const instance = new DomInject();
             export default instance;

src/main/ts/tsx/BuildContextBase.ts +16 -4

             import { isNull, mixin } from "@implab/core-amd/safe";
             import { isPlainObject, isNode, isBuildContext, DojoNodePosition, BuildContext } from "./traits";
             import dom = require("dojo/dom-construct");
+            import registry = require("dijit/registry");
             export abstract class BuildContextBase<TNode extends Node> implements BuildContext<TNode> {
                 private _attrs = {};
                 private _children = new Array();
                 private _created: boolean = false;
                 visitNext(v: any) {
                     if (this._created)
                         throw new Error("The Element is already created");
                     if (isNull(v))
                         return;
                     if (isPlainObject(v)) {
                         mixin(this._attrs, v);
                     } else if (v instanceof Array) {
                         v.forEach(x => this.visitNext(x));
                     } else {
                         this._children.push(v);
                     }
                 }
                 getChildDom(v: any) {
                     const tv = typeof v;
                     if (tv === "string" || tv === "number" || tv === "boolean" || v instanceof RegExp || v instanceof Date) {
                         return document.createTextNode(v.toString());
                     } else if (isNode(v)) {
                         return v;
                     } else if (isBuildContext(v)) {
                         return v.getDomNode();
                     } else {
                         throw new Error("Invalid parameter");
                     }
                 }
-                abstract _getDomNode(): TNode;
                 ensureCreated() {
                     if (!this._created) {
                         this._create(this._attrs, this._children);
                         this._children = [];
                         this._attrs = {};
                         this._created = true;
                     }
                 }
-                /** @deprecated use getDomNode() */
+                /** @deprecated will be removed in 1.0.0, use getDomNode() */
                 getDomElement() {
                     return this.getDomNode();
                 }
+                /** Creates DOM node if not created. No additional actions are taken. */
                 getDomNode() {
                     this.ensureCreated();
                     return this._getDomNode();
                 }
+                /** Creates DOM node if not created, places it to the specified position
+                 * and calls startup() method for all widgets contained by this node.
+                 *
+                 * @param {string | Node} refNode The reference node where the created
+                 *   DOM should be placed.
+                 * @param {DojoNodePosition} position Optional parameter, specifies the
+                 *   position relative to refNode. Default is "last" (i.e. last child).
+                 */
                 placeAt(refNode: string | Node, position?: DojoNodePosition) {
-                    dom.place(this.getDomNode(), refNode, position);
+                    const domNode = this.getDomNode();
+                    dom.place(domNode, refNode, position);
+                    registry.findWidgets(domNode).forEach(w => w.startup());
                 }
                 abstract _create(attrs: object, children: any[]): void;
+                abstract _getDomNode(): TNode;
             }

src/main/ts/tsx/DjxFragment.ts +2 -9

             import { _Widget } from "./WidgetContext";
             import { MapOf } from "@implab/core-amd/interfaces";
             import { prototype } from "../declare";
             /** Special widget used to create a document fragment */
             export class DjxFragment implements _Widget {
-                @prototype()
                 domNode: Node;
                 containerNode?: Node;
                 constructor() {
                     this.domNode = this.containerNode = document.createDocumentFragment();
                 }
+                buildRendering() {
-                get(attr: string) {
+                    // this function marks this class as _Widget
-                    return undefined;
-                set(attr: string, value: any): void;
-                set(attrs: MapOf<any>): void;
-                set() {
-                    /* do nothing */
                 }
             }

src/main/ts/tsx/WidgetContext.ts +53 -9

             import dom = require("dojo/dom-construct");
             import { argumentNotNull } from "@implab/core-amd/safe";
             import { BuildContextBase } from "./BuildContextBase";
-            import { MapOf } from "@implab/core-amd/interfaces";
+            import { DojoNodePosition, isWidget } from "./traits";
             // tslint:disable-next-line: class-name
             export interface _Widget {
                 domNode: Node;
-                get(attr: string): any;
+                containerNode?: Node;
-                set(attr: string, value: any): void;
+                placeAt?(refNode: string | Node, position?: DojoNodePosition): void;
-                set(attrs: MapOf<any>): void;
+                startup?(): void;
-                containerNode?: Node
+                addChild?(widget: any, index?: number): void;
             }
             export type _WidgetCtor = new (attrs: any, srcNode?: string | Node) => _Widget;
             export class WidgetContext extends BuildContextBase<Node> {
-                widgetClass: _WidgetCtor;
+                readonly widgetClass: _WidgetCtor;
                 _instance: _Widget | undefined;
                 constructor(widgetClass: _WidgetCtor) {
                     super();
                     argumentNotNull(widgetClass, "widgetClass");
                     this.widgetClass = widgetClass;
                 }
                 _addChild(child: any): void {
-                    if (!this._instance || !this._instance.containerNode)
+                    const instance = this._getInstance();
-                        throw new Error("Widget doesn't support adding children");
-                    dom.place(this.getChildDom(child), this._instance.containerNode);
+                    if (instance.addChild) {
+                        if (child instanceof WidgetContext)
+                            // layout containers add custom logic to addChild methods
+                            instance.addChild(child.getWidgetInstance());
+                        else if (isWidget(child))
+                            instance.addChild(child);
+                        else
+                            instance.addChild(this.getChildDom(child));
+                    } else {
+                        if (!instance.containerNode)
+                            throw new Error("The widget doesn't have neither addChild nor containerNode");
+                        // the current widget isn't started, it's children shouldn't start too
+                        dom.place(this.getChildDom(child), instance.containerNode);
+                    }
                 }
                 _create(attrs: object, children: any[]) {
                     this._instance = new this.widgetClass(attrs);
                     if (children)
                         children.forEach(x => this._addChild(x));
                 }
+                private _getInstance() {
+                    if (!this._instance)
+                        throw new Error("The instance of the widget isn't created");
+                    return this._instance;
+                }
                 _getDomNode() {
                     if (!this._instance)
                         throw new Error("The instance of the widget isn't created");
                     return this._instance.domNode;
                 }
+                /** Overrides default placeAt implementation. Calls placeAt of the
+                 * widget and then starts it.
+                 *
+                 * @param refNode A node or id of the node where the widget should be placed.
+                 * @param position A position relative to refNode.
+                 */
+                placeAt(refNode: string | Node, position?: DojoNodePosition) {
+                    this.ensureCreated();
+                    const instance = this._getInstance();
+                    if (typeof instance.placeAt === "function") {
+                        instance.placeAt(refNode, position);
+                        // do we need to force widget startup?
+                        if (typeof instance.startup === "function")
+                            instance.startup();
+                    } else {
+                        super.placeAt(refNode, position);
                     }
+                }
+                getWidgetInstance() {
+                    this.ensureCreated();
+                    return this._getInstance();
+                }
+            }

src/main/ts/tsx/traits.ts +4 -1

             import _WidgetBase = require("dijit/_WidgetBase");
             type _WidgetBaseConstructor = typeof _WidgetBase;
             export type DojoNodePosition = "first" | "after" | "before" | "last" | "replace" | "only" | number;
             export interface BuildContext<TNode extends Node = Node> {
                 getDomNode(): TNode;
                 placeAt(refNode: string | Node, position?: DojoNodePosition): void;
             }
             export function isNode(el: any): el is Node {
                 return el && el.nodeName && el.nodeType;
             }
             export function isElementNode(el: any): el is Element {
                 return isNode(el) && el.nodeType === 1;
             }
             export function isTextNode(el: any): el is Text {
                 return isNode(el) && el.nodeType === 3;
             }
             export function isProcessingInstructionNode(el: any): el is ProcessingInstruction {
                 return isNode(el) && el.nodeType === 7;
             }
             export function isCommentNode(el: any): el is Comment {
                 return isNode(el) && el.nodeType === 8;
             }
             export function isDocumentNode(el: any): el is Document {
                 return isNode(el) && el.nodeType === 9;
             }
             export function isDocumentTypeNode(el: any): el is DocumentType {
                 return isNode(el) && el.nodeType === 10;
             }
             export function isDocumentFragmentNode(el: any): el is DocumentFragment {
                 return isNode(el) && el.nodeType === 11;
             }
             export function isWidget(v: any): v is _WidgetBase {
                 return v && "domNode" in v;
             }
             export function isBuildContext(v: any): v is BuildContext {
                 return typeof v === "object" && typeof v.getDomElement === "function";
             }
             export function isPlainObject(v: object) {
                 if (typeof v !== "object")
                     return false;
                 const vp = Object.getPrototypeOf(v);
                 return !vp || vp === Object.prototype;
             }
             export function isWidgetConstructor(v: any): v is _WidgetBaseConstructor {
-                return typeof v === "function" && v.prototype && "domNode" in v.prototype;
+                return typeof v === "function" && v.prototype && (
+                    "domNode" in v.prototype ||
+                    "buildRendering" in v.prototype
+                );
             }

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages