@launchmenu/core
Version:
An environment for visual keyboard controlled applets
65 lines • 3.14 kB
TypeScript
import { Field, IDataHook } from "model-react";
import { IIOContext } from "../../../../../context/_types/IIOContext";
import { KeyPattern } from "../../../../../keyHandler/KeyPattern";
import { AbstractUILayer } from "../../../../../uiLayers/AbstractUILayer";
import { MenuSearch } from "../../../../../uiLayers/types/menuSearch/MenuSearch";
import { IUILayerContentData } from "../../../../../uiLayers/_types/IUILayerContentData";
import { IUILayerFieldData } from "../../../../../uiLayers/_types/IUILayerFieldData";
import { IUILayerMenuData } from "../../../../../uiLayers/_types/IUILayerMenuData";
import { IViewStackItem } from "../../../../../uiLayers/_types/IViewStackItem";
import { IField } from "../../../../../_types/IField";
import { IMenu } from "../../../../menu/_types/IMenu";
import { IAdvancedKeyPatternUIData } from "./_types/IAdvancedKeyPatternUIData";
import { IMenuItem } from "../../../_types/IMenuItem";
import { IDisposableKeyEventListener } from "../../../../../textFields/interaction/_types/IDisposableKeyEventListener";
export declare class AdvancedKeyPatternUI extends AbstractUILayer {
protected target: IField<KeyPattern>;
protected config: IAdvancedKeyPatternUIData;
protected value: IField<KeyPattern>;
protected contentData: Field<IUILayerContentData | null>;
protected menuData: Field<IUILayerMenuData | null>;
protected menuSearch: Field<MenuSearch | null>;
/**
* Creates a new advanced key editor UI
* @param field The field to be updated
* @param config The configuration for the UI
*/
constructor(field: IField<KeyPattern>, config?: IAdvancedKeyPatternUIData);
/** @override */
getFieldData(hook?: IDataHook): IUILayerFieldData[];
/** @override */
getContentData(hook?: IDataHook): IUILayerContentData[];
/** @override */
getMenuData(hook?: IDataHook): IUILayerMenuData[];
/** @override */
protected initialize(context: IIOContext, close: () => void): Promise<() => void>;
/**
* Retrieves the menu view given the menu
* @param menu The menu to create a view for
* @returns The created view
*/
protected getMenuView(menu: IMenu): IViewStackItem;
/**
* Retrieves the key handler for a menu
* @param menu The menu to create the handler for
* @param close The function to close the UI
* @returns The key listener
*/
protected getMenuHandler(menu: IMenu, close: () => void): IDisposableKeyEventListener;
/**
* Retrieves the item to be used to add a new pattern
* @returns The item to be used to add a pattern
*/
protected getAddPatternItem(): IMenuItem;
/**
* Retrieves the item to be used to submit the changes
* @returns The item to submit the changes
*/
protected getSubmitItem(): IMenuItem;
/**
* Finish the editing and commits the changes
* @param context The context to be used to execute the command with if configured to be undoable
*/
submit(context: IIOContext): void;
}
//# sourceMappingURL=AdvancedKeyPatternUI.d.ts.map