/** * @file This file contains the classes implementing the interfaces defined in the corresponding types file. * Note that the logic for dealing with the multi-table scenario is implemented in the sibling file MultiTable.ts. */ import type { Definition } from 'typescript-json-schema'; import type { smarttable } from 'sap/ui/comp/library'; import type { PopinLayout } from 'sap/m/library'; import type * as Edm from '@sap-ux/vocabularies-types/Edm'; import type { AccessorPath, ConversionExit, ExtensionLogger, SchemaHandlingParams } from '@sap/ux-specification-types'; import * as v2 from '@sap/ux-specification-types/src/v2/genericSchemaHandling/controls/Table'; import type { SapUiGenericAppPageSettings } from '@sap/ux-specification-types/src/common'; import { type LineItemInfo } from '../../generate/utils'; import type { MultiTableInfo } from './MultiTable'; import { type Toolbar } from './Action'; /** * Specific params applicable to the current table passed to the ProcessingRuleAdapter. * * @property settings - the component settings from the manifest * @property tableType - the type of the table * @property tableId - the control id of the smart table * @property multiTableInfo - Information about multi-table scenario if applicable, undefined if quickVariantSelectionX is not defined in the manifest * @property lineItemInfo - the line item this table is built on. For the instance representing the multi-table case as a whole it is the line item which is used as fallback. * @property entityType - the entity type this table is built for. For the instance representing the multi-table case as a whole it is the entityType of the main entitySet. */ export type TableParams = { settings?: SapUiGenericAppPageSettings; tableType: v2.TableTypeV2Enum; tableId: string; multiTableInfo?: MultiTableInfo; lineItemInfo?: LineItemInfo; entityType: Edm.EntityType; }; /** * Returns the default table type used for tables for the given entity type (i.e. the table type which will be used by Fiori Elements if no manifest setting for the table type is available). * * @param entityTypeDefinition - the entity type for which the table is created * @returns the default table type for the given entity type */ export declare function getDefaultTableType(entityTypeDefinition: Edm.EntityType): v2.TableTypeV2Enum; /** * Returns the table type valid for the artifact described by given parameters. * * @param tableParams - the parameters describing the table * @returns the table type for the given table */ export declare function getTableType(tableParams: TableParams): v2.TableTypeV2Enum; /** * Checks whether a given table type is valid. Thereby undefined and empty string are also considered as valid (they represent the default table type). * * @param tableType - the table type to be checked * @param logger - would log an error if tableType is invalid * @returns - information whether the tableType is valid */ export declare function checkTableType(tableType: string | undefined, logger?: ExtensionLogger): boolean; /** * Helper functions for implementing a ProcessingRuleAdapter for a manifest-based property belonging to the tableSettings. * Returns the manifest path for the table settings for the specified table params (which may either be global or for a specific view in a multi-table scenario). * * @param schemaHandlingParams - the schema handling parameters passed to the ProcessingRuleAdapter * @param tableParams - the parameters describing the table * @returns the manifest path to the tableSettings of the specified table */ export declare function getManifestPathForTableSettings(schemaHandlingParams: SchemaHandlingParams, tableParams: TableParams): AccessorPath; /** * Modifies a schema element such that the fields of the given entity type are added as enumeration values. * * @param element - the schema element to be modified * @param entityTypeDefinition - the entity type hosting the fields */ export declare function addEntityTypeFieldsAsEnum(element: Definition, entityTypeDefinition: Edm.EntityType): void; export declare class DataLoadSettings { loadDataOnAppLaunch: v2.LoadDataOnAppLaunchSettingsEnum; } export declare class CreateWithFilters implements v2.CreateWithFilters { strategy: v2.StrategyEnum; } export declare class Fields4CreateWithParametersDialog implements v2.Fields4CreateWithParametersDialog { fields: string[]; } export declare class Table implements v2.Table { entitySet?: string; annotationPath?: string; showItemNavigationOnChart?: boolean; views?: v2.MultiViewsDefinition; quickVariantSelection?: v2.MultiViewsOnTable; showTablePersonalisation?: boolean; exportType?: smarttable.ExportType; useExportToExcel?: boolean; enableExport?: boolean; growingThreshold?: number; popinLayout?: PopinLayout; includeItemInSelection?: boolean; tableType?: v2.TableTypeV2Enum; type?: v2.TableTypeV2Enum; condensedTableLayout?: boolean; enableTableFilterInPageVariant?: boolean; inlineDelete?: boolean; multiSelect?: boolean; selectAll?: boolean; selectionLimit?: number; copy?: boolean; dataLoadSettings?: v2.DataLoadSettings; createWithFilters?: v2.CreateWithFilters; createWithParameterDialog?: v2.Fields4CreateWithParametersDialog; multiEdit?: v2.MultiEdit; toolbar?: Toolbar; } /** * ConversionExit for property createWithParameterDialog of Table control. * Converts between the manifest representation (object with field names as keys) and the config representation (object with array of field names). */ export declare const CREATE_WITH_PARAMETER_DIALOG: ConversionExit; //# sourceMappingURL=Table.d.ts.map