wed/standalone/lib/wed/mode-tree.d.ts

Wed is a schema-aware editor for XML documents.

import { Decorator } from "./decorator";
import { Editor } from "./editor";
import { Mode } from "./mode";
import { ModeTreeAPI } from "./mode-api";
import { Mode as ModeOption } from "./options";
import { ModeValidator } from "./validator";
import { CleanedWedOptions } from "./wed-options-validation";
export interface AttributeHidingSpecs {
    elements: {
        selector: string;
        attributes: (string | {
            except: string[];
        })[];
    }[];
}
/**
 * A tree containing the modes configured for the current editing session.
 */
export declare class ModeTree implements ModeTreeAPI {
    private readonly editor;
    private readonly option;
    private root;
    private loader;
    private cachedMaxLabelNode;
    /**
     * @param editor The editor for which we are building this tree.
     *
     * @param option The ``mode`` option from the options passed to the wed
     * instance. This object will construct a tree from this option.
     */
    constructor(editor: Editor, option: ModeOption);
    /**
     * Load the modes, initialize them and build the tree.
     *
     * @returns A promise that resolves to ``this`` once all the modes are loaded
     * and initialized.
     */
    init(): Promise<ModeTree>;
    /**
     * Make the nodes of the tree. This function operates recursively: it will
     * inspect ``option`` for a ``submode`` option and will call itself to create
     * the necessary child nodes.
     *
     * @param selector The selector associated with the options passed in the 2nd
     * argument.
     *
     * @param option The mode option being processed.
     *
     * @param errorHanler The handler to call on errors in processing the wed
     * options. If this handler is called at all, then the returned value should
     * not be used. We operate this way because we want to report all errors that
     * can be reported, rather than abort early.
     *
     * @returns A promise that resolves to the created node.
     */
    private makeNodes(selector, option, errorHandler);
    getMode(node: Node): Mode;
    getDecorator(node: Node): Decorator;
    getWedOptions(node: Node): CleanedWedOptions;
    getAttributeHandling(node: Node): "show" | "hide" | "edit";
    getAttributeHidingSpecs(node: Node): AttributeHidingSpecs | null;
    /**
     * Get the mode node that governs a node.
     *
     * @param The node we want to check. This must be a done in the data tree or
     * the GUI tree.
     *
     * @returns The mode that governs the node.
     */
    private getModeNode(node);
    private _getModeNode(parent, parentScope, node);
    getStylesheets(): string[];
    getMaxLabelLevel(): number;
    getInitialLabelLevel(): number;
    /**
     * The node with the maximum label visibility level. If multiple nodes have
     * the same value, the earlier node "wins", and is the one provided by this
     * property. For instance, if the root node and its submode have the same
     * number, then this property has the root node for value.
     *
     * This is a cached value, computed on first access.
     */
    private readonly maxLabelLevelNode;
    getValidators(): ModeValidator[];
    /**
     * Call on each decorator to add its event handlers.
     */
    addDecoratorHandlers(): void;
    /**
     * Call on each decorator to start listening.
     */
    startListening(): void;
}