import { ColumnTransform } from 'app/client/components/ColumnTransform'; import { Cursor } from 'app/client/components/Cursor'; import { FormulaTransform } from 'app/client/components/FormulaTransform'; import { GristDoc } from 'app/client/components/GristDoc'; import { addColTypeSuffix } from 'app/client/components/TypeConversion'; import { TypeTransform } from 'app/client/components/TypeTransform'; import * as dom from 'app/client/lib/dom'; import { KoArray } from 'app/client/lib/koArray'; import * as kd from 'app/client/lib/koDom'; import * as kf from 'app/client/lib/koForm'; import * as koUtil from 'app/client/lib/koUtil'; import { reportError } from 'app/client/models/AppModel'; import { DataRowModel } from 'app/client/models/DataRowModel'; import { ColumnRec, DocModel, ViewFieldRec } from 'app/client/models/DocModel'; import { SaveableObjObservable, setSaveValue } from 'app/client/models/modelUtil'; import { FieldSettingsMenu } from 'app/client/ui/FieldMenus'; import { cssLabel, cssRow } from 'app/client/ui/RightPanel'; import { buttonSelect } from 'app/client/ui2018/buttonSelect'; import { IOptionFull, menu, select } from 'app/client/ui2018/menus'; import { DiffBox } from 'app/client/widgets/DiffBox'; import { buildErrorDom } from 'app/client/widgets/ErrorDom'; import { FieldEditor, openFormulaEditor, saveWithoutEditor, setupEditorCleanup } from 'app/client/widgets/FieldEditor'; import { NewAbstractWidget } from 'app/client/widgets/NewAbstractWidget'; import { NewBaseEditor } from "app/client/widgets/NewBaseEditor"; import * as UserType from 'app/client/widgets/UserType'; import * as UserTypeImpl from 'app/client/widgets/UserTypeImpl'; import * as gristTypes from 'app/common/gristTypes'; import { getReferencedTableId, isFullReferencingType } from 'app/common/gristTypes'; import { CellValue } from 'app/plugin/GristData'; import { Computed, Disposable, fromKo, dom as grainjsDom, Holder, IDisposable, makeTestId, styled, toKo } from 'grainjs'; import * as ko from 'knockout'; import * as _ from 'underscore'; const testId = makeTestId('test-fbuilder-'); // Creates a FieldBuilder object for each field in viewFields export function createAllFieldWidgets(gristDoc: GristDoc, viewFields: ko.Computed>, cursor: Cursor) { // TODO: Handle disposal from the map when fields are removed. return viewFields().map(function(field) { return new FieldBuilder(gristDoc, field, cursor); }).setAutoDisposeValues(); } /** * Returns the appropriate object from UserType.typeDefs, defaulting to Text for unknown types. */ function getTypeDefinition(type: string | false) { if (!type) { return UserType.typeDefs.Text; } return UserType.typeDefs[type] || UserType.typeDefs.Text; } /** * Creates an instance of FieldBuilder. Used to create all column configuration DOMs, cell DOMs, * and cell editor DOMs for all Grist Types. * @param {Object} field - The field for which the DOMs are to be created. * @param {Object} cursor - The cursor object, used to get the cursor position while saving values. */ export class FieldBuilder extends Disposable { public columnTransform: ColumnTransform | null; public readonly origColumn: ColumnRec; public readonly options: SaveableObjObservable; public readonly widget: ko.PureComputed; public readonly isCallPending: ko.Observable; public readonly widgetImpl: ko.Computed; public readonly diffImpl: NewAbstractWidget; private readonly _availableTypes: Computed>>; private readonly _readOnlyPureType: ko.PureComputed; private readonly _isRightType: ko.PureComputed<(value: CellValue, options?: any) => boolean>; private readonly _refTableId: ko.Computed; private readonly _isRef: ko.Computed; private readonly _rowMap: Map; private readonly _isTransformingFormula: ko.Computed; private readonly _isTransformingType: ko.Computed; private readonly _fieldEditorHolder: Holder; private readonly _widgetCons: ko.Computed<{create: (...args: any[]) => NewAbstractWidget}>; private readonly _docModel: DocModel; private readonly _readonly: Computed; public constructor(public readonly gristDoc: GristDoc, public readonly field: ViewFieldRec, private _cursor: Cursor) { super(); this._docModel = gristDoc.docModel; this.origColumn = field.column(); this.options = field.widgetOptionsJson; this._readOnlyPureType = ko.pureComputed(() => this.field.column().pureType()); this._readonly = Computed.create(this, (use) => use(gristDoc.isReadonly) || use(field.disableEditData)); // Observable with a list of available types. this._availableTypes = Computed.create(this, (use) => { const isFormula = use(this.origColumn.isFormula); const types: Array> = []; _.each(UserType.typeDefs, (def: any, key: string|number) => { const o: IOptionFull = { value: key as string, label: def.label, icon: def.icon }; if (key === 'Any') { // User is unable to select the Any type in non-formula columns. o.disabled = !isFormula; } types.push(o); }); return types; }); // Observable which evaluates to a *function* that decides if a value is valid. this._isRightType = ko.pureComputed(function() { return gristTypes.isRightType(this._readOnlyPureType()) || _.constant(false); }, this); // Returns a boolean indicating whether the column is type Reference or ReferenceList. this._isRef = this.autoDispose(ko.computed(() => { return isFullReferencingType(this.field.column().type()); })); // Gives the table ID to which the reference points. this._refTableId = this.autoDispose(ko.computed({ read: () => getReferencedTableId(this.field.column().type()), write: val => { const type = this.field.column().type(); if (type.startsWith('Ref:')) { void this._setType(`Ref:${val}`); } else { void this._setType(`RefList:${val}`); } } })); this.widget = ko.pureComputed({ owner: this, read() { return this.options().widget; }, write(widget) { // Reset the entire JSON, so that all options revert to their defaults. const previous = this.options.peek(); this.options.setAndSave({ widget, // Persists color settings across widgets (note: we cannot use `field.fillColor` to get the // current value because it returns a default value for `undefined`. Same for `field.textColor`. fillColor: previous.fillColor, textColor: previous.textColor, }).catch(reportError); } }); // Whether there is a pending call that transforms column. this.isCallPending = ko.observable(false); // Maintains an instance of the transform object if the field is currently being transformed, // and null if not. Gets disposed along with the transform menu dom. this.columnTransform = null; // Returns a boolean indicating whether a formula transform is in progress. this._isTransformingFormula = this.autoDispose(ko.computed(() => { return this.field.column().isTransforming() && this.columnTransform instanceof FormulaTransform; })); // Returns a boolean indicating whether a type transform is in progress. this._isTransformingType = this.autoDispose(ko.computed(() => { return (this.field.column().isTransforming() || this.isCallPending()) && (this.columnTransform instanceof TypeTransform); })); // This holds a single FieldEditor. When a new FieldEditor is created (on edit), it replaces the // previous one if any. this._fieldEditorHolder = Holder.create(this); // Map from rowModel to cell dom for the field to which this fieldBuilder applies. this._rowMap = new Map(); // Returns the constructor for the widget, and only notifies subscribers on changes. this._widgetCons = this.autoDispose(koUtil.withKoUtils(ko.computed(function() { return UserTypeImpl.getWidgetConstructor(this.options().widget, this._readOnlyPureType()); }, this)).onlyNotifyUnequal()); // Computed builder for the widget. this.widgetImpl = this.autoDispose(koUtil.computedBuilder(() => { const cons = this._widgetCons(); // Must subscribe to `colId` so that field.colId is rechecked on transform. return cons.create.bind(cons, this.field, this.field.colId()); }, this).extend({ deferred: true })); this.diffImpl = this.autoDispose(DiffBox.create(this.field)); } public buildSelectWidgetDom() { return grainjsDom.maybe((use) => !use(this._isTransformingType) && use(this._readOnlyPureType), type => { const typeWidgets = getTypeDefinition(type).widgets; const widgetOptions = Object.keys(typeWidgets).map(label => ({ label, value: label, icon: typeWidgets[label].icon })); return widgetOptions.length <= 1 ? null : [ cssLabel('CELL FORMAT'), cssRow( widgetOptions.length <= 2 ? buttonSelect(fromKo(this.widget), widgetOptions) : select(fromKo(this.widget), widgetOptions), testId('widget-select') ) ]; }); } /** * Build the type change dom. */ public buildSelectTypeDom() { const selectType = Computed.create(null, (use) => use(fromKo(this._readOnlyPureType))); selectType.onWrite(newType => newType === this._readOnlyPureType.peek() || this._setType(newType)); const onDispose = () => (this.isDisposed() || selectType.set(this.field.column().pureType())); return [ cssRow( grainjsDom.autoDispose(selectType), select(selectType, this._availableTypes, { disabled: (use) => use(this._isTransformingFormula) || use(this.origColumn.disableModifyBase) || use(this.isCallPending), menuCssClass: cssTypeSelectMenu.className, }), testId('type-select'), grainjsDom.cls('tour-type-selector'), ), grainjsDom.maybe((use) => use(this._isRef) && !use(this._isTransformingType), () => this._buildRefTableSelect()), grainjsDom.maybe(this._isTransformingType, () => { // Editor dom must be built before preparing transform. return dom('div.type_transform_prompt', kf.prompt( dom('div', grainjsDom.maybe(this._isRef, () => this._buildRefTableSelect()), grainjsDom.maybe((use) => use(this.field.column().isTransforming), () => this.columnTransform!.buildDom()) ) ), grainjsDom.onDispose(onDispose) ); }) ]; } // Helper function to set the column type to newType. public _setType(newType: string): Promise|undefined { if (this.origColumn.isFormula()) { // Do not type transform a new/empty column or a formula column. Just make a best guess for // the full type, and set it. const column = this.field.column(); column.type.setAndSave(addColTypeSuffix(newType, column, this._docModel)).catch(reportError); } else if (!this.columnTransform) { this.columnTransform = TypeTransform.create(null, this.gristDoc, this); return this.columnTransform.prepare(newType); } else { if (this.columnTransform instanceof TypeTransform) { return this.columnTransform.setType(newType); } } } // Builds the reference type table selector. Built when the column is type reference. public _buildRefTableSelect() { const allTables = Computed.create(null, (use) => use(this._docModel.allTableIds.getObservable()).map(tableId => ({ value: tableId, label: tableId, icon: 'FieldTable' as const })) ); return [ cssLabel('DATA FROM TABLE'), cssRow( dom.autoDispose(allTables), select(fromKo(this._refTableId), allTables, { // Disallow changing the destination table when the column should not be modified // (specifically when it's a group-by column of a summary table). disabled: this.origColumn.disableModifyBase, }), testId('ref-table-select') ) ]; } /** * Build the formula transform dom */ public buildTransformDom() { const transformButton = ko.computed({ read: () => this.field.column().isTransforming(), write: val => { if (val) { this.columnTransform = FormulaTransform.create(null, this.gristDoc, this); return this.columnTransform.prepare(); } else { return this.columnTransform && this.columnTransform.cancel(); } } }); return dom('div', dom.autoDispose(transformButton), dom.onDispose(() => { // When losing focus, if there's an active column transform, finalize it. if (this.columnTransform) { this.columnTransform.finalize().catch(reportError); } }), kf.row( 15, kf.label('Apply Formula to Data'), 3, kf.buttonGroup( kf.checkButton(transformButton, dom('span.glyphicon.glyphicon-flash'), dom.testId("FieldBuilder_editTransform"), kd.toggleClass('disabled', () => this._isTransformingType() || this.origColumn.isFormula() || this.origColumn.disableModifyBase()) ) ) ), kd.maybe(this._isTransformingFormula, () => { return this.columnTransform!.buildDom(); }) ); } /** * Builds the FieldBuilder Options Config DOM. Calls the buildConfigDom function of its widgetImpl. */ public buildConfigDom() { // NOTE: adding a grainjsDom .maybe here causes the disposable order of the widgetImpl and // the dom created by the widgetImpl to get out of sync. return dom('div', kd.maybe(() => !this._isTransformingType() && this.widgetImpl(), (widget: NewAbstractWidget) => dom('div', widget.buildConfigDom(), widget.buildColorConfigDom(), // If there is more than one field for this column (i.e. present in multiple views). kd.maybe(() => this.origColumn.viewFields().all().length > 1, () => dom('div.fieldbuilder_settings', kf.row( kd.toggleClass('fieldbuilder_settings_header', true), kf.label( dom('div.fieldbuilder_settings_button', dom.testId('FieldBuilder_settings'), kd.text(() => this.field.useColOptions() ? 'Common' : 'Separate'), ' ▾', menu(ctl => FieldSettingsMenu(this.field.useColOptions(), { useSeparate: () => this.fieldSettingsUseSeparate(), saveAsCommon: () => this.fieldSettingsSaveAsCommon(), revertToCommon: () => this.fieldSettingsRevertToCommon() })) ), 'Field in ', kd.text(() => this.origColumn.viewFields().all().length), ' views' ) ) ) ) ) ) ); } public fieldSettingsUseSeparate() { return this.gristDoc.docData.bundleActions( `Use separate field settings for ${this.origColumn.colId()}`, () => { return Promise.all([ setSaveValue(this.field.widgetOptions, this.field.column().widgetOptions()), setSaveValue(this.field.visibleCol, this.field.column().visibleCol()), this.field.saveDisplayFormula(this.field.column()._displayColModel().formula() || '') ]); } ); } public fieldSettingsSaveAsCommon() { return this.gristDoc.docData.bundleActions( `Save field settings for ${this.origColumn.colId()} as common`, () => { return Promise.all([ setSaveValue(this.field.column().widgetOptions, this.field.widgetOptions()), setSaveValue(this.field.column().visibleCol, this.field.visibleCol()), this.field.column().saveDisplayFormula(this.field._displayColModel().formula() || ''), setSaveValue(this.field.widgetOptions, ''), setSaveValue(this.field.visibleCol, 0), this.field.saveDisplayFormula('') ]); } ); } public fieldSettingsRevertToCommon() { return this.gristDoc.docData.bundleActions( `Revert field settings for ${this.origColumn.colId()} to common`, () => { return Promise.all([ setSaveValue(this.field.widgetOptions, ''), setSaveValue(this.field.visibleCol, 0), this.field.saveDisplayFormula('') ]); } ); } /** * Builds the cell and editor DOM for the chosen UserType. Calls the buildDom and * buildEditorDom functions of its widgetImpl. */ public buildDomWithCursor(row: DataRowModel, isActive: boolean, isSelected: boolean) { const widgetObs = koUtil.withKoUtils(ko.computed(function() { // TODO: Accessing row values like this doesn't always work (row and field might not be updated // simultaneously). if (this.isDisposed()) { return null; } // Work around JS errors during field removal. const value = row.cells[this.field.colId()]; const cell = value && value(); if (value && this._isRightType()(cell, this.options) || row._isAddRow.peek()) { return this.widgetImpl(); } else if (gristTypes.isVersions(cell)) { return this.diffImpl; } else { return null; } }, this).extend({ deferred: true })).onlyNotifyUnequal(); return (elem: Element) => { this._rowMap.set(row, elem); dom(elem, dom.autoDispose(widgetObs), kd.cssClass(this.field.formulaCssClass), kd.toggleClass("readonly", toKo(ko, this._readonly)), kd.maybe(isSelected, () => dom('div.selected_cursor', kd.toggleClass('active_cursor', isActive) )), kd.scope(widgetObs, (widget: NewAbstractWidget) => { if (this.isDisposed()) { return null; } // Work around JS errors during field removal. const cellDom = widget ? widget.buildDom(row) : buildErrorDom(row, this.field); return dom(cellDom, kd.toggleClass('has_cursor', isActive), kd.style('--grist-cell-color', () => this.field.textColor() || ''), kd.style('--grist-cell-background-color', this.field.fillColor)); }) ); }; } public buildEditorDom(editRow: DataRowModel, mainRowModel: DataRowModel, options: { init?: string, state?: any }) { // If the user attempts to edit a value during transform, finalize (i.e. cancel or execute) // the transform. if (this.columnTransform) { this.columnTransform.finalize().catch(reportError); return; } // If this is censored value, don't open up the editor, unless it is a formula field. const cell = editRow.cells[this.field.colId()]; const value = cell && cell(); if (gristTypes.isCensored(value) && !this.origColumn.isFormula.peek()) { this._fieldEditorHolder.clear(); return; } const editorCtor: typeof NewBaseEditor = UserTypeImpl.getEditorConstructor(this.options().widget, this._readOnlyPureType()); // constructor may be null for a read-only non-formula field, though not today. if (!editorCtor) { // Actually, we only expect buildEditorDom() to be called when isEditorActive() is false (i.e. // _fieldEditorHolder is already clear), but clear here explicitly for clarity. this._fieldEditorHolder.clear(); return; } // if editor doesn't support readonly mode, don't show it if (this._readonly.get() && editorCtor.supportsReadonly && !editorCtor.supportsReadonly()) { this._fieldEditorHolder.clear(); return; } if (!this._readonly.get() && saveWithoutEditor(editorCtor, editRow, this.field, options.init)) { this._fieldEditorHolder.clear(); return; } const cellElem = this._rowMap.get(mainRowModel)!; // The editor may dispose itself; the Holder will know to clear itself in this case. const fieldEditor = FieldEditor.create(this._fieldEditorHolder, { gristDoc: this.gristDoc, field: this.field, cursor: this._cursor, editRow, cellElem, editorCtor, state: options.state, startVal: this._readonly.get() ? undefined : options.init, // don't start with initial value readonly: this._readonly.get() // readonly for editor will not be observable }); // Put the FieldEditor into a holder in GristDoc too. This way any existing FieldEditor (perhaps // for another field, or for another BaseView) will get disposed at this time. The reason to // still maintain a Holder in this FieldBuilder is mainly to match older behavior; changing that // will entail a number of other tweaks related to the order of creating and disposal. this.gristDoc.fieldEditorHolder.autoDispose(fieldEditor); // expose the active editor in a grist doc as an observable fieldEditor.onDispose(() => this.gristDoc.activeEditor.set(null)); this.gristDoc.activeEditor.set(fieldEditor); } public isEditorActive() { return !this._fieldEditorHolder.isEmpty(); } /** * Open the formula editor in the side pane. It will be positioned over refElem. */ public openSideFormulaEditor( editRow: DataRowModel, refElem: Element, editValue?: string, onSave?: (formula: string) => Promise, onCancel?: () => void) { const editorHolder = openFormulaEditor({ gristDoc: this.gristDoc, field: this.field, setupCleanup: setupEditorCleanup, editRow, refElem, editValue, onSave, onCancel }); // Add editor to document holder - this will prevent multiple formula editor instances. this.gristDoc.fieldEditorHolder.autoDispose(editorHolder); } } const cssTypeSelectMenu = styled('div', ` max-height: 500px; `);