mirror of
https://github.com/ckaczor/azuredatastudio.git
synced 2026-01-14 01:25:37 -05:00
5454917569
* Add ability to stop enter key propagation for input model components * Fix spacing * onInputEntered -> onEnterKeyPressed
109 lines
3.3 KiB
TypeScript
109 lines
3.3 KiB
TypeScript
/*---------------------------------------------------------------------------------------------
|
|
* Copyright (c) Microsoft Corporation. All rights reserved.
|
|
* Licensed under the Source EULA. See License.txt in the project root for license information.
|
|
*--------------------------------------------------------------------------------------------*/
|
|
import { InjectionToken } from '@angular/core';
|
|
|
|
import { IDisposable } from 'vs/base/common/lifecycle';
|
|
|
|
/**
|
|
* An instance of a model-backed component. This will be a UI element
|
|
*
|
|
* @export
|
|
*/
|
|
export interface IComponent extends IDisposable {
|
|
descriptor: IComponentDescriptor;
|
|
modelStore: IModelStore;
|
|
layout(): void;
|
|
registerEventHandler(handler: (event: IComponentEventArgs) => void): IDisposable;
|
|
clearContainer?: () => void;
|
|
addToContainer?: (componentDescriptor: IComponentDescriptor, config: any, index?: number) => void;
|
|
removeFromContainer?: (componentDescriptor: IComponentDescriptor) => void;
|
|
setLayout?: (layout: any) => void;
|
|
getHtml: () => any;
|
|
setProperties?: (properties: { [key: string]: any; }) => void;
|
|
enabled: boolean;
|
|
readonly valid?: boolean;
|
|
validate(): Thenable<boolean>;
|
|
setDataProvider(handle: number, componentId: string, context: any): void;
|
|
refreshDataProvider(item: any): void;
|
|
}
|
|
|
|
export const COMPONENT_CONFIG = new InjectionToken<IComponentConfig>('component_config');
|
|
|
|
export interface IComponentConfig {
|
|
descriptor: IComponentDescriptor;
|
|
modelStore: IModelStore;
|
|
}
|
|
|
|
/**
|
|
* Defines a component and can be used to map from the model-backed version of the
|
|
* world to the frontend UI;
|
|
*
|
|
* @export
|
|
*/
|
|
export interface IComponentDescriptor {
|
|
/**
|
|
* The type of this component. Used to map to the correct angular selector
|
|
* when loading the component
|
|
*/
|
|
type: string;
|
|
/**
|
|
* A unique ID for this component
|
|
*/
|
|
id: string;
|
|
}
|
|
|
|
export interface IComponentEventArgs {
|
|
eventType: ComponentEventType;
|
|
args: any;
|
|
componentId?: string;
|
|
}
|
|
|
|
export enum ComponentEventType {
|
|
PropertiesChanged,
|
|
onDidChange,
|
|
onDidClick,
|
|
validityChanged,
|
|
onMessage,
|
|
onSelectedRowChanged,
|
|
onComponentCreated,
|
|
onCellAction,
|
|
onEnterKeyPressed
|
|
}
|
|
|
|
export interface IModelStore {
|
|
/**
|
|
* Creates and saves the reference of a component descriptor.
|
|
* This can be used during creation of a component later
|
|
*/
|
|
createComponentDescriptor(type: string, createComponentDescriptor: string): IComponentDescriptor;
|
|
/**
|
|
* gets the descriptor for a previously created component ID
|
|
*/
|
|
getComponentDescriptor(componentId: string): IComponentDescriptor;
|
|
registerComponent(component: IComponent): void;
|
|
unregisterComponent(component: IComponent): void;
|
|
getComponent(componentId: string): IComponent;
|
|
/**
|
|
* Runs on a component immediately if the component exists, or runs on
|
|
* registration of the component otherwise
|
|
*
|
|
* @param componentId unique identifier of the component
|
|
* @param action some action to perform
|
|
*/
|
|
eventuallyRunOnComponent<T>(componentId: string, action: (component: IComponent) => T): Promise<T>;
|
|
/**
|
|
* Register a callback that will validate components when given a component ID
|
|
*/
|
|
registerValidationCallback(callback: (componentId: string) => Thenable<boolean>): void;
|
|
/**
|
|
* Run all validations for the given component and return the new validation value
|
|
*/
|
|
validate(component: IComponent): Thenable<boolean>;
|
|
}
|
|
|
|
export interface ITitledComponent {
|
|
title?: string;
|
|
}
|