import commonInterfaces = require("../common/commonInterfaces"); /** * The node of details tree converted to JSON */ export interface DetailsItemJSON { /** * Node title. */ title: string; /** * Node description */ description: string; /** * Node type name */ type: string; /** * Error, associated with the node. */ error: string; /** * Node children. */ children: DetailsItemJSON[]; /** * Node ID. */ id: string; } /** * Details item having a value text. */ export interface DetailsValuedItemJSON extends DetailsItemJSON { /** * Value text. */ valueText: string; } /** * Details item having potential value options */ export interface DetailsItemWithOptionsJSON extends DetailsValuedItemJSON { /** * Potential options. */ options: string[]; } /** * Details item pointing to an executable action. */ export interface DetailsActionItemJSON extends DetailsItemJSON { /** * Action item subtype. */ subType: string; } /** * Type of details item */ export declare enum DetailsItemType { ROOT = 0, CATEGORY = 1, CHECKBOX = 2, JSONSCHEMA = 3, XMLSCHEMA = 4, MARKDOWN = 5, SELECTBOX = 6, MULTIEDITOR = 7, TREE = 8, STRUCTURED = 9, TYPEDISPLAY = 10, TYPESELECT = 11, JSONEXAMPLE = 12, XMLEXAMPLE = 13, ATTRIBUTETEXT = 14, DETAILS_ACTION = 15, } /** * Details tree node. */ export interface DetailsItem { /** * Node title. */ getTitle(): string; /** * Node description */ getDescription(): string; /** * Node type name */ getType(): DetailsItemType; /** * Error, associated with the node. */ getError(): string; /** * Node children. */ getChildren(): DetailsItem[]; /** * Node parent. */ getParent(): DetailsItem; /** * Tree root. */ getRoot(): DetailsItem; /** * Converts this node and its subnodes to JSON, recursivelly. */ toJSON(): DetailsItemJSON; /** * Returns item ID. */ getId(): string; } /** * Subtype for action items. */ export declare enum ActionItemSubType { INSERT = 0, INSERT_VALUE = 1, DELETE = 2, } export interface ActionItem extends DetailsItem { /** * Runs the action. */ run(): commonInterfaces.IChangedDocument; /** * Returns details item subtype. */ getSubType(): ActionItemSubType; }